GXIField (ApplinX API Specification)

All Superinterfaces:

GXICellable

All Known Implementing Classes:

GXField, GXFieldTableCell
```
public interface GXIField
extends GXICellable
```
This class represents one field in the host screen. When there are multiple application fields, it represents one index of the multiple application field.
Note: The field object is a snapshot of a field as it was taken from a host screen. You cannot set properties to the field. In order to set content to fields on the host screen, use the session object and the request objects.

Field Summary

Fields
Modifier and Type Field and Description

static int TYPE_APPFIELD

static int TYPE_HOSTFIELD

static int TYPE_HOSTKEY_FIELD

static int TYPE_MULTIPLE_APPFIELD

Fields
Modifier and Type	Field and Description
`static int`	`TYPE_APPFIELD`
`static int`	`TYPE_HOSTFIELD`
`static int`	`TYPE_HOSTKEY_FIELD`
`static int`	`TYPE_MULTIPLE_APPFIELD`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`getBGColor()`
`String`	`getContent()`
`int`	`getDataType()`
`int`	`getFGColor()`
`int`	`getIndex()`
`String`	`getInputMask()`
`int`	`getLength()`
`String`	`getName()`
`GXPosition`	`getPosition()`
`String`	`getScreenName()`
`int`	`getScreenSequenceNumber()`
`String`	`getVisualContent()`
`boolean`	`isAppField()`
`boolean`	`isAutoCursorJump()`
`boolean`	`isAutoEnter()`
`boolean`	`isBlinking()`
`boolean`	`isHighIntensified()`
`boolean`	`isMultiple()`
`boolean`	`isProtected()`
`boolean`	`isReversedVideo()`
`boolean`	`isUnderlined()`
`boolean`	`isVisible()`

- Field Detail
  - TYPE_HOSTFIELD
```
static final int TYPE_HOSTFIELD
```
    See Also:
    
    Constant Field Values
  - TYPE_APPFIELD
```
static final int TYPE_APPFIELD
```
    See Also:
    
    Constant Field Values
  - TYPE_MULTIPLE_APPFIELD
```
static final int TYPE_MULTIPLE_APPFIELD
```
    See Also:
    
    Constant Field Values
  - TYPE_HOSTKEY_FIELD
```
static final int TYPE_HOSTKEY_FIELD
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getScreenName
```
String getScreenName()
```
    Returns:
    
    the name (ID) of the screen, from which this field was taken.
  - getScreenSequenceNumber
```
int getScreenSequenceNumber()
```
    Returns:
    
    the sequential number of the screen, from which this field was taken.
  - getName
```
String getName()
```
    Returns:
    
    Returns the name of the field (for application fields). If the field is a host field, it returns null.
  - getIndex
```
int getIndex()
```
    Returns:
    
    the index of the field instance (if it is part of a multiple application field).
  - getPosition
```
GXPosition getPosition()
```
    Returns:
    
    the position of the field in the host screen.
  - getLength
```
int getLength()
```
    Returns:
    
    the length of the field.
  - getContent
```
String getContent()
```
    Specified by:
    
    getContent in interface GXICellable
    
    Returns:
    
    the content of the field (as it was taken from the host screen).
  - isProtected
```
boolean isProtected()
```
    Returns:
    
    whether this field is a protected field.
  - isVisible
```
boolean isVisible()
```
    Returns:
    
    whether this field is visible on the host screen.
  - isHighIntensified
```
boolean isHighIntensified()
```
    Returns:
    
    whether this field is an intensified field.
  - isAutoEnter
```
boolean isAutoEnter()
```
    Returns:
    
    whether this field is an auto enter field (once the field content completely fills the field, it is sent to the host screen).
  - getBGColor
```
int getBGColor()
```
    Returns:
    
    the background color of this field.
  - getFGColor
```
int getFGColor()
```
    Returns:
    
    the foreground color of this field.
  - isAutoCursorJump
```
boolean isAutoCursorJump()
```
    Returns:
    
    whether this field is an auto cursor jump field. This means that the cursor should jump automatically to the next field when this field is completely filled with content.
  - isAppField
```
boolean isAppField()
```
    Returns:
    
    whether this field is an application field.
  - isMultiple
```
boolean isMultiple()
```
    Returns:
    
    whether this field is part of a multiple application field.
  - isBlinking
```
boolean isBlinking()
```
    Returns:
    
    whether this field is blinking.
  - getDataType
```
int getDataType()
```
    Returns:
    
    the field's data type
    
    See Also:
    
    GXBaseObjectConstants for valid data types
  - getInputMask
```
String getInputMask()
```
    Returns:
    
    the field's input mask. Valid only for unprotected application fields.
  - getVisualContent
```
String getVisualContent()
```
    Returns:
    
    the field's content in its visual form, without a conversion to logical.
  - isUnderlined
```
boolean isUnderlined()
```
    Returns:
    
    whether this field is underlined.
  - isReversedVideo
```
boolean isReversedVideo()
```
    Returns:
    
    whether this field is reversed video.

Interface GXIField

Field Summary

Method Summary

Field Detail

TYPE_HOSTFIELD

TYPE_APPFIELD

TYPE_MULTIPLE_APPFIELD

TYPE_HOSTKEY_FIELD

Method Detail

getScreenName

getScreenSequenceNumber

getName

getIndex

getPosition

getLength

getContent

isProtected

isVisible

isHighIntensified

isAutoEnter

getBGColor

getFGColor

isAutoCursorJump

isAppField

isMultiple

isBlinking

getDataType

getInputMask

getVisualContent

isUnderlined

isReversedVideo