|
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.FieldComponentElement
com.ibm.hats.transform.elements.InputComponentElement
public class InputComponentElement
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 |
|---|
public static final String CLASS_NAME
| Constructor Detail |
|---|
public InputComponentElement(String text,
int startPos,
int length,
boolean hidden)
InputComponentElement object.
text - value of the input fieldstartPos - linear, 1-based start position of the fieldlength - length of the fieldhidden - if true, the input field should be considered a "password" field
public InputComponentElement(String text,
int startPos,
int length)
InputComponentElement object.
text - value of the input fieldstartPos - linear, 1-based start position of the fieldlength - length of the field| Method Detail |
|---|
public String getCaption()
public void setCaption(String caption)
caption - The caption to set
public void doTextReplacement(TextReplacementPair pair,
ContextAttributes contextAttributes)
doTextReplacement in class FieldComponentElementpair - TextReplacementPair to base replacement oncontextAttributes - context attributespublic String getPreviewText()
ComponentElement
getPreviewText in class FieldComponentElementpublic String getPreviewText(boolean isrtlcomponent)
public ComponentElementList getHints()
InputWithHintsComponentpublic void setHints(ComponentElementList list)
list - InputWithHintsComponentpublic boolean isProtected()
true.
isProtected in class FieldComponentElementtrue if the field is protected, false otherwise.FieldComponentElement.isProtected()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 | ||||||||