|
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
public class ComponentElementList
This class represents a list of ComponentElement objects.
| Field Summary | |
|---|---|
static String |
CLASS_NAME
|
protected List |
elements
|
| Fields inherited from class com.ibm.hats.transform.elements.ComponentElement |
|---|
consumedRegion |
| Constructor Summary | |
|---|---|
ComponentElementList()
Constructs a new ComponentElementList object. |
|
ComponentElementList(boolean cacheConsumedRegion)
Constructs a new ComponentElementList object. |
|
ComponentElementList(ComponentElement[] elements)
Constructs a new ComponentElementList object that is initially filled (in order) with the specified component elements. |
|
| Method Summary | |
|---|---|
void |
addElement(ComponentElement element)
Method to add a component element to the list. |
void |
addElement(int index,
ComponentElement element)
Method to add a component element to the list at the specified position. |
void |
addElements(Collection c)
Method to add a component element to the list. |
Object |
cloneList()
Returns a clone of the CEL. |
static ScreenRegion |
computeConsumedRegion(List elems)
Returns the calculated consumed region of a list of component element objects. |
void |
doTextReplacement(TextReplacementPair pair,
ContextAttributes contextAttributes)
Performs text replacement on the list. |
void |
doTextReplacement(TextReplacementPair pair,
ContextAttributes contextAttributes,
com.ibm.hats.transform.ITextReplacementFilter[] filters)
Performs text replacement on the list. |
ScreenRegion |
getConsumedRegion()
Returns the screen region consumed by the set of elements in the list. |
ComponentElement |
getElement(int index)
Returns the element at the specified (0-based) index. |
int |
getElementCount()
Returns the number of elements in the list. |
List |
getElements()
Returns the internal list of elements (the list is of type java.util.ArrayList). |
ListIterator |
getIterator()
Returns a ListIterator which allows for iterating through the list of elements. |
String |
getPreviewText()
Returns a concatenation of the preview text of each component element in the list. |
String |
getPreviewText(String separator)
Returns a concatenation of the preview text of each component element in the list. |
String |
getPreviewText(String separator,
boolean RTL_flag,
boolean RTLScreen)
BiDi-specific method for retrieving the preview text of the list. |
void |
removeElement(ComponentElement element)
Method to remvoe a component element from the list. |
void |
removeElement(int index)
Method to remove the component element at the specified index. |
void |
setScreenId(int id)
|
| 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
protected List elements
| Constructor Detail |
|---|
public ComponentElementList()
ComponentElementList object.
public ComponentElementList(boolean cacheConsumedRegion)
ComponentElementList object.
The single parameter specifies whether the consumed region is cached or whether it is
calculated on every call to getConsumedRegion().
Note: Prior to HATS 7, a call to getConsumedRegion() always calculated the consumed region, even if the list
had not changed. To get this behavior in HATS 7 (and above), specify false as the parameter to this constructor.
cacheConsumedRegion - public ComponentElementList(ComponentElement[] elements)
ComponentElementList object that is initially filled (in order) with the specified component elements.
elements - | Method Detail |
|---|
public void addElement(ComponentElement element)
element - component element object to add
public void addElement(int index,
ComponentElement element)
element - component element object to addpublic void addElements(Collection c)
c - The collection of component element objects to add.public void removeElement(ComponentElement element)
element - component element to removepublic void removeElement(int index)
index - 0-based index of the element to removepublic ListIterator getIterator()
ListIterator which allows for iterating through the list of elements.
public int getElementCount()
public ComponentElement getElement(int index)
index - index of the component element to retrieve
public ScreenRegion getConsumedRegion()
getConsumedRegion in class ComponentElementpublic static ScreenRegion computeConsumedRegion(List elems)
elems - The list of ComponentElement objects for computing the consumed region.
BlockScreenRegion.compound(ScreenRegion[])public String getPreviewText()
getPreviewText in class ComponentElementComponentElement.getPreviewText()public String getPreviewText(String separator)
separator - A String which separates the preview text of each component element in the list.
ComponentElement.getPreviewText()
public String getPreviewText(String separator,
boolean RTL_flag,
boolean RTLScreen)
public void doTextReplacement(TextReplacementPair pair,
ContextAttributes contextAttributes)
doTextReplacement in class ComponentElementpair - from/replace with paircontextAttributes - context attributes
public void doTextReplacement(TextReplacementPair pair,
ContextAttributes contextAttributes,
com.ibm.hats.transform.ITextReplacementFilter[] filters)
pair - from/replace with paircontextAttributes - context attributesfilters - text replacement arraypublic List getElements()
java.util.ArrayList).
public void setScreenId(int id)
setScreenId in class ComponentElementpublic Object cloneList()
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||