com.ibm.connector2.hod.screenable
Class J2HODScreenInfo

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

public class J2HODScreenInfo
extends java.lang.Object
implements com.ibm.connector2.screen.IScreenInfo

This class represents screen information. It implements IScreenInfo interface. It contains the following attributes:

Name Type Default Value Description
depth int 24 Screen depth (number of rows) - counting from 1
width int 80 Screen width (number of columns) - counting from 1
fieldCount int 0 Total number of fields in a screen record
suportHighlight boolean true Supports extended highlighting or not
defForegColor int 0xF4 (IExtendedAttributes.green) Default foreground color
defBackgColor int 0x00 Default background color
defCharSet int 0x00 Default Character Set (not supported)

See Also:
Serialized Form

Constructor Summary
J2HODScreenInfo()
          Create an instance of J2HODScreenInfo with default attribute values.
J2HODScreenInfo(int depth, int width, int fieldCount)
          Create an instance of J2HODScreenInfo with specified attribute values.
J2HODScreenInfo(int depth, int width, int fieldCount, boolean highlight, int foreC, int backC, int charSet)
          Create an instance of J2HODScreenInfo with specified attribute values.
 
Method Summary
 java.lang.Object clone()
          Returns a clone instance of this class object
 boolean equals(java.lang.Object obj)
          Returns whether this instance of this class is equal to the instance of an object passed in.
 int getDefaultBackgroundColor()
          returns the default color for fields on the screen
 int getDefaultCharSet()
          returns the default character set for fields on the screen
 int getDefaultForegroundColor()
          returns the default color for fields on the screen
 int getDepth()
          Returns The Number of Rows The Screen has
 int getFieldCount()
          Returns the number of fields on the screen
 int getWidth()
          Returns the number of columns the screen has
 void setDefaultBackgroundColor(int val)
          Sets the default background color of a screen
 void setDefaultCharSet(int val)
          This attribute is not supported.
 void setDefaultForegroundColor(int val)
          Sets the default foreground color of a screen
 void setDepth(int val)
          Sets The Number of Rows The Screen has
 void setFieldCount(int val)
          Sets the number of fields on the screen
 void setSupportsHighlighting(boolean val)
          Sets whether a screen supports extended highlighting or not
 void setWidth(int val)
          Sets the number of columns the screen has
 boolean supportsHighlighting()
          returns whether a screen supports extended highlighting
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

J2HODScreenInfo

public J2HODScreenInfo()
Create an instance of J2HODScreenInfo with default attribute values.

J2HODScreenInfo

public J2HODScreenInfo(int depth,
                       int width,
                       int fieldCount)
Create an instance of J2HODScreenInfo with specified attribute values.

J2HODScreenInfo

public J2HODScreenInfo(int depth,
                       int width,
                       int fieldCount,
                       boolean highlight,
                       int foreC,
                       int backC,
                       int charSet)
Create an instance of J2HODScreenInfo with specified attribute values.
Method Detail

getDepth

public int getDepth()
Returns The Number of Rows The Screen has
Specified by:
getDepth in interface com.ibm.connector2.screen.IScreenInfo
Returns:
int

getWidth

public int getWidth()
Returns the number of columns the screen has
Specified by:
getWidth in interface com.ibm.connector2.screen.IScreenInfo
Returns:
int

getFieldCount

public int getFieldCount()
Returns the number of fields on the screen
Specified by:
getFieldCount in interface com.ibm.connector2.screen.IScreenInfo
Returns:
int

supportsHighlighting

public boolean supportsHighlighting()
returns whether a screen supports extended highlighting
Specified by:
supportsHighlighting in interface com.ibm.connector2.screen.IScreenInfo
Returns:
boolean

getDefaultForegroundColor

public int getDefaultForegroundColor()
returns the default color for fields on the screen
Specified by:
getDefaultForegroundColor in interface com.ibm.connector2.screen.IScreenInfo
Returns:
int

getDefaultBackgroundColor

public int getDefaultBackgroundColor()
returns the default color for fields on the screen
Specified by:
getDefaultBackgroundColor in interface com.ibm.connector2.screen.IScreenInfo
Returns:
int

getDefaultCharSet

public int getDefaultCharSet()
returns the default character set for fields on the screen
Specified by:
getDefaultCharSet in interface com.ibm.connector2.screen.IScreenInfo
Returns:
int

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Returns a clone instance of this class object
Returns:
J2HODScreenInfo
Throws:
java.lang.CloneNotSupportedException -  

equals

public boolean equals(java.lang.Object obj)
Returns whether this instance of this class is equal to the instance of an object passed in. Only supported attributes are compared.
Overrides:
equals in class java.lang.Object
Parameters:
obj - Object - an instance of object to compare
Returns:
boolean

setDepth

public void setDepth(int val)
Sets The Number of Rows The Screen has
Parameters:
val - int - screen depth (number of row)

setWidth

public void setWidth(int val)
Sets the number of columns the screen has
Parameters:
val - int - screen width (number of columns)

setFieldCount

public void setFieldCount(int val)
Sets the number of fields on the screen
Parameters:
val - int - number of fields

setSupportsHighlighting

public void setSupportsHighlighting(boolean val)
Sets whether a screen supports extended highlighting or not
Parameters:
val - boolean - highlighting support or not

setDefaultForegroundColor

public void setDefaultForegroundColor(int val)
Sets the default foreground color of a screen
Parameters:
val - int - foreground color value

setDefaultBackgroundColor

public void setDefaultBackgroundColor(int val)
Sets the default background color of a screen
Parameters:
val - int - background color value

setDefaultCharSet

public void setDefaultCharSet(int val)
This attribute is not supported. Sets the default character set for this screen
Parameters:
val - int - character set value