CICS® Transaction Gateway Programming Reference v1.1.0.0

com.ibm.connector2.cics
Interface EPIFieldRecord

All Superinterfaces:
java.lang.Cloneable, IExtendedAttributes, javax.resource.cci.Record, java.io.Serializable

public interface EPIFieldRecord
extends javax.resource.cci.Record, IExtendedAttributes

This interface provides access to information about a specific field retrieved from the EPI screen record.

This interface represents a field on the screen. It allows you to query information such as the text of the field and the fields attributes. It also allows you to modify the text of this field to be sent to the CICS server at some point in time.


Field Summary
 
Fields 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
 
Method Summary
 void appendText(java.lang.String text)
          Append the given string to this field.
 int getBackGroundColor()
          Returns a constant which represents the background color of the screen.
 int getForeGroundColor()
          Returns a constant which represents the foreground color of the field text.
 int getHighlight()
          Returns a constant which indicates the type of highlight for the field.
 int getMaxTextLength()
          Returns the maximum length of the field.
 java.lang.String getText()
          Get the text of the field.
 int getTextCol()
          Return the current column of the text for the field.
 int getTextPos()
          Return the current position of the text for the field.
 int getTextRow()
          Return the current row of the text for the field.
 int getTransparency()
          Returns a constant which indicates the type of transparency for the field.
 boolean hasAttribute()
          Returns whether a field has any attribute bytes (ie it is a formatted field or not).
 boolean isDisplay()
          Returns a flag indicating whether the field should be displayed or not.
 boolean isHighIntensity()
          Returns a flag indicating whether the field is high intensity.
 boolean isModified()
          Returns a flag indicating whether the field has been modified.
 boolean isNumeric()
          Returns a flag indicating whether the field is only numeric.
 boolean isProtected()
          Returns a flag indicating whether the field is protected.
 void setText(java.lang.String text)
          Set the text of the field to the given string.
 
Methods inherited from interface javax.resource.cci.Record
clone, equals, getRecordName, getRecordShortDescription, hashCode, setRecordName, setRecordShortDescription
 

Method Detail

appendText

void appendText(java.lang.String text)
                throws ScreenException
Append the given string to this field.

Parameters:
text - The text to append
Throws:
ScreenException - If the complete text of the field is too long.

setText

void setText(java.lang.String text)
             throws ScreenException
Set the text of the field to the given string.

Parameters:
text - The text to set the field to.
Throws:
ScreenException - If the text is too long.

getText

java.lang.String getText()
Get the text of the field.

Returns:
The text of the field.

hasAttribute

boolean hasAttribute()
Returns whether a field has any attribute bytes (ie it is a formatted field or not).


getBackGroundColor

int getBackGroundColor()
Returns a constant which represents the background color of the screen.

Returns:
Background color.

getForeGroundColor

int getForeGroundColor()
Returns a constant which represents the foreground color of the field text.

Returns:
The foreground color.

getHighlight

int getHighlight()
Returns a constant which indicates the type of highlight for the field.

Returns:
The highlight.

getTextPos

int getTextPos()
Return the current position of the text for the field. This does not include the attribute byte, but rather the actual text position.

Returns:
The text position.

getTextRow

int getTextRow()
Return the current row of the text for the field.

Returns:
The text row.

getTextCol

int getTextCol()
Return the current column of the text for the field. This does not include the attribute byte, but rather the actual text position.

Returns:
The text column.

getMaxTextLength

int getMaxTextLength()
Returns the maximum length of the field. This does not include the attribute byte. It is the maximum length of text allowed.

Returns:
Maximum length of the field.

getTransparency

int getTransparency()
Returns a constant which indicates the type of transparency for the field.

Returns:
The transparency.

isDisplay

boolean isDisplay()
Returns a flag indicating whether the field should be displayed or not.

Returns:
True if the field is displayable.

isHighIntensity

boolean isHighIntensity()
Returns a flag indicating whether the field is high intensity.

Returns:
True if the field is high intensity.

isModified

boolean isModified()
Returns a flag indicating whether the field has been modified.

Returns:
True if the field has it's modified flag set.

isNumeric

boolean isNumeric()
Returns a flag indicating whether the field is only numeric.

Returns:
True if the field only supports numeric data.

isProtected

boolean isProtected()
Returns a flag indicating whether the field is protected.

Returns:
True if the field is protected.

©Copyright IBM Corp. 1994, 2014
Legal