|
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.ListItemComponentElement
public class ListItemComponentElement
This class represents an item in a list. A list item is made up of the following parts: item and description. In the following example:
1. User tasks"1" is the item and "User tasks" is the description.
| Nested Class Summary | |
|---|---|
static class |
ListItemComponentElement.ListItemComparator
ListItemComponentElement comparator implementation. |
| Field Summary | |
|---|---|
static String |
CLASS_NAME
|
| Fields inherited from class com.ibm.hats.transform.elements.ComponentElement |
|---|
consumedRegion |
| Constructor Summary | |
|---|---|
ListItemComponentElement(String item,
String description,
String fullCaption)
Constructs a new ListItemComponentElement object. |
|
| Method Summary | |
|---|---|
void |
doTextReplacement(TextReplacementPair pair,
ContextAttributes contextAttributes)
Performs text replacement on this list item (text replacement is performed on the item, description, and full caption). |
String |
getDescription()
Returns the description. |
String |
getFullCaption()
Returns the full caption of the list item. |
String |
getItem()
Returns the item. |
String |
getMnemonic()
|
List |
getOnSelectActions()
Returns the list of ScriptAction objects representing the list of actions to perform when this item is selected. |
String |
getPreviewText()
Returns the preview text for this component. |
InputComponentElement |
getTarget()
|
boolean |
isBidiSubFileRtlAction()
|
boolean |
isDefault()
Returns a true if this item is the default item (in the set of list items that this item belongs to). |
boolean |
isDisableReordering()
|
void |
setBidiSubFileRtlAction(boolean isBidiSubFileRtlAction)
Sets whether the item can be reordered (Bidi-specific). |
void |
setDescription(String description)
Sets the description. |
void |
setDisableReordering(boolean isDisableReordering)
Sets whether the item can be reordered (Bidi-specific). |
void |
setFullCaption(String newFullCaption)
Sets the full caption of the list item. |
void |
setIsDefault(boolean isDefault)
Method to set whether this item is the default item in this list in which it belongs. |
void |
setItem(String item)
Sets the item. |
void |
setMnemonic(String mnemonic)
|
void |
setOnSelectActions(List onSelectActions)
Sets the list of ScriptAction objects representing the list of actions to perform when this item is selected. |
void |
setScreenId(int id)
|
void |
setTarget(InputComponentElement ice)
|
| Methods inherited from class com.ibm.hats.transform.elements.ComponentElement |
|---|
clone, getConsumedRegion, 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 ListItemComponentElement(String item,
String description,
String fullCaption)
ListItemComponentElement object.
item - value of the list itemdescription - description of the list itemfullCaption - full caption of the list item (item + description + delimiters + any extra space)| Method Detail |
|---|
public String getDescription()
public String getItem()
public void setDescription(String description)
description - new descriptionpublic String getFullCaption()
public void setFullCaption(String newFullCaption)
newFullCaption - public void setItem(String item)
item - The item to setpublic String getPreviewText()
getPreviewText in class ComponentElementpublic List getOnSelectActions()
ScriptAction objects representing the list of actions to perform when this item is selected.
ScriptActionpublic void setOnSelectActions(List onSelectActions)
ScriptAction objects representing the list of actions to perform when this item is selected.
onSelectActions - The onSelectActions to set.ScriptActionpublic boolean isDefault()
true if this item is the default item (in the set of list items that this item belongs to).
public void setIsDefault(boolean isDefault)
isDefault - The isDefault to set
public void doTextReplacement(TextReplacementPair pair,
ContextAttributes contextAttributes)
doTextReplacement in class ComponentElementpair - TextReplacementPair to base replacement oncontextAttributes - context attributespublic void setDisableReordering(boolean isDisableReordering)
isDisableReordering - public boolean isDisableReordering()
public void setBidiSubFileRtlAction(boolean isBidiSubFileRtlAction)
isBidiSubFileRtlAction - public boolean isBidiSubFileRtlAction()
public void setScreenId(int id)
setScreenId in class ComponentElementpublic void setTarget(InputComponentElement ice)
public InputComponentElement getTarget()
public void setMnemonic(String mnemonic)
public String getMnemonic()
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||