com.ibm.connector2.hod.screenable
Class J2HODFieldAttrInfo

java.lang.Object
  |
  +--com.ibm.connector2.hod.screenable.J2HODFieldAttrInfo
All Implemented Interfaces:
java.lang.Cloneable, com.ibm.connector2.screen.IFieldAttrInfo, java.io.Serializable

public class J2HODFieldAttrInfo
extends java.lang.Object
implements com.ibm.connector2.screen.IFieldAttrInfo

This class represents attribute information for a field. The following attributes information are available:

Name Type Default Value Description
modified boolean false specifies whether this field has been modified or not
protd boolean false specifies whether this field is a protected field or not
numeric boolean false specifies whether this field is a numeric only field or not
penDetectable boolean false specifies whether this field is a pen detectable field or not
display boolean true specifies whether this field is displayed or not
highIntensity boolean false specifies whether this field is a high intensity field or not
underline boolean false Not Supported
overline boolean false Not Supported
leftline boolean false Not Supported
rightline boolean false Not Supported
trigger boolean false Not Supported
mandatoryFill boolean false Not Supported
mandatoryEntry boolean false Not Supported
highLight int 0x00 (default highlight) extended highlight attribute
Value Type Of Highlight Constant Variable
0x00 Default IExtendedAttributes.defaultHlt
0xF0 Normal IExtendedAttributes.normalHlt
0xF1 Blink IExtendedAttributes.blinkHlt
0xF2 Reverse Video IExtendedAttributes.reverseHlt
0xF4 Underline/Underscore IExtendedAttributes.underscoreHlt
0xF8 Intense IExtendedAttributes.intenseHlt
trans int 0x00 (default transparency) Not Supported, It contains extended transparency attribute property.
Value Type Of Highlight Constant Variable
0x00 Default IExtendedAttributes.defaultTran
0xF0 OR transparancy IExtendedAttributes.orTran
0xF1 XOR transparency IExtendedAttributes.xorTran
0xFF Opaque transparency IExtendedAttributes.opaqueTran
foreColor int 0xF4 (IExtendedAttributes.green) foreground text color
backColor int 0x00 (blank) background text color

Color values are different from what HOD uses from HACL and what Screenable interface uses. The following color table shows the mapping of HACL color to Screenable color values.

HACL Screenable HACL Screenable
0x0(blank) 0x00(defaultColor) 0x1(blue) 0xF1(blue)
0x2(green) 0xF4(green) 0x3(cyan) 0xF5(cyan)
0x4(red) 0xF2(red) 0x5(magenta) 0xFB(purple)
0x6(yellow) 0xF6(yellow) 0x7(white-normal intensity) 0xFF(white)
0x8(gray) 0xFE(gray) 0x9(light blue) 0xF5(cyan)
0xA(light green) 0xFC(pale green) 0xB(light cyan) 0xFD(pale cyan)
0xC(light red) 0xF3(pink) 0xD(light magenta) 0xF3(pink)
0xE(yellow) 0xF6(yellow) 0xF(white-high intensity) 0xFF(white)

See Also:
Serialized Form

Constructor Summary
J2HODFieldAttrInfo()
          Default Constructor setting default values.
J2HODFieldAttrInfo(boolean isModified, boolean isProtected, boolean isNumeric, boolean isPenDetectable, boolean isDisplay, boolean isHighIntens, boolean isUnderline, boolean isOverline, boolean isLeftline, boolean isRightline, boolean isTrigger, boolean isMandatoryFill, boolean isMandatoryEntry, int highLight, int trans, int foreColor, int backColor, int charSet)
          Constructs an instance with specified attribute values even with unsupported attributes.
J2HODFieldAttrInfo(boolean isModified, boolean isProtected, boolean isNumeric, boolean isPenDetectable, boolean isDisplay, boolean isHighIntens, int highLight, int foreColor, int backColor)
          Constructs an instance with specified attribute values (only those that are supported)
 
