com.sabratec.applinx.baseobject

Class GXField

java.lang.Object

com.sabratec.applinx.baseobject.GXField

All Implemented Interfaces:

GXIField, GXICellable, Serializable

public class GXField
extends Object
implements GXIField, Serializable

This class represents one field on the host screen. This field can be a host field or an application field, or an instance within a multiple appfield.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	FIELD_TYPE_APPFIELD
static int	FIELD_TYPE_HOSTFIELD

Fields inherited from interface com.sabratec.applinx.baseobject.GXIField

TYPE_APPFIELD, TYPE_HOSTFIELD, TYPE_HOSTKEY_FIELD, TYPE_MULTIPLE_APPFIELD

Constructor Summary

Constructors

Constructor and Description
GXField()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
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	isHostKeyField()
boolean	isMultiple()
boolean	isProtected()
boolean	isReversedVideo()
boolean	isUnderlined()
boolean	isVisible()

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FIELD_TYPE_APPFIELD

public static final int FIELD_TYPE_APPFIELD

See Also:

Constant Field Values

FIELD_TYPE_HOSTFIELD

public static final int FIELD_TYPE_HOSTFIELD

See Also:

Constant Field Values

Constructor Detail

GXField

public GXField()

Method Detail

getScreenName

public String getScreenName()

Specified by:

getScreenName in interface GXIField

Returns:

the name (ID) of the screen, from which this field was taken.

getScreenSequenceNumber

public int getScreenSequenceNumber()

Specified by:

getScreenSequenceNumber in interface GXIField

Returns:

the sequential number of the screen, from which this field was taken.

getName

public String getName()

Specified by:

getName in interface GXIField

Returns:

Returns the name of the field (for application fields). If the field is a host field, it returns null.

getIndex

public int getIndex()

Specified by:

getIndex in interface GXIField

Returns:

the index of the field instance (if it is part of a multiple application field).

getPosition

public GXPosition getPosition()

Specified by:

getPosition in interface GXIField

Returns:

the position of the field in the host screen.

getLength

public int getLength()

Specified by:

getLength in interface GXIField

Returns:

the length of the field.

getContent

public String getContent()

Specified by:

getContent in interface GXIField

Specified by:

getContent in interface GXICellable

Returns:

the content of the field (as it was taken from the host screen).

isProtected

public boolean isProtected()

Specified by:

isProtected in interface GXIField

Returns:

whether this field is a protected field.

isVisible

public boolean isVisible()

Specified by:

isVisible in interface GXIField

Returns:

whether this field is visible on the host screen.

isHighIntensified

public boolean isHighIntensified()

Specified by:

isHighIntensified in interface GXIField

Returns:

whether this field is an intensified field.

isAutoEnter

public boolean isAutoEnter()

Specified by:

isAutoEnter in interface GXIField

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

public int getBGColor()

Specified by:

getBGColor in interface GXIField

Returns:

the background color of this field.

getFGColor

public int getFGColor()

Specified by:

getFGColor in interface GXIField

Returns:

the foreground color of this field.

isAutoCursorJump

public boolean isAutoCursorJump()

Specified by:

isAutoCursorJump in interface GXIField

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

public boolean isAppField()

Specified by:

isAppField in interface GXIField

Returns:

whether this field is an application field.

isHostKeyField

public boolean isHostKeyField()

isMultiple

public boolean isMultiple()

Specified by:

isMultiple in interface GXIField

Returns:

whether this field is part of a multiple application field.

isBlinking

public boolean isBlinking()

Specified by:

isBlinking in interface GXIField

Returns:

whether this field is blinking.

getDataType

public int getDataType()

Specified by:

getDataType in interface GXIField

Returns:

the field's data type

See Also:

GXBaseObjectConstants for valid data types

getInputMask

public String getInputMask()

Specified by:

getInputMask in interface GXIField

Returns:

the field's input mask. Valid only for unprotected application fields.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getVisualContent

public String getVisualContent()

Specified by:

getVisualContent in interface GXIField

Returns:

the field's content in its visual form, without a conversion to logical.

isUnderlined

public boolean isUnderlined()

Specified by:

isUnderlined in interface GXIField

Returns:

whether this field is underlined.

isReversedVideo

public boolean isReversedVideo()

Specified by:

isReversedVideo in interface GXIField

Returns:

whether this field is reversed video.