HostScreen (NetPhantom® 7.7 Java API Specification)

java.lang.Object
- se.entra.phantom.server.HostScreen

All Implemented Interfaces:

PaintInterface
```
public class HostScreen
extends Object
implements PaintInterface
```
This class does everything required for a host screen. There is just one host screen per client session, even if multiple host sessions exist.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ATTR_BLINK` Blink attribute.
`static int`	`ATTR_BOLD` Bold attribute.
`static int`	`ATTR_UNDERLINE` Underline attribute.
`static Color[]`	`cgaColors` The 16 CGA colors.

Constructor Summary

Constructors
Constructor and Description
`HostScreen(HostSessionManagerListener listener, Container terminalFrame, Container container, TerminalWindowListener mgr, String mw, String im, String ii, String caps, String num)` Creates a new screen of size 80 x 25.
`HostScreen(HostSessionManagerListener listener, JInternalFrame iframe, HostSessionManager mgr)` Creates a new screen of size 80 x 25.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addListener(ClientSession newListener)` Add an additional listener
`void`	`analyzePopupWindows()` Analyzes the host pop-up windows.
`void`	`appendScreen(Transaction t)` Adds the entire host screen definition in a transaction that will cause the client to display a new terminal window.
`boolean`	`appendScreenNoLock(Transaction t)` Adds the entire host screen definition in a transaction that will cause the client to display a new terminal window.
`void`	`clear()` Clears the entire screen.
`boolean`	`doesScreenMatch(PhantomHostScreen phantomScreen)` Checks if a host screen currently matches.
`Vector<Integer>`	`getAllPopupWindows()` Gets all the pop-up windows.
`char`	`getCharAbsolute(int pos)` Gets a character from a position.
`char`	`getCharAbsolute(int xx, int yy)` Gets a character from a X/Y position.
`char[]`	`getCharacters()` Gets the character data for the screen.
`int`	`getColorAbsolute(int pos)` Gets a CGA color from a position.
`int`	`getColorAbsolute(int xx, int yy)` Gets a CGA color from a position.
`int`	`getColorRelative(int xx, int yy)` Gets the CGA color from a relative position.
`Vector<Integer>`	`getContainingPopupWindows(HostPopupWindow.Rect rect)` Gets the pop-up windows that match (= contain, but is not identical) the indicated rectangle.
`HostPopupWindow.Rect`	`getCurrentPopupWindow()` Gets the current host pop-up window.
`int`	`getCurrentPopupWindowXOffset()` Gets the current offset in X for a pop-up window.
`int`	`getCurrentPopupWindowYOffset()` Gets the current offset in Y for a pop-up window.
`Point`	`getCursorAbsolute()` Gets the current absolute cursor position on the screen, without taking into account any current host pop-up window.
`Vector<Integer>`	`getCursorContainingPopupWindows()` Gets the pop-up windows that match (= contain) the current cursor position.
`Point`	`getCursorRelative()` Gets the current relative cursor position on the screen, taking into account any current host pop-up window.
`HostField`	`getFieldAbsolute(int pos)` Gets a host field from a position.
`HostField`	`getFieldAbsolute(int x, int y)` Gets the host field from a X/Y position.
`HostField`	`getFieldRelative(int x, int y)` Gets the host field from a X/Y position relative to the current pop-up window.
`HostFields`	`getFields()` Gets all the host fields.
`HostField`	`getFirstFieldAbsolute(int pos)` Gets the first host field from a position.
`HostField`	`getFirstFieldAbsolute(int x, int y)` Gets the first host field from a X/Y position.
`HostField`	`getFirstFieldRelative(int x, int y)` Gets the first host field from a X/Y position.
`int`	`getHeight()` Gets the height of the screen.
`String`	`getHiddenStringAbsolute(int xx, int yy, int length)` Gets a text string from host at an absolute position on the screen.
`String`	`getHiddenStringRelative(int xx, int yy, int length)` Gets a text string from host at a relative position.
`Object`	`getLockObject()` Gets the lock object for thread synchronization.
`HostPopupWindow.Rect`	`getPopupWindow(int index)` Gets a pop-up window.
`int`	`getPopupWindowCount()` Checks how many pop-up windows exist.
`String`	`getScreenChars()` Gets the entire screen, blanking out hidden characters and replacing box drawing characters (to +-\|) and null (to space).
`Dimension`	`getSize()` Gets the current screen size.
`String`	`getStringAbsolute(int xx, int yy, int length)` Gets a text string from host at an absolute position on the screen.
`String`	`getStringAbsolute(int xx, int yy, int length, boolean doGetHidden)` Gets a text string from host at an absolute position on the screen.
`String`	`getStringRelative(int xx, int yy, int length)` Gets a text string from host at a relative position.
`String`	`getStringRelative(int xx, int yy, int length, boolean doGetHidden)` Gets a text string from host at a relative position.
`TerminalWindow`	`getTerminalWindow()` Gets the terminal window (if in GUI mode, otherwise null).
`int`	`getWidth()` Gets the width of the screen.
`boolean`	`isEmpty()` Checks if all characters on the screen (except the last line) are spaces.
`boolean`	`isFieldFormatted()` Checks if this host screen is field formatted.
`static boolean`	`isHiddenTextDisplayed()` Checks if hidden characters are displayed for debugging purposes.
`char`	`mapBoxChar(char ch, int pos)` Routine to map special Unicode box drawing characters to printable Ansi "+-\|" characters.
`void`	`onHostScreenChange(HostSession hostSession, int beginPos, int endPos)` Gets new character and attribute data from the host session.
`void`	`paint(Graphics g, TerminalWindow tw, int leftMargin, int topMargin, int cxFont, int cyFont)` Paints the emulator window.
`void`	`removeListener(ClientSession oldListener)` Remove the additional listener
`void`	`repaint()` This method is to be called whenever the host fields and/or the host pop-up windows have changed.
`void`	`setCurrentPopupWindow(int index)` Sets the current pop-up window.
`void`	`setCursor(int x, int y)` Changes cursor position.
`void`	`setSize(int cx, int cy)` Sets the current screen size.
`void`	`writeString(int x, int y, String s, int attr)` Writes a text string at a position.

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

