|
HATS 7.5.1 Web API ReferencePublicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product. |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.ibm.hats.transform.elements.ComponentElement
com.ibm.hats.transform.elements.ComponentElementList
com.ibm.hats.transform.elements.SelectionComponentElement
public class SelectionComponentElement
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).
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 |
|---|
public static final String CLASS_NAME
| Constructor Detail |
|---|
public SelectionComponentElement(InputComponentElement field)
SelectionComponentElement targetting the specified input field.
field - input field which will receive the selection
public SelectionComponentElement(InputComponentElement field,
ComponentElementList listItems)
SelectionComponentElement targetting the specified input field. The initial list of list items in specified by the listItems parameter.
field - input field which will receive the selectionlistItems - list of list itemsListItemComponentElement| Method Detail |
|---|
public InputComponentElement getField()
public ComponentElementList getListItems()
public void setField(InputComponentElement field)
field - The field to setpublic void setListItems(ComponentElementList listItems)
listItems - The listItems to setListItemComponentElement
public void setListItems(ComponentElementList listItems,
InputComponentElement ice)
listItems - The listItems to setice - target input of list itempublic String getPreviewText()
ComponentElementList
getPreviewText in class ComponentElementListComponentElement.getPreviewText()public void setScreenId(int id)
setScreenId in class ComponentElementList
public void sort(String sortOrder,
String sortBy)
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||