Display3270 (NetPhantom® 7.7 Java API Specification)

java.lang.Object
- se.entra.phantom.server.tn3270e.Display3270

Direct Known Subclasses:

Display3270Printer
```
public class Display3270
extends Object
```
Handles the 3270 display session.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class Display3270.Aid
Handles sending Attention IDentifier keys to host.

Nested Classes
Modifier and Type	Class and Description
`class`	`Display3270.Aid` Handles sending Attention IDentifier keys to host.

Field Summary

Fields
Modifier and Type	Field and Description
`Display3270.Aid`	`aid` The Aid class instance.
`static char`	`ASCII_FA` Special ASCII code: Field Attribute.
`static int`	`ATTR_BASICMASK` The basic attribute mask when getting the attribute to send it to host.
`static int`	`ATTR_EXTENDEDCOLORMASK` The mask used to find out if a character or field attribute has extended color properties.
`static int`	`ATTR_FLAG_ALL_FLAGS`
`static int`	`ATTR_FLAG_BACKCOLOR`
`static int`	`ATTR_FLAG_CHARSET`
`static int`	`ATTR_FLAG_FORECOLOR`
`static int`	`ATTR_FLAG_HIGHLIGHT`
`static int`	`ATTR_FLAG_OUTLINE`
`static int`	`ATTR_GECHAR`
`static int`	`ATTR_HIGHLIGHT_BLINK`
`static int`	`ATTR_HIGHLIGHT_REVERSE`
`static int`	`ATTR_HIGHLIGHT_UNDERLINE`
`static int`	`ATTR_INTENSITY`
`static int`	`ATTR_MASK_ALL_EQUALIZE`
`static int`	`ATTR_MASK_ALL_EXTENDED`
`static int`	`ATTR_MASK_ALL_EXTENDED_BITS` The mask used to find out if a character or field attribute has extended properties, not including the GE character, the special character and the needs update flag.
`static int`	`ATTR_MASK_BACKCOLOR`
`static int`	`ATTR_MASK_CHARSET`
`static int`	`ATTR_MASK_FORECOLOR`
`static int`	`ATTR_MASK_HIGHLIGHT`
`static int`	`ATTR_MASK_OUTLINE`
`static int`	`ATTR_MODIFIED`
`static int`	`ATTR_NEEDSUPDATE`
`static int`	`ATTR_NONDISPLAY`
`static int`	`ATTR_NUMERIC`
`static int`	`ATTR_PROTECTED`
`static int`	`ATTR_RESERVED`
`static int`	`ATTR_SHIFT_BACKCOLOR`
`static int`	`ATTR_SHIFT_CHARSET`
`static int`	`ATTR_SHIFT_FORECOLOR`
`static int`	`ATTR_SHIFT_HIGHLIGHT`
`static int`	`ATTR_SHIFT_OUTLINE`
`static int`	`ATTR_SPECIALCHAR`
`static int`	`ATTR_TRANSGRAPHIC0`
`static int`	`ATTR_TRANSGRAPHIC1`
`static int`	`STATE_FULL`
`static int`	`STATE_NUMERIC`
`static int`	`STATE_PROTECTED`
`static int`	`STATE_SENDING`
`static int`	`STATE_SYSTEM`
`static int`	`STATE_WAITING`

Constructor Summary

Constructors
Constructor and Description

Display3270(HostSession3270 h, int cols, int rows)
Creates the display of the specified size.