- Field Detail
  - ATTR_BOLD
```
public static final int ATTR_BOLD
```
    Bold attribute.
    
    See Also:
    
    Constant Field Values
  - ATTR_BLINK
```
public static final int ATTR_BLINK
```
    Blink attribute.
    
    See Also:
    
    Constant Field Values
  - ATTR_UNDERLINE
```
public static final int ATTR_UNDERLINE
```
    Underline attribute.
    
    See Also:
    
    Constant Field Values
  - cgaColors
```
public static Color[] cgaColors
```
    The 16 CGA colors.
- Constructor Detail
  - HostScreen
```
public HostScreen(HostSessionManagerListener listener,
                  JInternalFrame iframe,
                  HostSessionManager mgr)
```
    Creates a new screen of size 80 x 25.
  - HostScreen
```
public HostScreen(HostSessionManagerListener listener,
                  Container terminalFrame,
                  Container container,
                  TerminalWindowListener mgr,
                  String mw,
                  String im,
                  String ii,
                  String caps,
                  String num)
```
    Creates a new screen of size 80 x 25.
- Method Detail
  - isHiddenTextDisplayed
```
public static boolean isHiddenTextDisplayed()
```
    Checks if hidden characters are displayed for debugging purposes.
  - addListener
```
public void addListener(ClientSession newListener)
```
    Add an additional listener
    
    Parameters:
    
    newListener -
  - removeListener
```
public void removeListener(ClientSession oldListener)
```
    Remove the additional listener
    
    Parameters:
    
    oldListener -
  - getLockObject
```
public Object getLockObject()
```
    Gets the lock object for thread synchronization.
  - paint
```
public void paint(Graphics g,
                  TerminalWindow tw,
                  int leftMargin,
                  int topMargin,
                  int cxFont,
                  int cyFont)
```
    Paints the emulator window.
    
    Specified by:
    
    paint in interface PaintInterface
  - repaint
```
public void repaint()
```
    This method is to be called whenever the host fields and/or the host pop-up windows have changed. This is used for debug/tracing purposes and is only used with the GUI mode of the server.
  - clear
```
public void clear()
```
    Clears the entire screen.
  - analyzePopupWindows
```
public void analyzePopupWindows()
```
    Analyzes the host pop-up windows.
  - getPopupWindowCount
```
public int getPopupWindowCount()
```
    Checks how many pop-up windows exist.
  - getPopupWindow
```
public HostPopupWindow.Rect getPopupWindow(int index)
```
    Gets a pop-up window.
    
    Returns:
    
    null if the index is invalid.
  - getCursorContainingPopupWindows
