|
CICS® Transaction Gateway Programming Reference V3.1 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.ctg.epi.Field
This class represents a field in a 3270 screen and provides methods to query and set the contents and attributes of the field.
The field can be thought of as a piece of text with various attributes that define the way it is displayed on a 3270 terminal. A 3270 terminal would display the base attribute as a space, followed by the field text.
The base attribute byte is a bit field that encodes the field attributes. see the 3270 Datastream Programmers Reference for details.
Field Summary | |
static int |
alphanumeric
alphanumeric field |
static int |
black
the color black |
static int |
blinkHlt
blink highlight |
static int |
blue
the color blue |
static int |
cyan
the color cyan |
static int |
dark
dark |
static int |
darkblue
the color dark blue |
static int |
defaultColor
default colour |
static int |
defaultHlt
default highlight |
static int |
defaultTran
default transparency |
static int |
gray
the color gray |
static int |
green
the color green |
static int |
intense
intense |
static int |
intenseHlt
intense highlight |
static int |
isprotect
protected field (no data entry) |
static int |
modified
modified field (will be flowed back to the server) |
static int |
neutral
neutral foreground color |
static int |
neutralBGrnd
neutral background colour |
static int |
normal
normal intensity |
static int |
normalHlt
normal highlight |
static int |
numeric
numeric field (non-numeric characters cannot be entered) This is not currently enforced |
static int |
opaqueTran
opaque transparency |
static int |
orange
the color orange |
static int |
orTran
OR transparency |
static int |
paleCyan
the color pale cyan |
static int |
paleGreen
the color pale green |
static int |
pink
the color pink |
static int |
purple
the color purple |
static int |
red
the color red |
static int |
reverseHlt
reverse highlight |
static int |
underscoreHlt
underscore highlight |
static int |
unmodified
unmodified field (does not need to be flowed back to the server) |
static int |
unprotect
unprotected field (text can be modified) |
static int |
white
the color white |
static int |
xorTran
XOR transparency |
static int |
yellow
the color yellow |
Constructor Summary | |
(package private) |
Field(Screen screen,
int pos)
Constructs a field at the specified position in the screen buffer |
Method Summary | |
void |
appendText(java.lang.String append)
Appends the given String to the field text |
int |
backgroundColor()
Returns a constant indicating the background color of the field. |
char |
baseAttribute()
Returns the 3270 base attribute of the field |
int |
dataTag()
Returns a constant indicating whether or not the data in the field has been modified. |
int |
foregroundColor()
Returns a constant indicating the foreground color of the field. |
(package private) boolean |
getAttribute()
Returns a boolean indicating the presence of a field attribute |
byte[] |
getBytes()
Returns the text currently in the field as a byte array |
int |
getColumn()
Returns the column at which the field starts on the screen. |
int |
getPosition()
Returns the position of the start of the field on the screen |
int |
getRow()
Returns the row at which the field starts on the screen. |
java.lang.String |
getText()
Return the contents of the field as a String |
int |
highlight()
Returns a constant indicating which type of highlight is being used |
int |
inputProt()
Returns a constant indicating whether or not the field is protected. |
int |
inputType()
Returns a constant indicating the input data type for this field. |
int |
intensity()
Returns a constant indicating the field intensity. |
int |
length()
Returns the total length of the field |
(package private) void |
reset()
Resets the field. |
void |
resetDataTag()
Resets the modified data tag (MDT) to unmodified |
(package private) void |
setAttribute(boolean attribute)
Sets whether there is a field attribute present |
void |
setBaseAttribute(char attr)
Sets the 3270 base attribute |
void |
setBytes(int pos,
byte[] newbytes,
int length)
Sets the byte array to the specified values starting at the specified buffer address. |
void |
setExtAttribute(char type,
char value)
Sets an extended 3270 attribute. |
(package private) void |
setMaxLength(int length)
Sets the maximum text length. |
void |
setText(java.lang.String newtext)
Set the contents of the field to the given String |
int |
textLength()
Returns the number of characters in the field |
int |
transparency()
Returns a constant indicating the background transparency of the field. |
(package private) void |
updateBytes()
Converts String representation to bytes |
(package private) void |
updateString()
Converts byte representation to String |
Methods inherited from class java.lang.Object |
|
Field Detail |
public static final int defaultHlt
public static final int normalHlt
public static final int blinkHlt
public static final int reverseHlt
public static final int underscoreHlt
public static final int intenseHlt
public static final int defaultColor
public static final int neutralBGrnd
public static final int blue
public static final int red
public static final int pink
public static final int green
public static final int cyan
public static final int yellow
public static final int neutral
public static final int black
public static final int darkblue
public static final int orange
public static final int purple
public static final int paleGreen
public static final int paleCyan
public static final int gray
public static final int white
public static final int defaultTran
public static final int orTran
public static final int xorTran
public static final int opaqueTran
public static final int isprotect
public static final int unprotect
public static final int alphanumeric
public static final int numeric
public static final int normal
public static final int intense
public static final int dark
public static final int unmodified
public static final int modified
Constructor Detail |
Field(Screen screen, int pos)
screen
- the Screen that contains the fieldpos
- the buffer position of the fieldMethod Detail |
void setMaxLength(int length)
length
- the maximum lengthboolean getAttribute()
void setAttribute(boolean attribute)
attribute
- true or falsepublic int getPosition()
public int getRow()
public int getColumn()
public int length()
public char baseAttribute()
public int inputProt()
public int inputType()
public int intensity()
public int dataTag()
public int highlight()
public int transparency()
public int foregroundColor()
public int backgroundColor()
public void setBaseAttribute(char attr)
attr
- the attributepublic void resetDataTag()
public void setExtAttribute(char type, char value) throws EPIException
type
- the attribute typevalue
- the attribute valuepublic void appendText(java.lang.String append) throws java.io.UnsupportedEncodingException
append
- the text to addvoid reset()
public void setBytes(int pos, byte[] newbytes, int length) throws java.io.UnsupportedEncodingException
pos
- the buffer addressnewbytes
- the byteslength
- the number of bytespublic int textLength()
public void setText(java.lang.String newtext)
newtext
- a Stringpublic java.lang.String getText() throws java.io.UnsupportedEncodingException
public byte[] getBytes() throws java.io.UnsupportedEncodingException
void updateString() throws java.io.UnsupportedEncodingException
void updateBytes() throws java.io.UnsupportedEncodingException
|
© Copyright IBM Corp. 1994, 1999 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |