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 SelectionComponentElement

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.SelectionComponentElement
All Implemented Interfaces:
Cloneable

public class SelectionComponentElement
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
SelectionComponentElement(InputComponentElement field)
          Constructs an empty SelectionComponentElement targetting the specified input field.
SelectionComponentElement(InputComponentElement field, ComponentElementList listItems)
          Constructs a SelectionComponentElement targetting the specified input field.
 
Method Summary
 InputComponentElement getField()
          Returns the input field targetted by this selection list.
 ComponentElementList getListItems()
          Returns the list of items.
 String getPreviewText()
          Returns a concatenation of the preview text of each component element in the list.
 void setField(InputComponentElement field)
          Sets the target input field of the selection list.
 void setListItems(ComponentElementList listItems)
          Sets the list of items.
 void setListItems(ComponentElementList listItems, InputComponentElement ice)
          Sets the list of items.
 void setScreenId(int id)
           
 void sort(String sortOrder, String sortBy)
           
 
Methods inherited from class com.ibm.hats.transform.elements.ComponentElementList
addElement, addElement, addElements, cloneList, computeConsumedRegion, doTextReplacement, doTextReplacement, getConsumedRegion, getElement, getElementCount, getElements, getIterator, getPreviewText, getPreviewText, removeElement, removeElement
 
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

SelectionComponentElement

public SelectionComponentElement(InputComponentElement field)
Constructs an empty SelectionComponentElement targetting the specified input field.

Parameters:
field - input field which will receive the selection

SelectionComponentElement

public SelectionComponentElement(InputComponentElement field,
                                 ComponentElementList listItems)
Constructs a SelectionComponentElement targetting the specified input field. The initial list of list items in specified by the listItems parameter.

Parameters:
field - input field which will receive the selection
listItems - list of list items
See Also:
ListItemComponentElement
Method Detail

getField

public InputComponentElement getField()
Returns the input field targetted by this selection list.

Returns:
InputComponentElement

getListItems

public ComponentElementList getListItems()
Returns the list of items.

Returns:
ComponentElementList

setField

public void setField(InputComponentElement field)
Sets the target input field of the selection list.

Parameters:
field - The field to set

setListItems

public void setListItems(ComponentElementList listItems)
Sets the list of items.

Parameters:
listItems - The listItems to set
See Also:
ListItemComponentElement

setListItems

public void setListItems(ComponentElementList listItems,
                         InputComponentElement ice)
Sets the list of items.

Parameters:
listItems - The listItems to set
ice - target input of list item

getPreviewText

public String getPreviewText()
Description copied from class: ComponentElementList
Returns a concatenation of the preview text of each component element in the list. Each element is separated with a \n (new line) character.

Overrides:
getPreviewText in class ComponentElementList
Returns:
A concatenation of the preview text of each component element in the list. Each element is separated with a \n (new line) character.
See Also:
ComponentElement.getPreviewText()

setScreenId

public void setScreenId(int id)
Overrides:
setScreenId in class ComponentElementList

sort

public void sort(String sortOrder,
                 String sortBy)

HATS 7.5.1 (201005110649)