```
public Vector<Integer> getCursorContainingPopupWindows()
```
    Gets the pop-up windows that match (= contain) the current cursor position.
    
    Returns:
    
    Vector of Integers.
  - getContainingPopupWindows
```
public Vector<Integer> getContainingPopupWindows(HostPopupWindow.Rect rect)
```
    Gets the pop-up windows that match (= contain, but is not identical) the indicated rectangle.
    
    Returns:
    
    Vector of Integers.
  - getAllPopupWindows
```
public Vector<Integer> getAllPopupWindows()
```
    Gets all the pop-up windows.
    
    Returns:
    
    Vector of Integers.
  - getCurrentPopupWindowXOffset
```
public int getCurrentPopupWindowXOffset()
```
    Gets the current offset in X for a pop-up window.
  - getCurrentPopupWindowYOffset
```
public int getCurrentPopupWindowYOffset()
```
    Gets the current offset in Y for a pop-up window.
  - getCurrentPopupWindow
```
public HostPopupWindow.Rect getCurrentPopupWindow()
```
    Gets the current host pop-up window.
    
    Returns:
    
    null if none exists or none has been set.
  - setCurrentPopupWindow
```
public void setCurrentPopupWindow(int index)
```
    Sets the current pop-up window.
  - setSize
```
public void setSize(int cx,
                    int cy)
```
    Sets the current screen size.
  - setCursor
```
public void setCursor(int x,
                      int y)
```
    Changes cursor position.
  - writeString
```
public void writeString(int x,
                        int y,
                        String s,
                        int attr)
```
    Writes a text string at a position.
  - onHostScreenChange
```
public void onHostScreenChange(HostSession hostSession,
                               int beginPos,
                               int endPos)
```
    Gets new character and attribute data from the host session.
  - getSize
```
public final Dimension getSize()
```
    Gets the current screen size.
  - getCharacters
```
public char[] getCharacters()
```
    Gets the character data for the screen. This is mainly used by the screen identification process in order to be quicker.
    Note: While using the returned data, the host screen *must* be synchronized.
  - getWidth
```
public int getWidth()
```
    Gets the width of the screen.
  - getHeight
```
public int getHeight()
```
    Gets the height of the screen.
  - getFields
```
public HostFields getFields()
```
    Gets all the host fields.
  - isFieldFormatted
```
public boolean isFieldFormatted()
```
    Checks if this host screen is field formatted. This method is not like the one in HostSession, this one checks for presence of HostFields that the ClientSession has read from the HostSession when the worker thread has queued a host event. Use the HostSession method directly to see if any fields are present.
  - getFieldAbsolute
```
public HostField getFieldAbsolute(int pos)
```
    Gets a host field from a position.
    
    Returns:
    
    null if no host field exists in the position.
  - getFieldAbsolute
```
public HostField getFieldAbsolute(int x,
                                  int y)
```
    Gets the host field from a X/Y position.
    
    Returns:
    
    null if no host field exists in the position.
  - getFieldRelative
```
public HostField getFieldRelative(int x,
                                  int y)
```
    Gets the host field from a X/Y position relative to the current pop-up window.
    
    Returns:
    
    null if no host field exists in the position.
  - getFirstFieldAbsolute
```
public HostField getFirstFieldAbsolute(int pos)
```
    Gets the first host field from a position.
    
    Returns:
    
    null if no host field exists in the position.
  - getFirstFieldAbsolute
```
public HostField getFirstFieldAbsolute(int x,
                                       int y)
```
    Gets the first host field from a X/Y position.
    
    Returns:
    
    null if no host field exists in the position.
  - getFirstFieldRelative
```
public HostField getFirstFieldRelative(int x,
                                       int y)
```
    Gets the first host field from a X/Y position.
    
    Returns:
    
    null if no host field exists in the position.
  - getCharAbsolute
```
public char getCharAbsolute(int pos)
```
    Gets a character from a position.
  - getCharAbsolute
```
public char getCharAbsolute(int xx,
                            int yy)
```
    Gets a character from a X/Y position.
  - getColorAbsolute
```
public int getColorAbsolute(int pos)
```
    Gets a CGA color from a position.
  - getColorAbsolute
```
public int getColorAbsolute(int xx,
                            int yy)
```
    Gets a CGA color from a position.
  - getColorRelative