Constructors
Constructor and Description
`Display3270(HostSession3270 h, int cols, int rows)` Creates the display of the specified size.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearScreen()` Clears the presentation space.
`byte`	`convertCharToEBCDIC(char c)` Converts a single character to EBCDIC byte.
`boolean`	`cursorBacktab()` Back-tabs the cursor.
`boolean`	`cursorEnd()` Moves the cursor to the end of the field.
`boolean`	`cursorHome()` Moves the cursor to the first unprotected field.
`boolean`	`cursorNewLine()` Moves cursor to a new line.
`boolean`	`cursorTab()` Moves the cursor to the next field.
`boolean`	`delete()` Deletes a character at the cursor position.
`boolean`	`destructiveBackSpace()` Performs a destructive backspace.
`boolean`	`doesFieldHaveExtendedAttributes(HostField hostField)` Checks if a host field has extended attributes or not.
`boolean`	`eraseEOF()` Deletes all characters in the current field from the current cursor position to end of line.
`boolean`	`eraseInput()` Clears all input capable fields.
`void`	`getCharactersAndAttributes(char[] chars, int[] attrbs, int beginPos, int endPos)` Gets the characters and attributes between two positions, including the end position.
`void`	`getCharactersAndAttributes(char[] chars, int[] attrbs, int beginPos, int endPos, char fieldOrNullChar)` Gets the characters and attributes between two positions, including the end position.
`int`	`getCursorAddress()` Gets the cursor position.
`Point`	`getCursorPosition()` Gets the cursor position.
`int[]`	`getDisplayAttr()` Gets the display attributes.
`char[]`	`getDisplayData()` Gets the display data.
`int`	`getEnteredData(short[] buf)` Gets the user entered data in the buffer, returning the length.
`int`	`getFieldAttribute(int addr)` Gets the "new character" 3270 host attribute.
`int`	`getHeight()` Gets the display height.
`int`	`getHomeAddress()` Gets the host address index on the screen.
`Dimension`	`getInitialScreenSize()` Gets the initial screen size.
`int`	`getNewCharAttribute(int x, int y)` Gets the attribute to use for new characters in a field that contains extended attributes.
`long`	`getPhantomState()` Gets the Phantom-specific state of the display session, except for the connected and connecting flags that is handled in the HostSession class.
`int`	`getScreenLength()` Returns the screen length.
`Dimension`	`getScreenSize()` Gets the screen size.
`int`	`getWidth()` Gets the display width.
`boolean`	`insertChar(char c)` Inserts a displayable character at the current cursor position.
`boolean`	`insertChar(char c, boolean isSpecialChar)` Inserts a displayable character at the current cursor position.
`boolean`	`insertString(String str)` Inserts a string of data into the display at current position.
`boolean`	`isFieldFormatted()` Checks if this host screen is field formatted.
`boolean`	`isLocked()` Gets the current keyboard lock state.
`boolean`	`isNumeric(int x, int y)` Checks if a host field is numeric or not.
`void`	`lock(int state)` Locks the display.
`boolean`	`moveCursor(int addr)` Moves the cursor position to the specified address.
`boolean`	`moveCursor(int x, int y)` Moves the cursor position to the specified address.
`boolean`	`offsetCursor(int xo, int yo)` Offsets the cursor by a value in X/Y.
`void`	`refreshHostFields(HostFields fields)` Refreshes the host fields of the current session.
`boolean`	`resetKeyboard()` Unlocks the keyboard.
`boolean`	`resetKeyboard(boolean fromHost)` Unlocks the keyboard.
`void`	`setHostField(HostField hostField, String data, int[] attrs)` Sets a host field fully with text data and perhaps attributes (if these are non-null).
`void`	`setInitialSize()` Restore display size to initial size, e.g.
`void`	`setInitialSize(int c, int r)` Sets a new initial size and selects this new size.
`boolean`	`setInsertMode(boolean on)` Changes the insert mode.
`void`	`setSSCPLU(boolean on)` Sets or clears the SSCP-LU data flag.
`boolean`	`setString(int x, int y, int offset, int length, String string)` Sets a displayable character string at the requested position, without moving the cursor.
`void`	`setSystemDefaultSize()` Sets display in 80x24.
`boolean`	`toggleInsertMode()` Toggles insert mode.
`void`	`update()` Updates the character contents.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - aid
```
public final Display3270.Aid aid
```
    The Aid class instance.
  - STATE_SYSTEM
```
public static final int STATE_SYSTEM
```
    See Also:
    
    Constant Field Values
  - STATE_SENDING
```
public static final int STATE_SENDING
```
    See Also:
    
    Constant Field Values
  - STATE_WAITING
```
public static final int STATE_WAITING
```
    See Also:
    
    Constant Field Values
  - STATE_PROTECTED
```
public static final int STATE_PROTECTED
```
    See Also:
    
    Constant Field Values
  - STATE_FULL
```
public static final int STATE_FULL
```
    See Also:
    
    Constant Field Values
  - STATE_NUMERIC
```
public static final int STATE_NUMERIC
```
    See Also:
    
    Constant Field Values
  - ATTR_MODIFIED
```
public static final int ATTR_MODIFIED
```
    See Also:
    
    Constant Field Values
  - ATTR_RESERVED
```
public static final int ATTR_RESERVED
```
    See Also:
    
    Constant Field Values
  - ATTR_NONDISPLAY
```
public static final int ATTR_NONDISPLAY
```
    See Also:
    
    Constant Field Values
  - ATTR_INTENSITY
```
public static final int ATTR_INTENSITY
```
    See Also:
    
    Constant Field Values
  - ATTR_NUMERIC
```
public static final int ATTR_NUMERIC
```
    See Also:
    
    Constant Field Values
  - ATTR_PROTECTED
```
public static final int ATTR_PROTECTED
```
    See Also:
    
    Constant Field Values
  - ATTR_TRANSGRAPHIC0
```
public static final int ATTR_TRANSGRAPHIC0
```
    See Also:
    
    Constant Field Values
  - ATTR_TRANSGRAPHIC1
```
public static final int ATTR_TRANSGRAPHIC1
```
    See Also:
    
    Constant Field Values
  - ATTR_SHIFT_FORECOLOR
```
public static final int ATTR_SHIFT_FORECOLOR
```
    See Also:
    
    Constant Field Values
  - ATTR_SHIFT_BACKCOLOR
```
public static final int ATTR_SHIFT_BACKCOLOR
```
    See Also:
    
    Constant Field Values
  - ATTR_SHIFT_OUTLINE
```
public static final int ATTR_SHIFT_OUTLINE
```
    See Also:
    
    Constant Field Values
  - ATTR_SHIFT_HIGHLIGHT
```
public static final int ATTR_SHIFT_HIGHLIGHT
```
    See Also:
    
    Constant Field Values
  - ATTR_SHIFT_CHARSET
```
public static final int ATTR_SHIFT_CHARSET
```
    See Also:
    
    Constant Field Values
  - ATTR_MASK_FORECOLOR
```
public static final int ATTR_MASK_FORECOLOR
```
    See Also:
    
    Constant Field Values
  - ATTR_MASK_BACKCOLOR
```
public static final int ATTR_MASK_BACKCOLOR
```
    See Also:
    
    Constant Field Values
  - ATTR_MASK_OUTLINE
```
public static final int ATTR_MASK_OUTLINE
```
    See Also:
    
    Constant Field Values
  - ATTR_MASK_HIGHLIGHT
```
public static final int ATTR_MASK_HIGHLIGHT
```
    See Also:
    
    Constant Field Values
  - ATTR_MASK_CHARSET
```
public static final int ATTR_MASK_CHARSET
```
    See Also:
    
    Constant Field Values
  - ATTR_MASK_ALL_EXTENDED
```
public static final int ATTR_MASK_ALL_EXTENDED
```
    See Also:
    
    Constant Field Values
  - ATTR_MASK_ALL_EQUALIZE
```
public static final int ATTR_MASK_ALL_EQUALIZE
```
    See Also:
    
    Constant Field Values
  - ATTR_FLAG_FORECOLOR
```
public static final int ATTR_FLAG_FORECOLOR
```
    See Also:
    
    Constant Field Values
  - ATTR_FLAG_BACKCOLOR
```
public static final int ATTR_FLAG_BACKCOLOR
```
    See Also:
    
    Constant Field Values
  - ATTR_FLAG_OUTLINE
```
public static final int ATTR_FLAG_OUTLINE
```
    See Also:
    
    Constant Field Values
  - ATTR_FLAG_HIGHLIGHT
```
public static final int ATTR_FLAG_HIGHLIGHT
```
    See Also:
    
    Constant Field Values
  - ATTR_FLAG_CHARSET
```
public static final int ATTR_FLAG_CHARSET
```
    See Also:
    
    Constant Field Values
  - ATTR_FLAG_ALL_FLAGS
```
public static final int ATTR_FLAG_ALL_FLAGS
```
    See Also:
    
    Constant Field Values
  - ATTR_SPECIALCHAR
```
public static final int ATTR_SPECIALCHAR
```
    See Also:
    
    Constant Field Values
  - ATTR_GECHAR
```
public static final int ATTR_GECHAR
```
    See Also:
    
    Constant Field Values
  - ATTR_NEEDSUPDATE
```
public static final int ATTR_NEEDSUPDATE
```
    See Also:
    
    Constant Field Values
  - ATTR_MASK_ALL_EXTENDED_BITS
```
public static final int ATTR_MASK_ALL_EXTENDED_BITS
```
    The mask used to find out if a character or field attribute has extended properties, not including the GE character, the special character and the needs update flag.
    
    See Also:
    
    Constant Field Values
  - ATTR_HIGHLIGHT_BLINK
```
public static final int ATTR_HIGHLIGHT_BLINK
```
    See Also:
    
    Constant Field Values
  - ATTR_HIGHLIGHT_REVERSE
```
public static final int ATTR_HIGHLIGHT_REVERSE
```
    See Also:
    
    Constant Field Values
  - ATTR_HIGHLIGHT_UNDERLINE
```
public static final int ATTR_HIGHLIGHT_UNDERLINE
```
    See Also:
    
    Constant Field Values
  - ATTR_BASICMASK
```
public static final int ATTR_BASICMASK
```
    The basic attribute mask when getting the attribute to send it to host. Removed are ATTR_RESERVED (also ATTR_SPECIALCHAR), ATTR_NEEDSUPDATE and ATTR_CHARATTR_SET.
    
    See Also:
    
    Constant Field Values
  - ATTR_EXTENDEDCOLORMASK
```
public static final int ATTR_EXTENDEDCOLORMASK
```
    The mask used to find out if a character or field attribute has extended color properties.
    
    See Also:
    
    Constant Field Values
  - ASCII_FA
```
public static final char ASCII_FA
```
    Special ASCII code: Field Attribute.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Display3270
```
public Display3270(HostSession3270 h,
                   int cols,
                   int rows)
