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 TextComponentElement

java.lang.Object
  extended by com.ibm.hats.transform.elements.ComponentElement
      extended by com.ibm.hats.transform.elements.TextComponentElement
All Implemented Interfaces:
Cloneable
Direct Known Subclasses:
HtmlDDSComponentElement

public class TextComponentElement
extends ComponentElement

This class represents text.


Field Summary
static String CLASS_NAME
           
 
Fields inherited from class com.ibm.hats.transform.elements.ComponentElement
consumedRegion
 
Constructor Summary
TextComponentElement(String text)
          Constructs a new TextComponentElement object which contains the specified text.
 
Method Summary
 void doTextReplacement(TextReplacementPair pair, ContextAttributes contextAttributes)
          Performs text replacement on the text in this element.
 String getPreviewText()
          Returns the preview text.
 String getText()
          Returns the text contained in this element.
 void setText(String newText)
          Sets the text of this element.
 
Methods inherited from class com.ibm.hats.transform.elements.ComponentElement
clone, getConsumedRegion, getScreenId, isConsumer, isMatch, isTruncateToPreserveLength, setConsumedRegion, setScreenId, 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

TextComponentElement

public TextComponentElement(String text)
Constructs a new TextComponentElement object which contains the specified text.

Parameters:
text - The specified text.
Method Detail

getText

public String getText()
Returns the text contained in this element.

Returns:
The text contained in this element.

setText

public void setText(String newText)
Sets the text of this element.

Parameters:
newText - The new text to set.

getPreviewText

public String getPreviewText()
Returns the preview text.

Specified by:
getPreviewText in class ComponentElement
Returns:
The preview text.

doTextReplacement

public void doTextReplacement(TextReplacementPair pair,
                              ContextAttributes contextAttributes)
Performs text replacement on the text in this element.

Specified by:
doTextReplacement in class ComponentElement
Parameters:
pair - The text replacement pair.
contextAttributes - The context attributes.

HATS 7.5.1 (201005110649)