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 ListItemComponentElement

java.lang.Object
  extended by com.ibm.hats.transform.elements.ComponentElement
      extended by com.ibm.hats.transform.elements.ListItemComponentElement
All Implemented Interfaces:
Cloneable
Direct Known Subclasses:
PlaceholderListItemComponentElement, SubfileActionComponentElementV6

public class ListItemComponentElement
extends ComponentElement

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

CLASS_NAME

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

ListItemComponentElement

public ListItemComponentElement(String item,
                                String description,
                                String fullCaption)
Constructs a new ListItemComponentElement object.

Parameters:
item - value of the list item
description - description of the list item
fullCaption - full caption of the list item (item + description + delimiters + any extra space)
Method Detail

getDescription

public String getDescription()
Returns the description.

Returns:
String description of the list item

getItem

public String getItem()
Returns the item.

Returns:
String item

setDescription

public void setDescription(String description)
Sets the description.

Parameters:
description - new description

getFullCaption

public String getFullCaption()
Returns the full caption of the list item.

Returns:
full caption String

setFullCaption

public void setFullCaption(String newFullCaption)
Sets the full caption of the list item.

Parameters:
newFullCaption -

setItem

public void setItem(String item)
Sets the item.

Parameters:
item - The item to set

getPreviewText

public String getPreviewText()
Returns the preview text for this component. In this implementation, the full caption is returned.

Specified by:
getPreviewText in class ComponentElement

getOnSelectActions

public List getOnSelectActions()
Returns the list of ScriptAction objects representing the list of actions to perform when this item is selected.

Returns:
List
See Also:
ScriptAction

setOnSelectActions

public void setOnSelectActions(List onSelectActions)
Sets the list of ScriptAction objects representing the list of actions to perform when this item is selected.

Parameters:
onSelectActions - The onSelectActions to set.
See Also:
ScriptAction

isDefault

public boolean isDefault()
Returns a true if this item is the default item (in the set of list items that this item belongs to).

Returns:
boolean

setIsDefault

public void setIsDefault(boolean isDefault)
Method to set whether this item is the default item in this list in which it belongs.

Parameters:
isDefault - The isDefault to set

doTextReplacement

public void doTextReplacement(TextReplacementPair pair,
                              ContextAttributes contextAttributes)
Performs text replacement on this list item (text replacement is performed on the item, description, and full caption).

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

setDisableReordering

public void setDisableReordering(boolean isDisableReordering)
Sets whether the item can be reordered (Bidi-specific).

Parameters:
isDisableReordering -

isDisableReordering

public boolean isDisableReordering()

setBidiSubFileRtlAction

public void setBidiSubFileRtlAction(boolean isBidiSubFileRtlAction)
Sets whether the item can be reordered (Bidi-specific).

Parameters:
isBidiSubFileRtlAction -

isBidiSubFileRtlAction

public boolean isBidiSubFileRtlAction()

setScreenId

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

setTarget

public void setTarget(InputComponentElement ice)

getTarget

public InputComponentElement getTarget()

setMnemonic

public void setMnemonic(String mnemonic)

getMnemonic

public String getMnemonic()

HATS 7.5.1 (201005110649)