com.wrq.vhi.script.api
Interface TerminalCell


public interface TerminalCell

Represents a character on the terminal screen.


Field Summary
static int COLOR_HOST_BLUE
          Character cell color is blue.
static int COLOR_HOST_GREEN
          Character cell color is green.
static int COLOR_HOST_NOCOLOR
          No color attribute is provided for this character cell.
static int COLOR_HOST_PINK
          Character cell color is pink.
static int COLOR_HOST_RED
          Character cell color is red.
static int COLOR_HOST_TURQUOISE
          Character cell color is turquoise.
static int COLOR_HOST_WHITE
          Character cell color is white.
static int COLOR_HOST_YELLOW
          Character cell color is yellow.
static byte FONT_APL_SYMBOL
          Character cell font is the IBM APL symbol font.
static byte FONT_HEX_DIAGNOSTIC
          Character cell font is the hexadecimal diagnostic font.
static byte FONT_IBM_STATUS_LINE
          Character cell font is the IBM status line font.
static byte FONT_STANDARD
          Character cell font is the standard terminal text font.
static byte FONT_VT_HP_CONTROL
          Character cell font is the VT and HP terminal control font.
static byte FONT_VT_HP_SYMBOL
          Character cell font is the VT and HP terminal symbol font.
 
Method Summary
 char getCharacter()
          Gets the character contained in this terminal cell.
 int getColor()
          Gets the color which the terminal should use to display this character.
 byte getFont()
          Gets the font index sent by the host for this terminal cell.
 boolean isBlinking()
          Gets the blink attribute.
 boolean isColumnSeparated()
          Gets the column-separator attribute.
 boolean isErrorLine()
          Gets the error-line attribute.
 boolean isFieldEnd()
          Gets the field-end attribute.
 boolean isFieldStart()
          Gets the field-start attribute.
 boolean isHalfBrite()
          Gets the halfbrite attribute.
 boolean isIntense()
          Gets the high-intensity attribute.
 boolean isNonDisplay()
          Gets the non-display attribute.
 boolean isNumeric()
          Gets the numeric attribute.
 boolean isPenDetect()
          Gets the pen-detect attribute.
 boolean isProtected()
          Gets the protected attribute.
 boolean isReverse()
          Gets the inverse-video attribute.
 boolean isStatusLine()
          Gets the status-line attribute.
 boolean isSysRequest()
          Gets the sys-request attribute.
 boolean isUnderscore()
          Gets the underscore attribute.
 

Field Detail

COLOR_HOST_NOCOLOR

static final int COLOR_HOST_NOCOLOR
No color attribute is provided for this character cell. Returned by getColor().

See Also:
Constant Field Values

COLOR_HOST_BLUE

static final int COLOR_HOST_BLUE
Character cell color is blue. Returned by getColor().

See Also:
Constant Field Values

COLOR_HOST_GREEN

static final int COLOR_HOST_GREEN
Character cell color is green. Returned by getColor().

See Also:
Constant Field Values

COLOR_HOST_PINK

static final int COLOR_HOST_PINK
Character cell color is pink. Returned by getColor().

See Also:
Constant Field Values

COLOR_HOST_RED

static final int COLOR_HOST_RED
Character cell color is red. Returned by getColor().

See Also:
Constant Field Values

COLOR_HOST_TURQUOISE

static final int COLOR_HOST_TURQUOISE
Character cell color is turquoise. Returned by getColor().

See Also:
Constant Field Values

COLOR_HOST_WHITE

static final int COLOR_HOST_WHITE
Character cell color is white. Returned by getColor().

See Also:
Constant Field Values

COLOR_HOST_YELLOW

static final int COLOR_HOST_YELLOW
Character cell color is yellow. Returned by getColor().

See Also:
Constant Field Values

FONT_STANDARD

static final byte FONT_STANDARD
Character cell font is the standard terminal text font. Returned by getFont().

