|
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.hsr.screen.HsrAttributes
public class HsrAttributes
HsrAttributes is the base class for storing attributes of a particular HsrScreenField object.
The HsrAttributes object stores information about the field, such as if the field is protected, hidden,
or high-intensity. A consumer can also store and retrieve custom attributes in the HsrAttributes object
using the setAttribute() and getAttribute() methods.
Please Note: the HsrAttributes class is only a basic class that provides a framework for defining
the attributes necessary to the HSR component. This class should be extended by the consumer, in order to provide
useful functionality for each of the getter/setter functions. For example, if a consumer's HsrScreen interface
implements the IBM Host Access Client Library, the HsrAttributes function "getForegroundColor(position)" could query
the Color Plane of a particular position on the consumer's ECLPS object to retrieve its foreground color.
| Field Summary | |
|---|---|
static String |
ATTR_3270_FIELD
Attribute for determining whether a field is from a 3270 screen |
static String |
ATTR_5250_FIELD
Attribute for determining whether a field is from a 5250 screen |
static String |
ATTR_ALPHA_NUMERIC
Attribute for determining whether a field is alpha-numeric |
static String |
ATTR_BLINK
Attribute for determining whether a field is blinking |
static String |
ATTR_DBCS_ONLY
Attribute for determining whether or not the field is DBCS-only |
static String |
ATTR_DBCS_OPEN
Attribute for determining whether or not the field is DBCS-open |
static String |
ATTR_DISPLAY
Attribute for determining whether or not the field is displayable. |
static String |
ATTR_HIDDEN
Attribute for determining whether a field is a hidden field |
static String |
ATTR_HIGH_INTENSITY
Attribute for determining whether or not the field is high-intensity. |
static String |
ATTR_MODIFIED
Attribute for determining whether the field has been modified. |
static String |
ATTR_NUMERIC
Attribute for determining whether the field is numeric-only. |
static String |
ATTR_PEN_DETECTABLE
Attribute for determining whether the field is pen-detectable. |
static String |
ATTR_PROTECTED
Attribute for determining whether the field is protected. |
static String |
ATTR_REVERSE_VIDEO
Attribute for determining whether a field is reverse-video |
static String |
ATTR_RIGHT_TO_LEFT
Attribute for determining whether a field is right-to-left (Bidi-only) |
static String |
ATTR_UNDERLINE
Attribute for determining whether a field is underline |
static String |
ATTR_UNICODE
Attribute for determining whether a field is Unicode-formatted. |
protected Hashtable |
attributeList
Hashtable to hold all of the attributes related to a field. |
| Constructor Summary | |
|---|---|
HsrAttributes()
Construct an instance of an HsrAttributes object. |
|
| Method Summary | |
|---|---|
Object |
getAttribute(Object attributeName)
Get an attribute in the HsrAttribute object. |
Hashtable |
getAttributes()
Get all attributes in the HsrAttribute object. |
int |
getBackgroundColor()
Gets the background color of a field. |
int |
getBackgroundColor(int fieldPosition)
Gets the background color of a field, at a specific position in the field. |
int |
getForegroundColor()
Gets the foreground color of a field, where the color value ranges from 0-15, as in the IBM Host Access Client Library. |
int |
getForegroundColor(int fieldPosition)
Gets the foreground color of a field, at a specific position in the field, where the color value ranges from 0-15, as in the IBM Host Access Client Library. |
boolean |
is3270Field()
Returns whether the field is from a 3270 screen. |
boolean |
is5250Field()
Returns whether the field is from a 5250 screen. |
boolean |
isAlphaNumeric()
Returns whether the field is alpha-numeric. |
boolean |
isBlink()
Returns whether the field is blinking. |
boolean |
isDbcsOnly()
Returns whether the field is DBCS-only. |
boolean |
isDbcsOpen()
Returns whether the field is DBCS-open. |
boolean |
isDisplay()
Returns whether the field is displayable. |
boolean |
isEmpty()
Returns whether the attribute list is empty or not. |
boolean |
isHidden()
Returns whether the field is hidden. |
boolean |
isHighIntensity()
Returns whether the field is highIntensity. |
boolean |
isModified()
Returns whether the field was modified. |
boolean |
isNumeric()
Returns whether the field is numeric-only. |
boolean |
isPenDetectable()
Returns whether the field is penDetectable. |
boolean |
isProtected()
Returns whether the field is protected. |
boolean |
isReverseVideo()
Returns whether the field is reverse video. |
boolean |
isRightToLeftField()
Returns whether the field is right-to-left (Bidi-only). |
boolean |
isUnderline()
Returns whether the field is underlined. |
boolean |
isUnicode()
Returns whether the field is unicode. |
void |
set3270Field(boolean is3270Field)
Set whether the field is a 3270-specific field. |
void |
set5250Field(boolean is5250Field)
Set whether the field is a 5250-specific field. |
void |
setAlphaNumeric(boolean isAlphaNumeric)
Set whether the field is alpha-numeric. |
void |
setAttribute(Object attrName,
Object attrValue)
Set an attribute in the HsrAttributes object. |
void |
setBlink(boolean isBlink)
Set whether the field is blink. |
void |
setDbcsOnly(boolean isDBCSonly)
Set whether the field is DBCS-only. |
void |
setDbcsOpen(boolean isDBCSopen)
Set whether the field is DBCS-open. |
void |
setDisplay(boolean display)
Set whether the field is displayed. |
void |
setHidden(boolean isHidden)
Set whether the field is hidden. |
void |
setHighIntensity(boolean highIntensity)
Set whether the field is high-intensity. |
void |
setModified(boolean modified)
Set whether the field is modified. |
void |
setNumeric(boolean numeric)
Set whether the field is numeric. |
void |
setPenDetectable(boolean penDetectable)
Set whether the field is pen-detectable. |
void |
setProtected(boolean protectedField)
Set whether the field is protected. |
void |
setReverseVideo(boolean isReverseVideo)
Set whether the field is reverse-video. |
void |
setRightToLeft(boolean isRightToLeft)
Set whether the field is Bidi right-to-left. |
void |
setUnderline(boolean isUnderline)
Set whether the field is underline. |
void |
setUnicode(boolean unicode)
Set whether the field is unicode. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final String ATTR_3270_FIELD
public static final String ATTR_5250_FIELD
public static final String ATTR_ALPHA_NUMERIC
public static final String ATTR_BLINK
public static final String ATTR_DBCS_ONLY
public static final String ATTR_DBCS_OPEN
public static final String ATTR_DISPLAY
public static final String ATTR_HIDDEN
public static final String ATTR_HIGH_INTENSITY
public static final String ATTR_MODIFIED
public static final String ATTR_NUMERIC
public static final String ATTR_PEN_DETECTABLE
public static final String ATTR_PROTECTED
public static final String ATTR_REVERSE_VIDEO
public static final String ATTR_RIGHT_TO_LEFT
public static final String ATTR_UNDERLINE
public static final String ATTR_UNICODE
protected Hashtable attributeList
| Constructor Detail |
|---|
public HsrAttributes()
| Method Detail |
|---|
public Object getAttribute(Object attributeName)
attributeName - The attribute name.
public Hashtable getAttributes()
public int getBackgroundColor()
public int getBackgroundColor(int fieldPosition)
fieldPosition - Position of the character in the field for which to retrieve background color information.
public int getForegroundColor()
Gets the foreground color of a field, where the color value ranges from 0-15, as in the IBM Host Access Client Library.
NOTE: this function should be overridden by the consuming product's extension of HsrAttributes, as it currently only returns an int value "2" for default green.
public int getForegroundColor(int fieldPosition)
Gets the foreground color of a field, at a specific position in the field, where the color value ranges from 0-15, as in the IBM Host Access Client Library.
NOTE: this function should be overridden by the consuming product's extension of HsrAttributes, as it currently only returns an int value "2" for default green.
fieldPosition - Postition of the field from which to retrieve color information.
public boolean is3270Field()
public boolean is5250Field()
public boolean isAlphaNumeric()
public boolean isBlink()
public boolean isDbcsOnly()
public boolean isDbcsOpen()
public boolean isDisplay()
public boolean isEmpty()
public boolean isHidden()
public boolean isHighIntensity()
public boolean isModified()
public boolean isNumeric()
public boolean isPenDetectable()
public boolean isProtected()
public boolean isReverseVideo()
public boolean isRightToLeftField()
public boolean isUnderline()
public boolean isUnicode()
public void set3270Field(boolean is3270Field)
is3270Field - A boolean true or false.public void set5250Field(boolean is5250Field)
is5250Field - A boolean true or false.public void setAlphaNumeric(boolean isAlphaNumeric)
isAlphaNumeric - A boolean true or false.
public void setAttribute(Object attrName,
Object attrValue)
HsrAttributes object.
attrName - Name of attribute.attrValue - Value of attribue.public void setBlink(boolean isBlink)
isBlink - A boolean true or false.public void setDbcsOnly(boolean isDBCSonly)
isDBCSonly - A boolean true or false.public void setDbcsOpen(boolean isDBCSopen)
isDBCSopen - A boolean true or false.public void setDisplay(boolean display)
display - A boolean true or false.public void setHidden(boolean isHidden)
isHidden - A boolean true or false.public void setHighIntensity(boolean highIntensity)
highIntensity - A boolean true or false.public void setModified(boolean modified)
modified - A boolean true or false.public void setNumeric(boolean numeric)
numeric - A boolean true or false.public void setPenDetectable(boolean penDetectable)
penDetectable - A boolean true or false.public void setProtected(boolean protectedField)
protectedField - A boolean true or false.public void setReverseVideo(boolean isReverseVideo)
isReverseVideo - A boolean true or false.public void setRightToLeft(boolean isRightToLeft)
isRightToLeft - A boolean true or false.public void setUnderline(boolean isUnderline)
isUnderline - A boolean true or false.public void setUnicode(boolean unicode)
unicode - A boolean true or false.
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||