```
public int getColorRelative(int xx,
                            int yy)
```
    Gets the CGA color from a relative position.
  - getStringAbsolute
```
public String getStringAbsolute(int xx,
                                int yy,
                                int length)
```
    Gets a text string from host at an absolute position on the screen. No provision for host pop-up windows are made. The string returns blanks for hidden characters.
  - getStringAbsolute
```
public String getStringAbsolute(int xx,
                                int yy,
                                int length,
                                boolean doGetHidden)
```
    Gets a text string from host at an absolute position on the screen. No provision for host pop-up windows are made. The string returns blanks for hidden characters depending on the flag.
  - getHiddenStringAbsolute
```
public String getHiddenStringAbsolute(int xx,
                                      int yy,
                                      int length)
```
    Gets a text string from host at an absolute position on the screen. No provision for host pop-up windows are made.
  - getStringRelative
```
public String getStringRelative(int xx,
                                int yy,
                                int length)
```
    Gets a text string from host at a relative position. This position is relative to the current host pop-up window offset. The string returns blanks for hidden characters.
  - getStringRelative
```
public String getStringRelative(int xx,
                                int yy,
                                int length,
                                boolean doGetHidden)
```
    Gets a text string from host at a relative position. This position is relative to the current host pop-up window offset. The string returns blanks for hidden characters.
  - getHiddenStringRelative
```
public String getHiddenStringRelative(int xx,
                                      int yy,
                                      int length)
```
    Gets a text string from host at a relative position. This position is relative to the current host pop-up window offset. The string returns blanks for hidden characters.
  - isEmpty
```
public boolean isEmpty()
```
    Checks if all characters on the screen (except the last line) are spaces. This is useful during connect to a host session in order to inhibit all panel processing until the connection is done and has a non-empty screen.
  - getCursorAbsolute
```
public Point getCursorAbsolute()
```
    Gets the current absolute cursor position on the screen, without taking into account any current host pop-up window.
  - getCursorRelative
```
public Point getCursorRelative()
```
    Gets the current relative cursor position on the screen, taking into account any current host pop-up window. If no host pop-up window exists, the cursor position will be the same as the absolute cursor position.
  - appendScreen
```
public void appendScreen(Transaction t)
```
    Adds the entire host screen definition in a transaction that will cause the client to display a new terminal window.
  - appendScreenNoLock
```
public boolean appendScreenNoLock(Transaction t)
```
    Adds the entire host screen definition in a transaction that will cause the client to display a new terminal window.
  - doesScreenMatch
```
public boolean doesScreenMatch(PhantomHostScreen phantomScreen)
```
    Checks if a host screen currently matches.
  - getTerminalWindow
```
public TerminalWindow getTerminalWindow()
```
    Gets the terminal window (if in GUI mode, otherwise null).
  - mapBoxChar
```
public char mapBoxChar(char ch,
                       int pos)
```
    Routine to map special Unicode box drawing characters to printable Ansi "+-|" characters.
  - getScreenChars
```
public String getScreenChars()
```
    Gets the entire screen, blanking out hidden characters and replacing box drawing characters (to +-|) and null (to space).

Class HostScreen

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ATTR_BOLD

ATTR_BLINK

ATTR_UNDERLINE

cgaColors

Constructor Detail

HostScreen

HostScreen

Method Detail

isHiddenTextDisplayed

addListener

removeListener

getLockObject

paint

repaint

clear

analyzePopupWindows

getPopupWindowCount

getPopupWindow

getCursorContainingPopupWindows

getContainingPopupWindows

getAllPopupWindows

getCurrentPopupWindowXOffset

getCurrentPopupWindowYOffset

getCurrentPopupWindow

setCurrentPopupWindow

setSize

setCursor

writeString

onHostScreenChange

getSize

getCharacters

getWidth

getHeight

getFields

isFieldFormatted

getFieldAbsolute

getFieldAbsolute

getFieldRelative

getFirstFieldAbsolute

getFirstFieldAbsolute

getFirstFieldRelative

getCharAbsolute

getCharAbsolute

getColorAbsolute

getColorAbsolute

getColorRelative

getStringAbsolute

getStringAbsolute

getHiddenStringAbsolute

getStringRelative

getStringRelative

getHiddenStringRelative

isEmpty

getCursorAbsolute

getCursorRelative

appendScreen

appendScreenNoLock

doesScreenMatch

getTerminalWindow

mapBoxChar

getScreenChars