```
    Creates the display of the specified size.
- Method Detail
  - convertCharToEBCDIC
```
public byte convertCharToEBCDIC(char c)
```
    Converts a single character to EBCDIC byte.
  - setInsertMode
```
public boolean setInsertMode(boolean on)
```
    Changes the insert mode.
  - toggleInsertMode
```
public boolean toggleInsertMode()
```
    Toggles insert mode.
  - isLocked
```
public boolean isLocked()
```
    Gets the current keyboard lock state.
  - lock
```
public void lock(int state)
```
    Locks the display.
  - resetKeyboard
```
public boolean resetKeyboard()
```
    Unlocks the keyboard.
  - resetKeyboard
```
public boolean resetKeyboard(boolean fromHost)
```
    Unlocks the keyboard.
  - setSSCPLU
```
public void setSSCPLU(boolean on)
```
    Sets or clears the SSCP-LU data flag.
  - getPhantomState
```
public long getPhantomState()
```
    Gets the Phantom-specific state of the display session, except for the connected and connecting flags that is handled in the HostSession class.
  - getScreenSize
```
public Dimension getScreenSize()
```
    Gets the screen size.
  - getWidth
```
public int getWidth()
```
    Gets the display width.
  - getHeight
```
public int getHeight()
```
    Gets the display height.
  - getInitialScreenSize
```
public Dimension getInitialScreenSize()
```
    Gets the initial screen size.
  - getScreenLength
```
public int getScreenLength()
```
    Returns the screen length.
  - setSystemDefaultSize
```
public void setSystemDefaultSize()
```
    Sets display in 80x24.
  - setInitialSize
```
public void setInitialSize()
```
    Restore display size to initial size, e.g. to 80x32.
  - setInitialSize
```
public void setInitialSize(int c,
                           int r)
