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 EnptuiSelectionComponentElement

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

public class EnptuiSelectionComponentElement
extends ComponentElementList

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.ComponentElementList
elements
 
Fields inherited from class com.ibm.hats.transform.elements.ComponentElement
consumedRegion
 
Constructor Summary
EnptuiSelectionComponentElement(ECLInputFieldAttribute fld)
          Constructs a new EnptuiSelectionComponentElement object.
 
Method Summary
 int getColumnsPerRow()
          Returns how many columns per row were in the ENPTUI field
 int getEndPos()
          Returns the end position.
 ComponentElementList getListItems()
          Returns the list of items.
 int getScreenColumns()
          Returns how many columns on host screen
 int getSelectionFieldType()
          Returns the selection field type.
 int getStartPos()
          Returns the start position.
 boolean hasIndicator()
          Returns whether an indicator field is set
 boolean isAutoEnter()
          Returns whether auto-enter is used for this field.
 void setAutoEnter(boolean enabled)
          Sets whether auto-enter is used for this field.
 void setColumnsPerRow(int columns)
          Sets how many columns per row
 void setEndPos(int pos)
          Sets the end position.
 void setIndicator(boolean indicator)
          Sets whether an indicator field is set
 void setScreenColumns(int columns)
          Sets how many columns on host screen
 void setSelectionFieldType(int sel)
          Sets the selection field type.
 void setStartPos(int pos)
          Sets the start position.
 
Methods inherited from class com.ibm.hats.transform.elements.ComponentElementList
addElement, addElement, addElements, cloneList, computeConsumedRegion, doTextReplacement, doTextReplacement, getConsumedRegion, getElement, getElementCount, getElements, getIterator, getPreviewText, getPreviewText, getPreviewText, removeElement, removeElement, setScreenId
 
Methods inherited from class com.ibm.hats.transform.elements.ComponentElement
clone, getScreenId, isConsumer, isMatch, isTruncateToPreserveLength, setConsumedRegion, 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

EnptuiSelectionComponentElement

public EnptuiSelectionComponentElement(ECLInputFieldAttribute fld)
Constructs a new EnptuiSelectionComponentElement object.

Method Detail

hasIndicator

public boolean hasIndicator()
Returns whether an indicator field is set

Returns:
boolean

setIndicator

public void setIndicator(boolean indicator)
Sets whether an indicator field is set

Parameters:
indicator - true or false

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

getColumnsPerRow

public int getColumnsPerRow()
Returns how many columns per row were in the ENPTUI field

Returns:
int

setColumnsPerRow

public void setColumnsPerRow(int columns)
Sets how many columns per row

Parameters:
columns - int

getStartPos

public int getStartPos()
Returns the start position.

Returns:
The start position.

setStartPos

public void setStartPos(int pos)
Sets the start position.

Parameters:
pos - The start postion.

getEndPos

public int getEndPos()
Returns the end position.

Returns:
The end position.

setEndPos

public void setEndPos(int pos)
Sets the end position.

Parameters:
pos - The end position.

getSelectionFieldType

public int getSelectionFieldType()
Returns the selection field type.

Returns:
The selection field type.

setSelectionFieldType

public void setSelectionFieldType(int sel)
Sets the selection field type.

Parameters:
sel - The selection field type.

isAutoEnter

public boolean isAutoEnter()
Returns whether auto-enter is used for this field.

Returns:
A boolean value indicating whether or not auto-enter is used for this field.

setAutoEnter

public void setAutoEnter(boolean enabled)
Sets whether auto-enter is used for this field.

Parameters:
enabled - true or false

getListItems

public ComponentElementList getListItems()
Returns the list of items.

Returns:
ComponentElementList

HATS 7.5.1 (201005110649)