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 InputComponentElement

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

public class InputComponentElement
extends FieldComponentElement

This class represents an input field.


Field Summary
static String CLASS_NAME
           
 
Fields inherited from class com.ibm.hats.transform.elements.FieldComponentElement
split
 
Fields inherited from class com.ibm.hats.transform.elements.ComponentElement
consumedRegion
 
Constructor Summary
InputComponentElement(String text, int startPos, int length)
          Constructs a new InputComponentElement object.
InputComponentElement(String text, int startPos, int length, boolean hidden)
          Constructs a new InputComponentElement object.
 
Method Summary
 void doTextReplacement(TextReplacementPair pair, ContextAttributes contextAttributes)
          Peforms text replacement on the caption of this element (not on the value of the input field itself).
 String getCaption()
          Returns the caption.
 ComponentElementList getHints()
          Returns the set of "hints" associated with this input field.
 String getPreviewText()
          Returns some form of descriptive text about the component element.
 String getPreviewText(boolean isrtlcomponent)
           
 boolean isProtected()
          This method always returns true.
 void setCaption(String caption)
          Sets the caption.
 void setHints(ComponentElementList list)
          Sets the set of "hints" associated with this input field.
 void setScreenId(int id)
           
 
Methods inherited from class com.ibm.hats.transform.elements.FieldComponentElement
getActionKey, getBackgroundColor, getBackgroundColor, getExtendedAttributes, getForegroundColor, getForegroundColor, getIsRTL, getLength, getStartPos, getText, is3270, is5250, isAllBlank, isAlphaNumeric, isBlink, isHidden, isHighIntensity, isHolderOnly, isMatch, isNumericOnly, isReverseVideo, isSplit, isUnderline, isUnicodeField, set3270, set5250, setActionKey, setExtendedAttributes, setHidden, setHolderOnly, setLength, setProtected, setSplit, setStartPos, setText, toString
 
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, wait, wait, wait
 

Field Detail

CLASS_NAME

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

InputComponentElement

public InputComponentElement(String text,
                             int startPos,
                             int length,
                             boolean hidden)
Constructs a new InputComponentElement object.

Parameters:
text - value of the input field
startPos - linear, 1-based start position of the field
length - length of the field
hidden - if true, the input field should be considered a "password" field

InputComponentElement

public InputComponentElement(String text,
                             int startPos,
                             int length)
Constructs a new InputComponentElement object.

Parameters:
text - value of the input field
startPos - linear, 1-based start position of the field
length - length of the field
Method Detail

getCaption

public String getCaption()
Returns the caption.

Returns:
String

setCaption

public void setCaption(String caption)
Sets the caption.

Parameters:
caption - The caption to set

doTextReplacement

public void doTextReplacement(TextReplacementPair pair,
                              ContextAttributes contextAttributes)
Peforms text replacement on the caption of this element (not on the value of the input field itself).

Overrides:
doTextReplacement in class FieldComponentElement
Parameters:
pair - TextReplacementPair to base replacement on
contextAttributes - context attributes

getPreviewText

public String getPreviewText()
Description copied from class: ComponentElement
Returns some form of descriptive text about the component element.

Overrides:
getPreviewText in class FieldComponentElement

getPreviewText

public String getPreviewText(boolean isrtlcomponent)

getHints

public ComponentElementList getHints()
Returns the set of "hints" associated with this input field.

Returns:
The set of "hints" associated with this input field.
See Also:
InputWithHintsComponent

setHints

public void setHints(ComponentElementList list)
Sets the set of "hints" associated with this input field.

Parameters:
list -
See Also:
InputWithHintsComponent

isProtected

public boolean isProtected()
This method always returns true.

Overrides:
isProtected in class FieldComponentElement
Returns:
Returns true if the field is protected, false otherwise.
See Also:
FieldComponentElement.isProtected()

setScreenId

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

HATS 7.5.1 (201005110649)