se.entra.phantom.rapp

Class RAPPHostCell

java.lang.Object

se.entra.phantom.rapp.RAPPHostCell

All Implemented Interfaces:

RAPPEnumerationItem, RAPPHostReply

public class RAPPHostCell
extends Object
implements RAPPEnumerationItem, RAPPHostReply

The host cell class is used to save information retrieved using the CallHost action. It contains detailed information regarding the host cell in question. A host cell is returned whenever a specific host field or a complete host field enumeration is requested.

The information for each host cell is:

• the name,
• the contents,
• length as defined in Phantom,
• length as the underlying host field defines,
• position on screen,
• position on host screen (different for host pop-up windows),
• starting position of the underlying host field,
• protected and hidden attributes,
• host color,
• index of the cell in the list (if inside a list-type field).

The class is intended form data exchange from the server to the client.

See the class RAPPCallHost for example.

See Also:

RAPPCallHost

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RAPPHostCell() Creates an empty host cell with no data initialized used for serializing data with XML documents.
	RAPPHostCell(String name, int length, int hostLength, int column, int hostColumn, int hostFieldColumn, int row, int hostRow, int hostFieldRow, boolean isProtected, boolean isHidden, int color, String value, int index) Creates a new host cell initialized with the information about it.

Method Summary

Modifier and Type	Method and Description
int	getBackgroundColor() Gets the background color.
int	getColor() Gets the combined fore- and background colors.
int	getColumn() Gets the column where the field starts on the screen of the Phantom Host Field definition (first column = 0).
int	getForegroundColor() Gets the foreground color.
int	getHostColumn() Gets the column where the terminal host field starts (first column = 0), host pop-up window taken into account.
int	getHostFieldColumn() Gets the column where the terminal "real" host field starts (first column = 0).
int	getHostFieldRow() Gets the row where the terminal "real" host field starts (first row = 0).
int	getHostLength() Gets the length of the terminal underlying host field where the field starts, host pop-up window taken into account.
int	getHostRow() Gets the row where the terminal host field starts (first row = 0), host pop-up window taken into account.
int	getIndex() The index of this cell in an enumeration of cells, -1 indicates a single field.
int	getLength() Gets the length of this cell in the Phantom Host Field definition.
String	getName() Gets the name of the host field.
int	getRow() Gets the row where the field starts on the screen of the Phantom Host Field definition (first row = 0).
String	getValue() The string contents of the host field, even if the field
boolean	isHidden() Gets the flag indicating if the underlying host field is hidden or not.
boolean	isProtected() Gets the flag indicating if the underlying host field is protected or not.
void	serializeFromDocument(RAPPElement reply, int index) Initializes the item class instance from a reply element in the enumeration.
void	serializeFromReply(RAPPElement reply) Initializes the host cell class instance from a reply element.
void	serializeToDocument(RAPPElement reply, int index) Initializes reply Element for the item in the enumeration.
void	serializeToReply(RAPPElement reply) Initializes the reply Element with all attributes.
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

Constructor Detail

RAPPHostCell

protected RAPPHostCell()

Creates an empty host cell with no data initialized used for serializing data with XML documents.

RAPPHostCell

public RAPPHostCell(String name,
                    int length,
                    int hostLength,
                    int column,
                    int hostColumn,
                    int hostFieldColumn,
                    int row,
                    int hostRow,
                    int hostFieldRow,
                    boolean isProtected,
                    boolean isHidden,
                    int color,
                    String value,
                    int index)

Creates a new host cell initialized with the information about it. This method is called from the server.

Method Detail

getName

public String getName()

Gets the name of the host field.

getLength

public int getLength()

Gets the length of this cell in the Phantom Host Field definition.

Note that host fields can wrap the screen both right-to-left and bottom-to-top.

getHostLength

public int getHostLength()

Gets the length of the terminal underlying host field where the field starts, host pop-up window taken into account. This length is not always the same as the Phantom Host Field length.