Method Summary
 java.lang.Object clone()
          Clones this instance of class and returns it
 boolean equals(java.lang.Object obj)
          Checks whether this instance is equal to the object that is passed as a parameter.
 int getBackGroundColor()
          Returns extended background attribute property
 int getCharacterSet()
          This attribute is not supported.
 int getForeGroundColor()
          Returns extended foreground attribute property
 int getHighLight()
          Returns extended highlight attribute property.
 int getTransparency()
          This attribute is not supported.
 boolean isDisplay()
          Returns whether this field is displayed or not
 boolean isHighIntensity()
          Returns whether this field has high intensity attribute or not
 boolean isLeftline()
          This attribute is not supported.
 boolean isMandatoryEntry()
          This attribute is not supported.
 boolean isMandatoryFill()
          This attribute is not supported.
 boolean isModified()
          Returns whether this field is modified or not
 boolean isNumeric()
          Returns whether this field is numeric only field or not
 boolean isOverline()
          This attribute is not supported.
 boolean isPenDetectable()
          Returns whether this field is pen detectable field or not
 boolean isProtected()
          Returns whether this field is a protected field or not
 boolean isRightline()
          This attribute is not supported.
 boolean isTrigger()
          This attribute is not supported.
 boolean isUnderline()
          This attribute is not supported.
 void setBackGroundColor(int val)
          Sets backColor attribute value to a specified value
 void setCharSet(int val)
          This attribute is not supported.
 void setDisplay(boolean flag)
          Sets display flag to a specified value
 void setForeGroundColor(int val)
          Sets foreColor attribute value to a specified value
 void setHighIntensity(boolean flag)
          Sets highIntensity flag to a specified value
 void setHighLight(int val)
          Sets highLight attribute value to a specified value
 void setLeftline(boolean flag)
          This attribute is not supported.
 void setMandatoryEntry(boolean flag)
          This attribute is not supported.
 void setMandatoryFill(boolean flag)
          This attribute is not supported.
 void setModified(boolean flag)
          Method to change the Modified Data tag for a field, ie to indicate it has been modified.
 void setNumeric(boolean flag)
          Sets numeric flag to a specified value
 void setOverline(boolean flag)
          This attribute is not supported.
 void setPenDetectable(boolean flag)
          Sets penDetectable flag to a specified value
 void setProtected(boolean flag)
          Sets protd flag to a specified value
 void setRightline(boolean flag)
          This attribute is not supported.
 void setTransparency(int val)
          This attribute is not supported.
 void setTrigger(boolean flag)
          This attribute is not supported.
 void setUnderline(boolean flag)
          This attribute is not supported.
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

J2HODFieldAttrInfo

public J2HODFieldAttrInfo()
Default Constructor setting default values.

J2HODFieldAttrInfo

public J2HODFieldAttrInfo(boolean isModified,
                          boolean isProtected,
                          boolean isNumeric,
                          boolean isPenDetectable,
                          boolean isDisplay,
                          boolean isHighIntens,
                          int highLight,
                          int foreColor,
                          int backColor)
Constructs an instance with specified attribute values (only those that are supported)
Parameters:
isModified - boolean - modified or not
isProtected - boolean - protected or not
isNumeric - boolean - numeric or not
isPenDetectable - boolean - pen detectable or not
isDisplay - boolean - display or not
isHighIntens - boolean - high intensity or not
highLight - int - highlighting type
foreColor - int - foreground color
backColor - int - background coor

J2HODFieldAttrInfo

public J2HODFieldAttrInfo(boolean isModified,
                          boolean isProtected,
                          boolean isNumeric,
                          boolean isPenDetectable,
                          boolean isDisplay,
                          boolean isHighIntens,
                          boolean isUnderline,
                          boolean isOverline,
                          boolean isLeftline,
                          boolean isRightline,
                          boolean isTrigger,
                          boolean isMandatoryFill,
                          boolean isMandatoryEntry,
                          int highLight,
                          int trans,
                          int foreColor,
                          int backColor,
                          int charSet)
Constructs an instance with specified attribute values even with unsupported attributes.
Parameters:
isModified - boolean - modified or not
isProtected - boolean - protected or not
isNumeric - boolean - numeric or not
isPenDetectable - boolean - pen detectable or not
isDisplay - boolean - display or not
isHighIntens - boolean - high intensity or not
isUnderline - boolean - underlined or not (not supported)
isOverline - boolean - overlined or not (not supported)
isLeftline - boolean - leftline or not (not supported)
isRightline - boolean - rightline or not (not supported)
isTrigger - boolean - trigger or not (not supported)
isMandatoryFill - boolean - mandatory fill or not (not supported)
isMandatoryEntry - boolean - mandatory entry or not (not supported)
highLight - int - highlighting type
foreColor - int - foreground color
backColor - int - background coor
charSet - int - character set (not supported)
Method Detail

