|
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
public abstract class ComponentElement
The ComponentElement class represents a logical element recognized by a component class.
| Field Summary | |
|---|---|
static String |
CLASS_NAME
|
protected ScreenRegion |
consumedRegion
Region consumed by this component element. |
| Constructor Summary | |
|---|---|
ComponentElement()
|
|
| Method Summary | |
|---|---|
Object |
clone()
|
abstract void |
doTextReplacement(TextReplacementPair pair,
ContextAttributes contextAttributes)
Method to perform text replacement on this component element. |
ScreenRegion |
getConsumedRegion()
Returns the screen region (block or linear) consumed by this component element. |
abstract String |
getPreviewText()
Returns some form of descriptive text about the component element. |
int |
getScreenId()
|
boolean |
isConsumer()
Returns a boolean specifying whether the specified component element consumes the presentation space after rendering what is in it. |
boolean |
isMatch(ComponentElement ce)
Returns a boolean specifying whether the specified component element "matches" this component element. |
protected static boolean |
isTruncateToPreserveLength(ContextAttributes contextAttributes)
|
void |
setConsumedRegion(ScreenRegion region)
Set the screen region (block or linear) consumed by this component element. |
void |
setScreenId(int id)
|
int |
type()
Returns the type for a specific instance of a component element as an integer value. |
static int |
type(String classname)
Returns the type of a component element class as an integer value. |
| 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 ScreenRegion consumedRegion
| Constructor Detail |
|---|
public ComponentElement()
| Method Detail |
|---|
public static final int type(String classname)
classname - - fully qualified name of the component element
public final int type()
public ScreenRegion getConsumedRegion()
public void setConsumedRegion(ScreenRegion region)
public abstract String getPreviewText()
public abstract void doTextReplacement(TextReplacementPair pair,
ContextAttributes contextAttributes)
pair - TextReplacementPair to base replacement oncontextAttributes - context attributespublic boolean isMatch(ComponentElement ce)
Currently only implemented by the PatternComponentElement, other classes return false.
ce - The ComponentElement object for the comparison.
public boolean isConsumer()
public Object clone()
clone in class Objectpublic void setScreenId(int id)
public int getScreenId()
protected static boolean isTruncateToPreserveLength(ContextAttributes contextAttributes)
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||