com.ibm.connector2.hod.screenable
Class J2HODFieldRecord

java.lang.Object
  |
  +--com.ibm.connector2.hod.screenable.J2HODFieldRecord
All Implemented Interfaces:
com.ibm.connector2.screen.IFieldInfo

public class J2HODFieldRecord
extends java.lang.Object
implements com.ibm.connector2.screen.IFieldInfo

This class contains information about a field. The following information are available: (the default values are null for all)

Name Type Default Value Description
maxLength int 1 maximum length of this field (counting from 1)
fieldInfo J2HODFieldInfo please see J2HODFieldInfo document contains information about this field: name, text, and starting position
fieldAttrInfo J2HODFieldAttrInfo please see J2HODFieldAttrInfo document contains information about field attributes
textAttrInfo J2HODTextAttrInfo please see J2HODTextAttrInfo document contains information about text color and text attributes


Constructor Summary
J2HODFieldRecord()
          Constructs an instance of this class with default values
J2HODFieldRecord(com.ibm.connector2.screen.IFieldData fieldData, com.ibm.connector2.screen.IFieldAttrInfo fieldAttrInfo, com.ibm.connector2.screen.ITextAttrInfo textAttrInfo, int screenWidth)
          Constructs an instance of this class based on the information provided by parameters.
 
Method Summary
 java.lang.Object clone()
          Clones and returns this instance of this class
 boolean equals(java.lang.Object other)
          Determines whether this instance contains same data as specified object instance.
 J2HODFieldAttrInfo getFieldAttrInfo()
          Returns fieldAttrInfo
 J2HODFieldInfo getFieldInfo()
          Returns fieldInfo
 int getMaxLength()
          Returns a maximum length of this field
 java.lang.String getName()
          Returns name of this field
 int getStartCol()
          Returns starting column position of this field (counting from 1)
 int getStartPos()
          Returns starting position of this field (counting from 0, from top-left to right and down)
 int getStartRow()
          Returns starting row position of this field (counting from 1)
 java.lang.String getText()
          Returns the text content of this field
 J2HODTextAttrInfo getTextAttrInfo()
          Returns textAttrInfo
 void setText(java.lang.String text)
          Sets field text
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

J2HODFieldRecord

public J2HODFieldRecord()
Constructs an instance of this class with default values

J2HODFieldRecord

public J2HODFieldRecord(com.ibm.connector2.screen.IFieldData fieldData,
                        com.ibm.connector2.screen.IFieldAttrInfo fieldAttrInfo,
                        com.ibm.connector2.screen.ITextAttrInfo textAttrInfo,
                        int screenWidth)
                 throws com.ibm.connector2.screen.BuildFieldException
Constructs an instance of this class based on the information provided by parameters.
Parameters:
fieldData - com.ibm.connector2.screen.IFieldData - basic field data
fieldAttrInfo - com.ibm.connector2.screen.IFieldAttrInfo - field attribute information
textAttrInfo - com.ibm.connector2.screen.ITextAttrInfo - text attribute information
screenWidth - int - screen width
Throws:
com.ibm.connector2.screen.BuildFieldException - - exception while building fields.
Method Detail

getName

public java.lang.String getName()
Returns name of this field
Specified by:
getName in interface com.ibm.connector2.screen.IFieldInfo
Returns:
String

getText

public java.lang.String getText()
Returns the text content of this field
Specified by:
getText in interface com.ibm.connector2.screen.IFieldInfo
Returns:
String

getStartPos

public int getStartPos()
Returns starting position of this field (counting from 0, from top-left to right and down)
Specified by:
getStartPos in interface com.ibm.connector2.screen.IFieldInfo
Returns:
int

getStartRow

public int getStartRow()
Returns starting row position of this field (counting from 1)
Specified by:
getStartRow in interface com.ibm.connector2.screen.IFieldInfo
Returns:
int

getStartCol

public int getStartCol()
Returns starting column position of this field (counting from 1)
Specified by:
getStartCol in interface com.ibm.connector2.screen.IFieldInfo
Returns:
int

getMaxLength

public int getMaxLength()
Returns a maximum length of this field
Returns:
int

getFieldInfo

public J2HODFieldInfo getFieldInfo()
Returns fieldInfo
Returns:
J2HODFieldInfo
See Also:
J2HODFieldInfo

getFieldAttrInfo

public J2HODFieldAttrInfo getFieldAttrInfo()
Returns fieldAttrInfo
Returns:
J2HODFieldAttrInfo
See Also:
J2HODFieldAttrInfo

getTextAttrInfo

public J2HODTextAttrInfo getTextAttrInfo()
Returns textAttrInfo
Returns:
J2HODTextAttrInfo
See Also:
J2HODTextAttrInfo

setText

public void setText(java.lang.String text)
Sets field text
Parameters:
text - String

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Clones and returns this instance of this class
Returns:
J2HODFieldRecord
Throws:
java.lang.CloneNotSupportedException -  

equals

public boolean equals(java.lang.Object other)
Determines whether this instance contains same data as specified object instance.
Overrides:
equals in class java.lang.Object