Note that host fields can wrap the screen both right-to-left and bottom-to-top.

getColumn

public int getColumn()

Gets the column where the field starts on the screen of the Phantom Host Field definition (first column = 0).

getHostColumn

public int getHostColumn()

Gets the column where the terminal host field starts (first column = 0), host pop-up window taken into account. This column is not always the same as the Phantom Host Field column.

getRow

public int getRow()

Gets the row where the field starts on the screen of the Phantom Host Field definition (first row = 0).

getHostRow

public int getHostRow()

Gets the row where the terminal host field starts (first row = 0), host pop-up window taken into account. This row is not always the same as the Phantom Host Field row.

getHostFieldColumn

public int getHostFieldColumn()

Gets the column where the terminal "real" host field starts (first column = 0). This column is not always the same as the Phantom Host Field column. Host pop-up windows are taken into account.

Note that host fields can wrap the screen both right-to-left and bottom-to-top.

getHostFieldRow

public int getHostFieldRow()

Gets the row where the terminal "real" host field starts (first row = 0). This row is not always the same as the Phantom Host Field row. Host pop-up windows are taken into account.

Note that host fields can wrap the screen both right-to-left and bottom-to-top.

isProtected

public boolean isProtected()

Gets the flag indicating if the underlying host field is protected or not.

isHidden

public boolean isHidden()

Gets the flag indicating if the underlying host field is hidden or not.

getForegroundColor

public int getForegroundColor()

Gets the foreground color.

The table below indicates the color values:

  0 = black
  1 = dark blue
  2 = dark green
  3 = dark cyan
  4 = dark red
  5 = dark pink
  6 = brown
  7 = pale gray
  8 = dark gray
  9 = blue
 10 = green
 11 = cyan
 12 = red
 13 = pink
 14 = yellow
 15 = white
 

getBackgroundColor

public int getBackgroundColor()

Gets the background color.

The table below indicates the color values:

  0 = black
  1 = dark blue
  2 = dark green
  3 = dark cyan
  4 = dark red
  5 = dark pink
  6 = brown
  7 = pale gray
  8 = dark gray
  9 = blue
 10 = green
 11 = cyan
 12 = red
 13 = pink
 14 = yellow
 15 = white
 

getColor

public int getColor()

Gets the combined fore- and background colors.

To extract the foreground color, use color & 0x0f.

To extract the background color, use ((color & 0xf0) >> 4).

getValue

public String getValue()

The string contents of the host field, even if the field

getIndex

public int getIndex()

The index of this cell in an enumeration of cells, -1 indicates a single field.

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):

  (hostCell
    name            = "FLDNAME"
    length          = "20"
  [ hostLength      = "78" ]
    column          = "28"
  [ hostColumn      = "1"  ]
  [ hostFieldColumn = "0"  ]
    row             = "10"
  [ hostRow         = "8"  ]
  [ hostFieldRow    = "8"  ]
    protected       = "true"
    hidden          = "false"
    color           = "7"
    value           = "Abraham Lincoln"
  [ index           = "12" ] /)
 

Specified by:

serializeToReply in interface RAPPHostReply

See Also:

RAPPHostCell, RAPPHostCells, RAPPHostScreen

serializeToDocument

public void serializeToDocument(RAPPElement reply,
                                int index)

Initializes reply Element for the item in the enumeration. The index parameter indicates the index in the enumeration of the element.

Specified by:

serializeToDocument in interface RAPPEnumerationItem

serializeFromReply

public void serializeFromReply(RAPPElement reply)
                        throws SAXException

Initializes the host cell class instance from a reply element.

Specified by:

serializeFromReply in interface RAPPHostReply

Throws:

SAXException - for errors in the document.

serializeFromDocument

public void serializeFromDocument(RAPPElement reply,
                                  int index)
                           throws SAXException

Initializes the item class instance from a reply element in the enumeration.

Specified by:

serializeFromDocument in interface RAPPEnumerationItem

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