|
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.PatternMatchComponentElement
public class PatternMatchComponentElement
This class represents a pattern match (used by Global Rules).
| Field Summary | |
|---|---|
static String |
CLASS_NAME
|
| Fields inherited from class com.ibm.hats.transform.elements.ComponentElement |
|---|
consumedRegion |
| Constructor Summary | |
|---|---|
PatternMatchComponentElement(ComponentElement match,
ScreenRegion dynamicRegion)
The parameter constructor. |
|
| Method Summary | |
|---|---|
void |
doTextReplacement(TextReplacementPair pair,
ContextAttributes contextAttributes)
Method to perform text replacement on this component element. |
ScreenRegion |
getDynamicRegion()
Retrieve the dynamic screen region. |
ComponentElement |
getMatchedElement()
Retrieve the matched element. |
String |
getPreviewText()
Returns some form of descriptive text about the component element. |
boolean |
isMatch(ComponentElement ce)
Returns a boolean specifying whether the specified component element "matches" this component element. |
void |
setDynamicRegion(ScreenRegion region)
Set the dynamic screen region. |
void |
setMatchedElement(ComponentElement element)
Set the matched component element. |
void |
setScreenId(int id)
|
| Methods inherited from class com.ibm.hats.transform.elements.ComponentElement |
|---|
clone, getConsumedRegion, getScreenId, isConsumer, 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 PatternMatchComponentElement(ComponentElement match,
ScreenRegion dynamicRegion)
match - The component element.dynamicRegion - The dynamic screen region.| Method Detail |
|---|
public ScreenRegion getDynamicRegion()
public void setDynamicRegion(ScreenRegion region)
region - The dynamic screen region.public ComponentElement getMatchedElement()
public void setMatchedElement(ComponentElement element)
element - The matched component element.
public void doTextReplacement(TextReplacementPair pair,
ContextAttributes contextAttributes)
ComponentElement
doTextReplacement in class ComponentElementpair - TextReplacementPair to base replacement oncontextAttributes - context attributespublic String getPreviewText()
ComponentElement
getPreviewText in class ComponentElementpublic boolean isMatch(ComponentElement ce)
ComponentElement
Currently only implemented by the PatternComponentElement, other classes return false.
isMatch in class ComponentElementce - The ComponentElement object for the comparison.
public void setScreenId(int id)
setScreenId in class ComponentElement
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||