getBackGroundColor

public int getBackGroundColor()
Returns extended background attribute property
Specified by:
getBackGroundColor in interface com.ibm.connector2.screen.IFieldAttrInfo
Returns:
int

getForeGroundColor

public int getForeGroundColor()
Returns extended foreground attribute property
Specified by:
getForeGroundColor in interface com.ibm.connector2.screen.IFieldAttrInfo
Returns:
int

getHighLight

public int getHighLight()
Returns extended highlight attribute property. For return value information, refer to the table at the top.
Specified by:
getHighLight in interface com.ibm.connector2.screen.IFieldAttrInfo
Returns:
int

getTransparency

public int getTransparency()
This attribute is not supported. Returns extended transparency attribute property For return value information, refer to the table at the top.
Specified by:
getTransparency in interface com.ibm.connector2.screen.IFieldAttrInfo
Returns:
int

getCharacterSet

public int getCharacterSet()
This attribute is not supported. Returns a Character Set extended Attribute.
Specified by:
getCharacterSet in interface com.ibm.connector2.screen.IFieldAttrInfo
Returns:
int

isMandatoryFill

public boolean isMandatoryFill()
This attribute is not supported. Returns whether this field is a "mandatory fill" field (from field validation extended attribute)
Specified by:
isMandatoryFill in interface com.ibm.connector2.screen.IFieldAttrInfo
Returns:
boolean

isMandatoryEntry

public boolean isMandatoryEntry()
This attribute is not supported. Returns whether this field is a "mandatory entry" field (from field validation extended attribute)
Specified by:
isMandatoryEntry in interface com.ibm.connector2.screen.IFieldAttrInfo
Returns:
boolean

isTrigger

public boolean isTrigger()
This attribute is not supported. Returns whether the host is to be notified (with an AID) once the terminal operator has finished entering character data in the field.
Specified by:
isTrigger in interface com.ibm.connector2.screen.IFieldAttrInfo
Returns:
boolean

isUnderline

public boolean isUnderline()
This attribute is not supported. Returns whether the field outlining attribute value is Underline.
Specified by:
isUnderline in interface com.ibm.connector2.screen.IFieldAttrInfo
Returns:
boolean

isRightline

public boolean isRightline()
This attribute is not supported. Returns whether the field outlining attribute value is Right vertical line.
Specified by:
isRightline in interface com.ibm.connector2.screen.IFieldAttrInfo
Returns:
boolean

isOverline

public boolean isOverline()
This attribute is not supported. Returns whether the field outlining attribute value is Overline.
Specified by:
isOverline in interface com.ibm.connector2.screen.IFieldAttrInfo
Returns:
boolean

isLeftline

public boolean isLeftline()
This attribute is not supported. Returns whether the field outlining attribute value is Left vertical line.
Specified by:
isLeftline in interface com.ibm.connector2.screen.IFieldAttrInfo
Returns:
boolean

isDisplay

public boolean isDisplay()
Returns whether this field is displayed or not
Specified by:
isDisplay in interface com.ibm.connector2.screen.IFieldAttrInfo
Returns:
boolean

isHighIntensity

public boolean isHighIntensity()
Returns whether this field has high intensity attribute or not
Specified by:
isHighIntensity in interface com.ibm.connector2.screen.IFieldAttrInfo
Returns:
boolean

isModified

public boolean isModified()
Returns whether this field is modified or not
Specified by:
isModified in interface com.ibm.connector2.screen.IFieldAttrInfo
Returns:
boolean

isNumeric

public boolean isNumeric()
Returns whether this field is numeric only field or not
Specified by:
isNumeric in interface com.ibm.connector2.screen.IFieldAttrInfo
Returns:
boolean

isPenDetectable

public boolean isPenDetectable()
Returns whether this field is pen detectable field or not
Specified by:
isPenDetectable in interface com.ibm.connector2.screen.IFieldAttrInfo
Returns:
boolean