```
    Sets a new initial size and selects this new size.
  - getDisplayData
```
public char[] getDisplayData()
```
    Gets the display data.
  - getDisplayAttr
```
public int[] getDisplayAttr()
```
    Gets the display attributes.
  - getCharactersAndAttributes
```
public void getCharactersAndAttributes(char[] chars,
                                       int[] attrbs,
                                       int beginPos,
                                       int endPos)
```
    Gets the characters and attributes between two positions, including the end position.
  - getCharactersAndAttributes
```
public void getCharactersAndAttributes(char[] chars,
                                       int[] attrbs,
                                       int beginPos,
                                       int endPos,
                                       char fieldOrNullChar)
```
    Gets the characters and attributes between two positions, including the end position.
  - getNewCharAttribute
```
public int getNewCharAttribute(int x,
                               int y)
```
    Gets the attribute to use for new characters in a field that contains extended attributes.
  - doesFieldHaveExtendedAttributes
```
public boolean doesFieldHaveExtendedAttributes(HostField hostField)
```
    Checks if a host field has extended attributes or not. 5250 never has, but 3270 could have, e.g. special highlighting.
  - isFieldFormatted
```
public boolean isFieldFormatted()
```
    Checks if this host screen is field formatted.
  - update
```
public void update()
```
    Updates the character contents.
  - getFieldAttribute
```
public int getFieldAttribute(int addr)
```
    Gets the "new character" 3270 host attribute.
  - clearScreen
```
public void clearScreen()
```
    Clears the presentation space.
  - delete
```
public boolean delete()
```
    Deletes a character at the cursor position.
  - eraseInput
```
public boolean eraseInput()
```
    Clears all input capable fields.
  - eraseEOF
```
public boolean eraseEOF()
```
    Deletes all characters in the current field from the current cursor position to end of line. If this is done in the beginning of the field, the field MDT bit is reset.
  - insertChar
```
public boolean insertChar(char c)
```
    Inserts a displayable character at the current cursor position.
  - insertChar
```
public boolean insertChar(char c,
                          boolean isSpecialChar)
