|
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
public class FieldComponentElement
The FieldComponentElement class represents a host screen field.
| Field Summary | |
|---|---|
static String |
CLASS_NAME
|
protected boolean |
split
Flag indicates whether the element has been split to multiple elements |
| Fields inherited from class com.ibm.hats.transform.elements.ComponentElement |
|---|
consumedRegion |
| Constructor Summary | |
|---|---|
FieldComponentElement()
Constructs an empty FieldComponentElement object. |
|
FieldComponentElement(FieldComponentElement fce,
int startIndex,
int length)
Constructs a new FieldComponentElement object from a specified FCE. |
|
FieldComponentElement(FieldComponentElement fce,
String text,
int startIndex,
int length)
Constructs a new FieldComponentElement object from a specified FCE with specified length. |
|
FieldComponentElement(HsrScreenField field)
Constructs a FieldComponentElement object based off the specified HostScreenField object. |
|
FieldComponentElement(HsrScreenField field,
int startPos,
int length)
Constructs a new FieldComponentElement object based off the specified HostScreenField object. |
|
FieldComponentElement(HsrScreenField field,
int startPos,
int length,
boolean flag)
Deprecated. |
|
FieldComponentElement(HsrScreenField field,
int startPos,
int length,
boolean isHidden,
boolean isProtected)
Constructs a new FieldComponentElement object based off the specified HostScreenField object. |
|
FieldComponentElement(HsrScreenField field,
int startPos,
int length,
boolean isHidden,
boolean isProtected,
boolean flag)
Deprecated. |
|
FieldComponentElement(String text,
int startPos,
int length,
boolean isHidden,
boolean isProtected)
Constructs a new FieldComponentElement object. |
|
| Method Summary | |
|---|---|
void |
doTextReplacement(TextReplacementPair pair,
ContextAttributes contextAttributes)
Performs text replacement on this field. |
String |
getActionKey()
Returns the action, aid key associated with the field. |
int |
getBackgroundColor()
Returns the background color code of the field. |
int |
getBackgroundColor(int pos)
Returns the background color code of the field. |
HsrAttributes |
getExtendedAttributes()
Returns the extended field attributes of the field. |
int |
getForegroundColor()
Returns the foreground color code of the field. |
int |
getForegroundColor(int pos)
Returns the foreground color code of the field. |
boolean |
getIsRTL()
Returns true if the field is right-to-left (BiDi specific). |
int |
getLength()
Returns the length of the field. |
String |
getPreviewText()
Returns some form of descriptive text about the component element. |
int |
getStartPos()
Returns the linear, 1-based start position of the field. |
String |
getText()
Returns the value, or text, of the field. |
boolean |
is3270()
Returns true if the field came from a 3270 host screen. |
boolean |
is5250()
Returns true if the field came from a 5250 host screen. |
boolean |
isAllBlank()
|
boolean |
isAlphaNumeric()
Returns true if the field allows alphanumeric (all symbols) values. |
boolean |
isBlink()
Returns true if the field is marked as "blink". |
boolean |
isHidden()
Returns true if the field is hidden (ie the text is hidden). |
boolean |
isHighIntensity()
Returns true if the field is marked as "high intensity". |
boolean |
isHolderOnly()
|
boolean |
isMatch(ComponentElement ce)
Returns a boolean specifying whether the specified component element "matches" this component element. |
boolean |
isNumericOnly()
Returns true if only numerals can be entered into the field. |
boolean |
isProtected()
Returns true if the field is protected. |
boolean |
isReverseVideo()
Returns true if the field is marked as "reverse video". |
boolean |
isSplit()
|
boolean |
isUnderline()
Returns true if the field is marked as "underline". |
boolean |
isUnicodeField()
Returns true if the field is 5250 unicode field. |
void |
set3270(boolean b)
Specifies whether the field came from a 3270 host screen. |
void |
set5250(boolean b)
Specifies whether the field came from a 5250 host screen. |
void |
setActionKey(String string)
Sets the action key associated with the field. |
void |
setExtendedAttributes(HsrAttributes attribs)
Sets the extended field attributes (color, etc) of the field. |
void |
setHidden(boolean isHidden)
Sets whether the field is hidden or visible. |
void |
setHolderOnly(boolean b)
|
void |
setLength(int length)
Sets the length. |
void |
setProtected(boolean isProtected)
Sets whether the field is protected or not protected (ie static text or an input field). |
void |
setSplit(boolean b)
|
void |
setStartPos(int startPos)
Sets the linear start position of the field. |
void |
setText(String text)
Sets the value, or text, of the field. |
String |
toString()
|
| Methods inherited from class com.ibm.hats.transform.elements.ComponentElement |
|---|
clone, getConsumedRegion, getScreenId, isConsumer, isTruncateToPreserveLength, setConsumedRegion, setScreenId, 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
protected boolean split
| Constructor Detail |
|---|
public FieldComponentElement()
FieldComponentElement object.
public FieldComponentElement(HsrScreenField field)
FieldComponentElement object based off the specified HostScreenField object.
field -
public FieldComponentElement(HsrScreenField field,
int startPos,
int length)
FieldComponentElement object based off the specified HostScreenField object.
field - startPos - new linear (1-based) start position of the fieldlength - new length of the field
public FieldComponentElement(HsrScreenField field,
int startPos,
int length,
boolean flag)
FieldComponentElement object based off the specified HostScreenField object.
field - startPos - new linear (1-based) start position of the fieldlength - new length of the fieldflag - boolean flag
public FieldComponentElement(HsrScreenField field,
int startPos,
int length,
boolean isHidden,
boolean isProtected,
boolean flag)
FieldComponentElement object based off the specified HostScreenField object.
field - startPos - new linear start position (1-based) of the fieldlength - new length of the fieldisHidden - boolean specifying whether the field is hidden (if not protected and hidden, the field is considered a "password" field)isProtected - boolean specifying whether the field is protected (ie static text or an input field)flag - boolean flag
public FieldComponentElement(HsrScreenField field,
int startPos,
int length,
boolean isHidden,
boolean isProtected)
FieldComponentElement object based off the specified HostScreenField object.
field - startPos - new linear start position (1-based) of the fieldlength - new length of the fieldisHidden - boolean specifying whether the field is hidden (if not protected and hidden, the field is considered a "password" field)isProtected - boolean specifying whether the field is protected (ie static text or an input field)
public FieldComponentElement(String text,
int startPos,
int length,
boolean isHidden,
boolean isProtected)
FieldComponentElement object.
text - value of the fieldstartPos - linear start position (1-based) of the fieldlength - length of the fieldisHidden - boolean specifying whether the field is hidden (if not protected and hidden, the field is considered a "password" field)isProtected - boolean specifying whether the field is protected (ie static text or an input field)
public FieldComponentElement(FieldComponentElement fce,
int startIndex,
int length)
FieldComponentElement object from a specified FCE.
This method allows for a FieldComponentElement to be "split" into multiple parts
fce - The field component element.startIndex - The start index.length - The length.
public FieldComponentElement(FieldComponentElement fce,
String text,
int startIndex,
int length)
FieldComponentElement object from a specified FCE with specified length.
This method allows for a FieldComponentElement to be "split" into multiple parts
fce - The field component element.text - value of the fieldstartIndex - The start index.length - The length.| Method Detail |
|---|
public String getText()
public void setText(String text)
text - public boolean isProtected()
true if the field is protected. If false the field is considered an input field.
true if the field is protected, false otherwise.public void setProtected(boolean isProtected)
isProtected - public boolean isHidden()
true if the field is hidden (ie the text is hidden). If a field is both not protected (input) and hidden, it is considered a "password" field.
true if the field is hidden (ie the text is hidden), false otherwise.public void setHidden(boolean isHidden)
isHidden - public int getStartPos()
public int getLength()
public void setLength(int length)
length - The length.public void setStartPos(int startPos)
startPos - public String toString()
toString in class Objectpublic int getForegroundColor()
public int getForegroundColor(int pos)
pos - The position in the field to retrieve foreground color from.
public int getBackgroundColor()
public int getBackgroundColor(int pos)
pos - The position in the field to retrieve background color from.
public String getPreviewText()
ComponentElement
getPreviewText in class ComponentElementpublic boolean isUnderline()
true if the field is marked as "underline".
true if the field is marked as "underline", false otherwise.public boolean isAlphaNumeric()
true if the field allows alphanumeric (all symbols) values.
public boolean isBlink()
true if the field is marked as "blink".
public boolean isHighIntensity()
true if the field is marked as "high intensity".
public boolean isNumericOnly()
true if only numerals can be entered into the field.
public boolean isReverseVideo()
true if the field is marked as "reverse video".
public String getActionKey()
HTMLElementFactory.createSubmitButton(FieldComponentElement)public void setActionKey(String string)
string - HTMLElementFactory.createSubmitButton(FieldComponentElement)
public void doTextReplacement(TextReplacementPair pair,
ContextAttributes contextAttributes)
doTextReplacement in class ComponentElementpair - TextReplacementPair to base replacement oncontextAttributes - context attributespublic boolean getIsRTL()
true if the field is right-to-left (BiDi specific).
true if the field is right-to-left (BiDi specific), false otherwise.public 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 boolean isUnicodeField()
true if the field is 5250 unicode field.
true if the field is 5250 unicode field, false otherwise.public HsrAttributes getExtendedAttributes()
public void setExtendedAttributes(HsrAttributes attribs)
attribs - The extended field attributes.public boolean is3270()
true if the field came from a 3270 host screen.
true if the field came from a 3270 host screen, false otherwise.public boolean is5250()
true if the field came from a 5250 host screen.
true if the field came from a 5250 host screen, false otherwise.public void set3270(boolean b)
b - The 3270 host screen field flag.public void set5250(boolean b)
b - The 5250 host screen field flag.public void setHolderOnly(boolean b)
public boolean isHolderOnly()
public boolean isAllBlank()
public boolean isSplit()
public void setSplit(boolean b)
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||