isProtected

public boolean isProtected()
Returns whether this field is a protected field or not
Specified by:
isProtected in interface com.ibm.connector2.screen.IFieldAttrInfo
Returns:
boolean

setModified

public void setModified(boolean flag)
Method to change the Modified Data tag for a field, ie to indicate it has been modified.
Specified by:
setModified in interface com.ibm.connector2.screen.IFieldAttrInfo
Parameters:
flag - boolean - true=modified / false=not modified

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Clones this instance of class and returns it
Specified by:
clone in interface com.ibm.connector2.screen.IFieldAttrInfo
Returns:
J2HODFieldAttrInfo
Throws:
java.lang.CloneNotSupportedException -  

equals

public boolean equals(java.lang.Object obj)
Checks whether this instance is equal to the object that is passed as a parameter. Only those supported attributes are checked.
Specified by:
equals in interface com.ibm.connector2.screen.IFieldAttrInfo
Overrides:
equals in class java.lang.Object
Parameters:
obj - java.io.PrintWriter - logwriter output
Returns:
boolean - true=equal / false=different

setProtected

public void setProtected(boolean flag)
Sets protd flag to a specified value
Parameters:
flag - boolean - true=protected / false=not protected

setNumeric

public void setNumeric(boolean flag)
Sets numeric flag to a specified value
Parameters:
flag - boolean - true=numeric / false=not numeric

setPenDetectable

public void setPenDetectable(boolean flag)
Sets penDetectable flag to a specified value
Parameters:
flag - boolean - true=pen detectable / false=not pen detectable

setDisplay

public void setDisplay(boolean flag)
Sets display flag to a specified value
Parameters:
flag - boolean - true=display / false=non-display

setHighIntensity

public void setHighIntensity(boolean flag)
Sets highIntensity flag to a specified value
Parameters:
flag - boolean - true=high intensity / false=normal intensity

setUnderline

public void setUnderline(boolean flag)
This attribute is not supported. Sets underline flag to a specified value, but this attribute is not supported.
Parameters:
flag - boolean - true=underlined / false=not underlined

setOverline

public void setOverline(boolean flag)
This attribute is not supported. Sets overline flag to a specified value, but this attribute is not supported.
Parameters:
flag - boolean - true=overlined / false=not overlined

setLeftline

public void setLeftline(boolean flag)
This attribute is not supported. Sets leftline flag to a specified value, but this attribute is not supported.
Parameters:
flag - boolean - true=leftlined / false=not leftlined

setRightline

public void setRightline(boolean flag)
This attribute is not supported. Sets rightline flag to a specified value, but this attribute is not supported.
Parameters:
flag - boolean - true=rightlined / false=not rightlined

setTrigger

public void setTrigger(boolean flag)
This attribute is not supported. Sets trigger flag to a specified value, but this attribute is not supported.
Parameters:
flag - boolean - true=trigger / false=not trigger

setMandatoryFill

public void setMandatoryFill(boolean flag)
This attribute is not supported. Sets mandatoryFill flag to a specified value, but this attribute is not supported.
Parameters:
flag - boolean - true=mandatory-fill / false=not mandatory-fill

setMandatoryEntry

public void setMandatoryEntry(boolean flag)
This attribute is not supported. Sets mandatoryEntry flag to a specified value, but this attribute is not supported.
Parameters:
flag - boolean - true=mandatory-entry / false=not mandatory-entry

setHighLight

public void setHighLight(int val)
Sets highLight attribute value to a specified value
Parameters:
val - int - highlighting type value

setTransparency

public void setTransparency(int val)
This attribute is not supported. Sets transparency attribute value to a specified value, but this attribute is not supported.
Parameters:
val - int - transparency type value

setForeGroundColor

public void setForeGroundColor(int val)
Sets foreColor attribute value to a specified value
Parameters:
val - int - foreground color value

setBackGroundColor

public void setBackGroundColor(int val)
Sets backColor attribute value to a specified value
Parameters:
val - int - background color value

setCharSet

public void setCharSet(int val)
This attribute is not supported. Sets charSet attribute value to a specified value, but this attribute is not supported.
Parameters:
val - int - Character set value