```
    Inserts a displayable character at the current cursor position. If the flag "isSpecialChar" is true, only the characters "substitute character" (0x3F), "duplicate" (0x1C), "field mark" (0x1E) and "eight ones" (0xFF) are allowed.
  - setString
```
public boolean setString(int x,
                         int y,
                         int offset,
                         int length,
                         String string)
```
    Sets a displayable character string at the requested position, without moving the cursor. The string is wrapped on line and screen basis if required.
  - insertString
```
public boolean insertString(String str)
```
    Inserts a string of data into the display at current position. The method will fail as soon as a call to insertChar fails.
    
    See Also:
    
    insertChar(char)
  - destructiveBackSpace
```
public boolean destructiveBackSpace()
```
    Performs a destructive backspace.
  - setHostField
```
public void setHostField(HostField hostField,
                         String data,
                         int[] attrs)
```
    Sets a host field fully with text data and perhaps attributes (if these are non-null).
  - refreshHostFields
```
public void refreshHostFields(HostFields fields)
```
    Refreshes the host fields of the current session. The host session will add all available host fields sorted left to right, top to bottom.
  - isNumeric
```
public boolean isNumeric(int x,
                         int y)
```
    Checks if a host field is numeric or not.
  - getCursorAddress
```
public int getCursorAddress()
```
    Gets the cursor position.
  - getCursorPosition
```
public Point getCursorPosition()
```
    Gets the cursor position.
  - moveCursor
```
public boolean moveCursor(int addr)
```
    Moves the cursor position to the specified address.
  - moveCursor
```
public boolean moveCursor(int x,
                          int y)
