se.entra.phantom.rapp

Class RAPPHostScreen

java.lang.Object

se.entra.phantom.rapp.RAPPHostScreen

All Implemented Interfaces:

RAPPHostReply

public class RAPPHostScreen
extends Object
implements RAPPHostReply

This class is used to handle the reply of a host screen for the callHost action.

See Also:

RAPPCallHost.getScreen()

Field Summary

Fields

Modifier and Type	Field and Description
static String	hexes The Hex characters "0123456789abcdef".

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RAPPHostScreen() Creates a new instance of the Host Screen.
	RAPPHostScreen(int width, int height, int cursorColumn, int cursorRow, String screenName, String fieldName, int fieldColumnIndex, int fieldRowIndex, String screenData, byte[] screenColors) Constructor used by the server to create an initialized instance of the host screen.

Method Summary

Modifier and Type	Method and Description
static byte[]	fromHex(String hexString) Converts a hex string to a byte array.
int	getCursorColumn() Gets the cursor column position (zero-based).
int	getCursorRow() Gets the cursor row position (zero-based).
int	getFieldColumnIndex() Gets the column index where the cursor is located inside the current field name (-1 if not inside or no current field name exist).
String	getFieldName() Gets the current field name where cursor is located inside (or null for no screen match or not inside a field).
int	getFieldRowIndex() Gets the row index where the cursor is located inside the current field name (-1 if not inside or no current field name exist).
int	getHeight() Gets the height of the screen (24, 27, 32 or 43 where 32 and 43 only applies to 3270).
byte[]	getScreenColors() Gets the screen color data, or null for none.
String	getScreenData() Gets the screen character data, or null for none.
String	getScreenName() Gets the current screen name (or null if none or more are matching).
int	getWidth() Gets the screen width (80 or 132).
void	serializeFromReply(RAPPElement reply) Initializes the action class instance from a reply element.
void	serializeToReply(RAPPElement reply) Initializes the reply Element with all attributes.
static String	toHex(byte[] bytes) Converts a byte array to a hex string.
String	toString() Converts this class into a string for testing purposes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

hexes

public static final String hexes

The Hex characters "0123456789abcdef".

See Also:

Constant Field Values

Constructor Detail

RAPPHostScreen

protected RAPPHostScreen()

Creates a new instance of the Host Screen. This method is used for XML serialization only.

RAPPHostScreen

public RAPPHostScreen(int width,
                      int height,
                      int cursorColumn,
                      int cursorRow,
                      String screenName,
                      String fieldName,
                      int fieldColumnIndex,
                      int fieldRowIndex,
                      String screenData,
                      byte[] screenColors)

Constructor used by the server to create an initialized instance of the host screen.

Method Detail

toHex

public static String toHex(byte[] bytes)

Converts a byte array to a hex string.

fromHex

public static byte[] fromHex(String hexString)
                      throws SAXException

Converts a hex string to a byte array.

Throws:

SAXException - for errors in the hex string.

getWidth

public int getWidth()

Gets the screen width (80 or 132).

getHeight

public int getHeight()

Gets the height of the screen (24, 27, 32 or 43 where 32 and 43 only applies to 3270).

getCursorRow

public int getCursorRow()

Gets the cursor row position (zero-based).

getCursorColumn

public int getCursorColumn()

Gets the cursor column position (zero-based).

getScreenName

public String getScreenName()

Gets the current screen name (or null if none or more are matching).

getFieldName

public String getFieldName()

Gets the current field name where cursor is located inside (or null for no screen match or not inside a field).

getFieldRowIndex

public int getFieldRowIndex()

Gets the row index where the cursor is located inside the current field name (-1 if not inside or no current field name exist).

getFieldColumnIndex

public int getFieldColumnIndex()

Gets the column index where the cursor is located inside the current field name (-1 if not inside or no current field name exist).

getScreenData

public String getScreenData()

Gets the screen character data, or null for none. The data has the length "width * length".

getScreenColors

public byte[] getScreenColors()

Gets the screen color data, or null for none. The data has the length "width * length".

serializeToReply

public void serializeToReply(RAPPElement reply)

Initializes the reply Element with all attributes.

The XML for the node looks like (replace parenthesis with less-more-than signs):

  (callHostReply action="hostScreen"/)
    (hostScreen
      width            = "80"
      height           = "24"
      cursorRow        = "12"
      cursorColumn     = "47"
    [ screenName       = "SCREENID"  ]
    [ fieldName        = "FLDNAME"   ]
    [ fieldRowIndex    = "2"         ]
    [ fieldColumnIndex = "12"        ]
    [ screenData       = "wrappedScreenData"
      screenColors     = "hexString" ] /)
  (/callHostReply)
 

Specified by:

serializeToReply in interface RAPPHostReply

See Also:

RAPPHostCell, RAPPHostCells, RAPPHostScreen

serializeFromReply

public void serializeFromReply(RAPPElement reply)
                        throws SAXException

Initializes the action class instance from a reply element.

Specified by:

serializeFromReply in interface RAPPHostReply

Throws:

SAXException - for errors in the document.

toString

public String toString()

Converts this class into a string for testing purposes.

Overrides:

toString in class Object