See Also:
Constant Field Values

FONT_IBM_STATUS_LINE

static final byte FONT_IBM_STATUS_LINE
Character cell font is the IBM status line font. Returned by getFont().

See Also:
Constant Field Values

FONT_HEX_DIAGNOSTIC

static final byte FONT_HEX_DIAGNOSTIC
Character cell font is the hexadecimal diagnostic font. For internal use only. Returned by getFont().

See Also:
Constant Field Values

FONT_APL_SYMBOL

static final byte FONT_APL_SYMBOL
Character cell font is the IBM APL symbol font. This font is used to display the OIA divider line for 3270 and 5250 terminal. Returned by getFont().

See Also:
Constant Field Values

FONT_VT_HP_SYMBOL

static final byte FONT_VT_HP_SYMBOL
Character cell font is the VT and HP terminal symbol font. Returned by getFont().

See Also:
Constant Field Values

FONT_VT_HP_CONTROL

static final byte FONT_VT_HP_CONTROL
Character cell font is the VT and HP terminal control font. Returned by getFont().

See Also:
Constant Field Values
Method Detail

getCharacter

char getCharacter()
Gets the character contained in this terminal cell.

Returns:
character contained by cell as char

getFont

byte getFont()

Gets the font index sent by the host for this terminal cell.

Some host systems (and terminals) can display multiple fonts on the terminal. The font index tells the terminal which font to use to display this character.

Returns:
One of the following font index numbers: FONT_STANDARD FONT_APL_SYMBOL FONT_IBM_STATUS_LINE FONT_HEX_DIAGNOSTIC FONT_VT_HP_SYMBOL FONT_VT_HP_CONTROL

getColor

int getColor()

Gets the color which the terminal should use to display this character.

Returns:
One of the following colors requested by the host application: COLOR_HOST_NOCOLOR COLOR_HOST_BLUE COLOR_HOST_GREEN COLOR_HOST_PINK COLOR_HOST_RED COLOR_HOST_TURQUOISE COLOR_HOST_WHITE COLOR_HOST_YELLOW

isBlinking

boolean isBlinking()
Gets the blink attribute.

Returns:
true if the character should be displayed as blinking

isReverse

boolean isReverse()
Gets the inverse-video attribute.

Returns:
true if the character should be displayed with inverse colors

isUnderscore

boolean isUnderscore()
Gets the underscore attribute.

Returns:
true if character should be displayed with underscore

isHalfBrite

boolean isHalfBrite()
Gets the halfbrite attribute.

Returns:
true if character is displayed with the halfbrite attribute.

isIntense

boolean isIntense()
Gets the high-intensity attribute.

Returns:
true if character should be displayed with high intensity

isProtected

boolean isProtected()
Gets the protected attribute.

Returns:
true if character is protected from user modification

isColumnSeparated

boolean isColumnSeparated()
Gets the column-separator attribute.

Returns:
true if character should be displayed as column separator

isPenDetect

boolean isPenDetect()
Gets the pen-detect attribute.

Returns:
true if character should be detectable with a light pen

isNonDisplay

boolean isNonDisplay()
Gets the non-display attribute.

Returns:
true if character should not be visible on the terminal

isNumeric

boolean isNumeric()
Gets the numeric attribute.

Returns:
true if character should contain only numeric values

isFieldStart

boolean isFieldStart()
Gets the field-start attribute.

Returns:
true if character marks the start of a field

isFieldEnd

boolean isFieldEnd()
Gets the field-end attribute.

Returns:
true if character marks the end of a field

isStatusLine

boolean isStatusLine()
Gets the status-line attribute.

Returns:
true if character is displayed on a status line

isErrorLine

boolean isErrorLine()
Gets the error-line attribute.

Returns:
true if character is displayed on an error line

isSysRequest

boolean isSysRequest()
Gets the sys-request attribute.

Returns:
true if character is displayed as a system request