```
    Moves the cursor position to the specified address.
  - offsetCursor
```
public boolean offsetCursor(int xo,
                            int yo)
```
    Offsets the cursor by a value in X/Y. This is used by cursor left/right/up/down as well as their "fast" options (*3).
  - cursorTab
```
public boolean cursorTab()
```
    Moves the cursor to the next field.
  - cursorBacktab
```
public boolean cursorBacktab()
```
    Back-tabs the cursor.
  - cursorHome
```
public boolean cursorHome()
```
    Moves the cursor to the first unprotected field.
  - getHomeAddress
```
public int getHomeAddress()
```
    Gets the host address index on the screen.
    
    Returns:
    
    -1 if none is available.
  - cursorEnd
```
public boolean cursorEnd()
```
    Moves the cursor to the end of the field.
  - cursorNewLine
```
public boolean cursorNewLine()
```
    Moves cursor to a new line.
  - getEnteredData
```
public int getEnteredData(short[] buf)
```
    Gets the user entered data in the buffer, returning the length. Only modified characters are returned.

Class Display3270

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

aid

STATE_SYSTEM

STATE_SENDING

STATE_WAITING

STATE_PROTECTED

STATE_FULL

STATE_NUMERIC

ATTR_MODIFIED

ATTR_RESERVED

ATTR_NONDISPLAY

ATTR_INTENSITY

ATTR_NUMERIC

ATTR_PROTECTED

ATTR_TRANSGRAPHIC0

ATTR_TRANSGRAPHIC1

ATTR_SHIFT_FORECOLOR

ATTR_SHIFT_BACKCOLOR

ATTR_SHIFT_OUTLINE

ATTR_SHIFT_HIGHLIGHT

ATTR_SHIFT_CHARSET

ATTR_MASK_FORECOLOR

ATTR_MASK_BACKCOLOR

ATTR_MASK_OUTLINE

ATTR_MASK_HIGHLIGHT

ATTR_MASK_CHARSET

ATTR_MASK_ALL_EXTENDED

ATTR_MASK_ALL_EQUALIZE

ATTR_FLAG_FORECOLOR

ATTR_FLAG_BACKCOLOR

ATTR_FLAG_OUTLINE

ATTR_FLAG_HIGHLIGHT

ATTR_FLAG_CHARSET

ATTR_FLAG_ALL_FLAGS

ATTR_SPECIALCHAR

ATTR_GECHAR

ATTR_NEEDSUPDATE

ATTR_MASK_ALL_EXTENDED_BITS

ATTR_HIGHLIGHT_BLINK

ATTR_HIGHLIGHT_REVERSE

ATTR_HIGHLIGHT_UNDERLINE

ATTR_BASICMASK

ATTR_EXTENDEDCOLORMASK

ASCII_FA

Constructor Detail

Display3270

Method Detail

convertCharToEBCDIC

setInsertMode

toggleInsertMode

isLocked

lock

resetKeyboard

resetKeyboard

setSSCPLU

getPhantomState

getScreenSize

getWidth

getHeight

getInitialScreenSize

getScreenLength

setSystemDefaultSize

setInitialSize

setInitialSize

getDisplayData

getDisplayAttr

getCharactersAndAttributes

getCharactersAndAttributes

getNewCharAttribute

doesFieldHaveExtendedAttributes

isFieldFormatted

update

getFieldAttribute

clearScreen