Package com.ibm.jakarta.connector2.cics
Class EPIFieldRecordImpl
java.lang.Object
com.ibm.jakarta.connector2.cics.EPIFieldRecordImpl
- All Implemented Interfaces:
com.ibm.connector2.screen.IExtendedAttributes
,com.ibm.connector2.screen.IFieldInfo
,EPIFieldRecord
,jakarta.resource.cci.Record
,Serializable
,Cloneable
public class EPIFieldRecordImpl
extends Object
implements EPIFieldRecord, com.ibm.connector2.screen.IFieldInfo, Serializable
-
Field Summary
FieldsFields inherited from interface com.ibm.connector2.screen.IExtendedAttributes
black, blinkHlt, blue, cyan, darkblue, defaultColor, defaultHlt, defaultTran, gray, green, intenseHlt, neutral, neutralBGrnd, normalHlt, opaqueTran, orange, orTran, paleCyan, paleGreen, pink, purple, red, reverseHlt, underscoreHlt, white, xorTran, yellow
-
Constructor Summary
ConstructorsConstructorDescriptionEPIFieldRecordImpl
(int position, int depth, int width, String text, int maximumLength, com.ibm.connector2.screen.IFieldAttrInfo fieldAttributes) -
Method Summary
Modifier and TypeMethodDescriptionvoid
appendText
(String newText) Append the given string to this field.clone()
boolean
int
Returns a constant which represents the background color of the screen.int
Returns a constant which represents the foreground color of the field text.int
Returns a constant which indicates the type of highlight for the field.int
Returns the maximum length of the field.getName()
int
int
int
getText()
Get the text of the field.int
Return the current column of the text for the field.int
Return the current position of the text for the field.int
Return the current row of the text for the field.int
Returns a constant which indicates the type of transparency for the field.boolean
Returns whether a field has any attribute bytes (ie it is a formatted field or not).int
hashCode()
boolean
Returns a flag indicating whether the field should be displayed or not.boolean
Returns a flag indicating whether the field is high intensity.boolean
Returns a flag indicating whether the field has been modified.boolean
Returns a flag indicating whether the field is only numeric.boolean
Returns a flag indicating whether the field is protected.void
setRecordName
(String newName) void
setRecordShortDescription
(String newDesc) void
Set the text of the field to the given string.
-
Field Details
-
CLASS_VERSION
- See Also:
-
-
Constructor Details
-
EPIFieldRecordImpl
public EPIFieldRecordImpl(int position, int depth, int width, String text, int maximumLength, com.ibm.connector2.screen.IFieldAttrInfo fieldAttributes) throws com.ibm.connector2.screen.ScreenException - Throws:
com.ibm.connector2.screen.ScreenException
-
-
Method Details
-
getRecordName
- Specified by:
getRecordName
in interfacejakarta.resource.cci.Record
-
setRecordName
- Specified by:
setRecordName
in interfacejakarta.resource.cci.Record
-
setRecordShortDescription
- Specified by:
setRecordShortDescription
in interfacejakarta.resource.cci.Record
-
getRecordShortDescription
- Specified by:
getRecordShortDescription
in interfacejakarta.resource.cci.Record
-
clone
- Specified by:
clone
in interfacejakarta.resource.cci.Record
- Throws:
CloneNotSupportedException
-
equals
-
appendText
Description copied from interface:EPIFieldRecord
Append the given string to this field.- Specified by:
appendText
in interfaceEPIFieldRecord
- Parameters:
newText
- The text to append- Throws:
com.ibm.connector2.screen.ScreenException
- If the complete text of the field is too long.
-
hasAttribute
public boolean hasAttribute()Description copied from interface:EPIFieldRecord
Returns whether a field has any attribute bytes (ie it is a formatted field or not).- Specified by:
hasAttribute
in interfaceEPIFieldRecord
-
getBackGroundColor
public int getBackGroundColor()Description copied from interface:EPIFieldRecord
Returns a constant which represents the background color of the screen.- Specified by:
getBackGroundColor
in interfaceEPIFieldRecord
- Returns:
- Background color.
-
getForeGroundColor
public int getForeGroundColor()Description copied from interface:EPIFieldRecord
Returns a constant which represents the foreground color of the field text.- Specified by:
getForeGroundColor
in interfaceEPIFieldRecord
- Returns:
- The foreground color.
-
getHighlight
public int getHighlight()Description copied from interface:EPIFieldRecord
Returns a constant which indicates the type of highlight for the field.- Specified by:
getHighlight
in interfaceEPIFieldRecord
- Returns:
- The highlight.
-
getMaxTextLength
public int getMaxTextLength()Description copied from interface:EPIFieldRecord
Returns the maximum length of the field. This does not include the attribute byte. It is the maximum length of text allowed.- Specified by:
getMaxTextLength
in interfaceEPIFieldRecord
- Returns:
- Maximum length of the field.
-
getTextCol
public int getTextCol()Description copied from interface:EPIFieldRecord
Return the current column of the text for the field. This does not include the attribute byte, but rather the actual text position.- Specified by:
getTextCol
in interfaceEPIFieldRecord
- Returns:
- The text column.
-
getTextPos
public int getTextPos()Description copied from interface:EPIFieldRecord
Return the current position of the text for the field. This does not include the attribute byte, but rather the actual text position.- Specified by:
getTextPos
in interfaceEPIFieldRecord
- Returns:
- The text position.
-
getTextRow
public int getTextRow()Description copied from interface:EPIFieldRecord
Return the current row of the text for the field.- Specified by:
getTextRow
in interfaceEPIFieldRecord
- Returns:
- The text row.
-
getText
Description copied from interface:EPIFieldRecord
Get the text of the field.- Specified by:
getText
in interfaceEPIFieldRecord
- Specified by:
getText
in interfacecom.ibm.connector2.screen.IFieldInfo
- Returns:
- The text of the field.
-
getTransparency
public int getTransparency()Description copied from interface:EPIFieldRecord
Returns a constant which indicates the type of transparency for the field.- Specified by:
getTransparency
in interfaceEPIFieldRecord
- Returns:
- The transparency.
-
isDisplay
public boolean isDisplay()Description copied from interface:EPIFieldRecord
Returns a flag indicating whether the field should be displayed or not.- Specified by:
isDisplay
in interfaceEPIFieldRecord
- Returns:
- True if the field is displayable.
-
isHighIntensity
public boolean isHighIntensity()Description copied from interface:EPIFieldRecord
Returns a flag indicating whether the field is high intensity.- Specified by:
isHighIntensity
in interfaceEPIFieldRecord
- Returns:
- True if the field is high intensity.
-
isModified
public boolean isModified()Description copied from interface:EPIFieldRecord
Returns a flag indicating whether the field has been modified.- Specified by:
isModified
in interfaceEPIFieldRecord
- Returns:
- True if the field has it's modified flag set.
-
isNumeric
public boolean isNumeric()Description copied from interface:EPIFieldRecord
Returns a flag indicating whether the field is only numeric.- Specified by:
isNumeric
in interfaceEPIFieldRecord
- Returns:
- True if the field only supports numeric data.
-
isProtected
public boolean isProtected()Description copied from interface:EPIFieldRecord
Returns a flag indicating whether the field is protected.- Specified by:
isProtected
in interfaceEPIFieldRecord
- Returns:
- True if the field is protected.
-
setText
Description copied from interface:EPIFieldRecord
Set the text of the field to the given string.- Specified by:
setText
in interfaceEPIFieldRecord
- Parameters:
newText
- The text to set the field to.- Throws:
com.ibm.connector2.screen.ScreenException
- If the text is too long.
-
getStartCol
public int getStartCol()- Specified by:
getStartCol
in interfacecom.ibm.connector2.screen.IFieldInfo
-
getStartPos
public int getStartPos()- Specified by:
getStartPos
in interfacecom.ibm.connector2.screen.IFieldInfo
-
getStartRow
public int getStartRow()- Specified by:
getStartRow
in interfacecom.ibm.connector2.screen.IFieldInfo
-
getName
- Specified by:
getName
in interfacecom.ibm.connector2.screen.IFieldInfo
-
hashCode
public int hashCode()
-