HATS 7.5.1 Web API Reference

Publicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product.

com.ibm.hats.transform.elements
Class EnptuiScrollbarComponentElement

java.lang.Object
  extended by com.ibm.hats.transform.elements.ComponentElement
      extended by com.ibm.hats.transform.elements.EnptuiScrollbarComponentElement
All Implemented Interfaces:
Cloneable

public class EnptuiScrollbarComponentElement
extends ComponentElement

This class represents a set of list items and a single target field (which presumably receives its input by selecting one of the list items).

See Also:
SelectionListComponent

Field Summary
static String CLASS_NAME
           
 
Fields inherited from class com.ibm.hats.transform.elements.ComponentElement
consumedRegion
 
Constructor Summary
EnptuiScrollbarComponentElement(ECLInputFieldAttribute fld, BlockScreenRegion region)
          Constructs a new EnptuiScrollbarComponentElement object.
 
Method Summary
 void doTextReplacement(TextReplacementPair pair, ContextAttributes contextAttributes)
          Method to perform text replacement on this component element.
 int getEndPos()
          Returns 1-based end position
 String getPreviewText()
          Returns some form of descriptive text about the component element.
 int getScreenColumns()
          Returns how many columns on host screen
 int getScrollPos()
          Returns the scroll position.
 int getSize()
          Returns
 int getStartPos()
          Returns 1-based start position.
 int getTotal()
          Returns the total.
 boolean isVertical()
          Returns
 void setEndPos(int pos)
          Sets 1-based end position.
 void setScreenColumns(int columns)
          Sets how many columns on host screen
 void setScrollPos(int spos)
          Sets the scroll position.
 void setSize(int sz)
          Sets the size.
 void setStartPos(int pos)
          Sets 1-based start position.
 void setTotal(int tot)
          Sets the total.
 void setVertical(boolean vert)
          Sets whether or not is vertical.
 
Methods inherited from class com.ibm.hats.transform.elements.ComponentElement
clone, getConsumedRegion, getScreenId, isConsumer, isMatch, isTruncateToPreserveLength, setConsumedRegion, setScreenId, type, type
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CLASS_NAME

public static final String CLASS_NAME
See Also:
Constant Field Values
Constructor Detail

EnptuiScrollbarComponentElement

public EnptuiScrollbarComponentElement(ECLInputFieldAttribute fld,
                                       BlockScreenRegion region)
Constructs a new EnptuiScrollbarComponentElement object.

Method Detail

getScreenColumns

public int getScreenColumns()
Returns how many columns on host screen

Returns:
int

setScreenColumns

public void setScreenColumns(int columns)
Sets how many columns on host screen

Parameters:
columns - int

getStartPos

public int getStartPos()
Returns 1-based start position.

Returns:
int

setStartPos

public void setStartPos(int pos)
Sets 1-based start position.

Parameters:
pos - The start position.

getEndPos

public int getEndPos()
Returns 1-based end position

Returns:
int

setEndPos

public void setEndPos(int pos)
Sets 1-based end position.

Parameters:
pos - The end position.

getSize

public int getSize()
Returns

Returns:
int

setSize

public void setSize(int sz)
Sets the size.

Parameters:
sz - The size.

getTotal

public int getTotal()
Returns the total.

Returns:
The total.

setTotal

public void setTotal(int tot)
Sets the total.

Parameters:
tot - The total.

getScrollPos

public int getScrollPos()
Returns the scroll position.

Returns:
The scroll position.

setScrollPos

public void setScrollPos(int spos)
Sets the scroll position.

Parameters:
spos - The scroll position.

isVertical

public boolean isVertical()
Returns

Returns:
int

setVertical

public void setVertical(boolean vert)
Sets whether or not is vertical.

Parameters:
vert - The boolean indication of vertical.

doTextReplacement

public void doTextReplacement(TextReplacementPair pair,
                              ContextAttributes contextAttributes)
Method to perform text replacement on this component element.

Specified by:
doTextReplacement in class ComponentElement
Parameters:
pair - TextReplacementPair to base replacement on
contextAttributes - context attributes

getPreviewText

public String getPreviewText()
Returns some form of descriptive text about the component element.

Specified by:
getPreviewText in class ComponentElement

HATS 7.5.1 (201005110649)