PhantomHostField (NetPhantom® 7.7 Java API Specification)

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

All Implemented Interfaces:

Comparable<PhantomHostField>
```
public class PhantomHostField
extends Object
implements Comparable<PhantomHostField>
```
This class contains the Phantom Host Field definitions. It loads its definitions from a ".PHE" file inside the runtime file.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ADJ_LEFT` Left adjust
`static int`	`ADJ_MASK` Adjust mask
`static int`	`ADJ_NONE` No adjust
`static int`	`ADJ_RIGHT` Right adjust
`PhantomHostFieldColumnCell[]`	`cells` An array holding a column of cells that forms a column in a listbox.
`char`	`filler` Host field filler.
`int`	`flags` Host field flags.
`static int`	`FORMAT_FIELDEXIT` Field exit flag
`static int`	`FORMAT_SNAP` Snap to real host field at runtime
`static int`	`FORMAT_STRIPBEGIN` Strip beginning of field
`static int`	`FORMAT_STRIPCUA` Strip CUA chars at end
`static int`	`FORMAT_STRIPEND` Strip end of field
`String`	`name` Host field name.
`PhantomHostField`	`nextContinuedField` Next host field if continued.
`PhantomHostField`	`nextNormalField` Next normal host field.
`PhantomHostScreen`	`phantomScreen` The Phantom Host Screen.
`int`	`type` Host field type.
`static int`	`TYPE_3270NUMERIC` 3270-Numeric type
`static int`	`TYPE_ALPHA` All chars allowed
`static int`	`TYPE_ALPHALIMITED` Upper/Lower ,.- and space
`static int`	`TYPE_CONTINUE` Continue from previous field
`static int`	`TYPE_MARKED` Marked field
`static int`	`TYPE_NUMERIC` Numeric only
`static int`	`TYPE_NUMERICOTHER` Numeric ,.+- and space
`static int`	`TYPE_OUTPUT` Output field
`static int`	`TYPE_SIGNNUMERIC` Numeric +-
`static String[]`	`TYPES` The type strings.

Constructor Summary

Constructors
Constructor and Description
`PhantomHostField(PhantomHostScreen phantomScreen, HostScreen screen, HostField field)` Creates a new Gui-on-the-fly host field for a specific host field.
`PhantomHostField(PhantomHostScreen phantomScreen, HostScreen screen, int x, int y, int length)` Creates a new Gui-on-the-fly host field for a specific host field.
`PhantomHostField(PhantomHostScreen phantomScreen, HostScreen screen, int x, int y, int cx, int cy)` GUI
`PhantomHostField(PhantomHostScreen phantomScreen, HostScreen screen, int x, int y, int cx, int cy, boolean is3270)` Constructs a host field definition from a real host field.
`PhantomHostField(PhantomHostScreen phantomScreen, PhantomFile file)` Loads the host field from the runtime file.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(PhantomHostField hf)` The compare method used to sort host fields by name.
`PhantomHostField`	`createCopy()` Creates a copy of this host field.
`PhantomHostField`	`createCopy(PhantomHostScreen hs)` Creates a copy of this host field.
`boolean`	`doesScreenMatch(HostScreen screen)` Checks if this host field belongs to a screen that is currently matching or not.
`boolean`	`doesScreenMatch(HostSession hostSession)` Checks if this host field belongs to a screen that is currently matching or not.
`boolean`	`equals(Object o)` Two host fields are identical, used by screen equals.
`int`	`getColor(HostScreen screen)` Gets the CGA color of this field.
`int`	`getColor(HostScreen screen, boolean isDynamic)` Gets the CGA color of this field.
`int`	`getColor(HostScreen screen, int line)` Gets the CGA color of a line in this field.
`int`	`getColor(HostScreen screen, int line, boolean doCheckMatch)` Gets the CGA color of a line in this field.
`int`	`getColor2(HostScreen screen, boolean doCheckMatch)` Gets the CGA color of this field.
`int`	`getColumnRelative()` Get this field column relative position.
`PhantomHostFieldLocation`	`getCursorPositionInField(int cursorX, int cursorY)` Checks if the cursor position in inside this host field.
`int`	`getCX()` Get the width.
`int`	`getCY()` Get the height.
`PhantomHostFieldColumnCell[]`	`getHiddenHostFieldColumn(HostSession hostSession)` Gets an array of all host field cells in a column.
`String`	`getHiddenHostString(HostScreen screen)` Gets the contents of this host field.
`String`	`getHiddenHostString(HostScreen screen, boolean isDynamic)` Gets the contents of this host field.
`String`	`getHiddenHostString(HostScreen screen, boolean isDynamic, boolean dontWrap)` Gets the contents of this host field.
`String`	`getHiddenHostString(HostScreen screen, int line)` Gets the contents of this host field.
`HostField`	`getHostField(HostScreen screen)` Gets the corresponding host field on the current host screen.
`HostField`	`getHostField(HostScreen screen, boolean isDynamic)` Gets the corresponding host field on the current host screen.
`HostField`	`getHostField(HostScreen screen, int line)` Gets the corresponding host field on the current host screen.
`PhantomHostFieldColumnCell[]`	`getHostFieldColumn(HostSession hostSession)` Gets an array of all host field cells in a column.
`PhantomHostFieldColumnCell[]`	`getHostFieldColumn(HostSession hostSession, boolean doGetHidden)` Gets an array of all host field cells in a column.
`String`	`getHostString(HostScreen screen)` Gets the contents of this host field.
`String`	`getHostString(HostScreen screen, boolean doGetHidden)` Gets the contents of this host field.
`String`	`getHostString(HostScreen screen, boolean doGetHidden, boolean isDynamic)` Gets the contents of this host field.
`String`	`getHostString(HostScreen screen, boolean doGetHidden, boolean isDynamic, boolean dontWrap, boolean doCheckMatch)` Gets the contents of this host field.
`String`	`getHostString(HostScreen screen, boolean doGetHidden, int line)` Gets the contents of this host field at a certain line.
`String`	`getHostString(HostScreen screen, boolean doGetHidden, int line, boolean doCheckMatch)` Gets the contents of this host field at a certain line.
`String`	`getHostString(HostScreen screen, int line)` Gets the contents of this host field.
`int`	`getLineCount()` Gets the line count in this host field.
`String`	`getName()` Gets the name of this host field.
`PhantomHostField`	`getNext()` Gets the next normal host field.
`ENPObject`	`getNPObject()` Gets a new NPObject for this screen identification.
`int`	`getRowRelative()` Get this field row relative position.
`int`	`getTotalWidth()` Get this field total width.
`int`	`getTotalWidth(HostScreen screen, boolean isDynamic)` Get this field total width.
`int`	`getTotalWidth(HostScreen screen, boolean isDynamic, boolean dontWrap)` Get this field total width.
`int`	`getType()` Gets the type of this host field.
`String`	`getTypeDescription()` Gets the type string for a field type.
`static String`	`getTypeDescription(int type)` Gets the type string for a field type.
`int`	`getWidth()` Get this field width.
`int`	`getWidth(int line)` Gets the with of a specific line in the host field.
`int`	`getX()` Get the horizontal position.
`int`	`getY()` Get the vertical position.
`boolean`	`hasHostFieldColumnChanged(PhantomHostFieldColumnCell[] oldCells)` Checks if the contents in the PhantomHostFieldColumnCells has changed.
`boolean`	`isContinuation()` Checks if this host field is a continuation part of the previous field.
`boolean`	`isContinued()` Checks if the field is continued.
`boolean`	`isScreenNonCurrentPopup()` Check if data is to be retrieved from this screen and it's not the current pop-up screen, rather a "main screen" behind, then methods fetching data using "relative" methods should use "absolute" ones instead.
`void`	`propagateNextNormalField(PhantomHostField f)` Propagates the next normal host field to all continued fields.
`void`	`save(PhantomOutputFile file)` Saves the host field from the runtime file.
`boolean`	`setCursor(HostSession hostSession)` Set cursor to the position of this field, first line.
`boolean`	`setCursor(HostSession hostSession, boolean isDynamic)` Set cursor to the position of this field, first line.
`boolean`	`setCursor(HostSession hostSession, int line)` Set cursor to the position of this field with line offset.
`boolean`	`setCursor(HostSession hostSession, int line, int charpos)` Set cursor to the position of this field with line offset and the character offset.
`void`	`setCX(int cx)` Set the width.
`void`	`setCY(int cy)` Set the height.
`boolean`	`setHostField(HostSession hostSession, String text)` Sets the corresponding host field on the current host screen to the specified string.
`boolean`	`setHostField(HostSession hostSession, String text, boolean isDynamic)` Sets the corresponding host field on the current host screen to the specified string.
`boolean`	`setHostField(HostSession hostSession, String text, int line)` Sets the corresponding host field on the current host screen to the specified string.
`void`	`setNextContinuedHostField(PhantomHostField next)` Sets the next continued host field.
`void`	`setNextNormalHostField(PhantomHostField next)` Sets the next normal host field.
`void`	`setX(int x)` Set the horizontal position.
`void`	`setY(int y)` Set the vertical position.
`void`	`updateGuiOnTheFlyValue(CRC32 crc32)` Updates a Gui-on-the-fly value with this host field's data.

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

- Field Detail
  - TYPE_CONTINUE
```
public static final int TYPE_CONTINUE
```
    Continue from previous field
    
    See Also:
    
    Constant Field Values
  - TYPE_ALPHA
```
public static final int TYPE_ALPHA
```
    All chars allowed
    
    See Also:
    
    Constant Field Values
  - TYPE_NUMERIC
```
public static final int TYPE_NUMERIC
```
    Numeric only
    
    See Also:
    
    Constant Field Values
  - TYPE_ALPHALIMITED
```
public static final int TYPE_ALPHALIMITED
```
    Upper/Lower ,.- and space
    
    See Also:
    
    Constant Field Values
  - TYPE_NUMERICOTHER
```
public static final int TYPE_NUMERICOTHER
```
    Numeric ,.+- and space
    
    See Also:
    
    Constant Field Values
  - TYPE_SIGNNUMERIC
```
public static final int TYPE_SIGNNUMERIC
```
    Numeric +-
    
    See Also:
    
    Constant Field Values
  - TYPE_3270NUMERIC
```
public static final int TYPE_3270NUMERIC
```
    3270-Numeric type
    
    See Also:
    
    Constant Field Values
  - TYPE_MARKED
```
public static final int TYPE_MARKED
```
    Marked field
    
    See Also:
    
    Constant Field Values
  - TYPE_OUTPUT
```
public static final int TYPE_OUTPUT
```
    Output field
    
    See Also:
    
    Constant Field Values
  - TYPES
```
public static final String[] TYPES
```
    The type strings.
  - ADJ_LEFT
```
public static final int ADJ_LEFT
```
    Left adjust
    
    See Also:
    
    Constant Field Values
  - ADJ_RIGHT
```
public static final int ADJ_RIGHT
```
    Right adjust
    
    See Also:
    
    Constant Field Values
  - ADJ_NONE
```
public static final int ADJ_NONE
```
    No adjust
    
    See Also:
    
    Constant Field Values
  - ADJ_MASK
```
public static final int ADJ_MASK
```
    Adjust mask
    
    See Also:
    
    Constant Field Values
  - FORMAT_FIELDEXIT
```
public static final int FORMAT_FIELDEXIT
```
    Field exit flag
    
    See Also:
    
    Constant Field Values
  - FORMAT_STRIPBEGIN
```
public static final int FORMAT_STRIPBEGIN
```
    Strip beginning of field
    
    See Also:
    
    Constant Field Values
  - FORMAT_STRIPEND
```
public static final int FORMAT_STRIPEND
```
    Strip end of field
    
    See Also:
    
    Constant Field Values
  - FORMAT_SNAP
```
public static final int FORMAT_SNAP
```
    Snap to real host field at runtime
    
    See Also:
    
    Constant Field Values
  - FORMAT_STRIPCUA
```
public static final int FORMAT_STRIPCUA
```
    Strip CUA chars at end
    
    See Also:
    
    Constant Field Values
  - phantomScreen
```
public PhantomHostScreen phantomScreen
```
    The Phantom Host Screen.
  - type
```
public int type
```
    Host field type.
  - flags
```
public int flags
```
    Host field flags.
  - filler
```
public char filler
```
    Host field filler.
  - name
```
public String name
```
    Host field name.
  - nextContinuedField
```
public PhantomHostField nextContinuedField
```
    Next host field if continued.
  - nextNormalField
```
public PhantomHostField nextNormalField
```
    Next normal host field.
  - cells
```
public PhantomHostFieldColumnCell[] cells
```
    An array holding a column of cells that forms a column in a listbox.
- Constructor Detail
  - PhantomHostField
```
public PhantomHostField(PhantomHostScreen phantomScreen,
                        PhantomFile file)
                 throws IOException
```
    Loads the host field from the runtime file.
```
  + Field name     BYTE [9]
  + X position     BYTE
  + Y position     BYTE
  + Width          BYTE
  + Height         BYTE
  + Type           BYTE
  + Flags          BYTE
  + Filler         BYTE
 
```
    Throws:
    
    IOException - if an I/O error occurs.
  - PhantomHostField
```
public PhantomHostField(PhantomHostScreen phantomScreen,
                        HostScreen screen,
                        HostField field)
```
    Creates a new Gui-on-the-fly host field for a specific host field. This method will automatically create all continued fields if the host field wraps over lines.
    When this new field is created, a CRC32 value is updated in order to establish if the host screen where this field is added to is equal to another.
  - PhantomHostField
```
public PhantomHostField(PhantomHostScreen phantomScreen,
                        HostScreen screen,
                        int x,
                        int y,
                        int length)
```
    Creates a new Gui-on-the-fly host field for a specific host field. This method will automatically create all continued fields if the host field wraps over lines.
    When this new field is created, a CRC32 value is updated in order to establish if the host screen where this field is added to is equal to another.
  - PhantomHostField
```
public PhantomHostField(PhantomHostScreen phantomScreen,
                        HostScreen screen,
                        int x,
                        int y,
                        int cx,
                        int cy,
                        boolean is3270)
```
    Constructs a host field definition from a real host field.
  - PhantomHostField
```
public PhantomHostField(PhantomHostScreen phantomScreen,
                        HostScreen screen,
                        int x,
                        int y,
                        int cx,
                        int cy)
```
    GUI
- Method Detail
  - getTypeDescription
```
public static String getTypeDescription(int type)
```
    Gets the type string for a field type.
  - createCopy
```
public PhantomHostField createCopy()
```
    Creates a copy of this host field.
  - createCopy
```
public PhantomHostField createCopy(PhantomHostScreen hs)
```
    Creates a copy of this host field.
  - updateGuiOnTheFlyValue
```
public void updateGuiOnTheFlyValue(CRC32 crc32)
```
    Updates a Gui-on-the-fly value with this host field's data. The data is field type, adjustment, position, size, etc...
  - propagateNextNormalField
```
public void propagateNextNormalField(PhantomHostField f)
```
    Propagates the next normal host field to all continued fields.
  - getName
```
public String getName()
```
    Gets the name of this host field.
  - getType
```
public int getType()
```
    Gets the type of this host field.
  - isContinuation
```
public boolean isContinuation()
```
    Checks if this host field is a continuation part of the previous field.
  - isContinued
```
public boolean isContinued()
```
    Checks if the field is continued.
  - setNextContinuedHostField
```
public void setNextContinuedHostField(PhantomHostField next)
```
    Sets the next continued host field. This method should not be called by anyone else than PhantomHostScreen.
  - setNextNormalHostField
```
public void setNextNormalHostField(PhantomHostField next)
```
    Sets the next normal host field. This method should not be called by anyone else than PhantomHostScreen.
  - getX
```
public int getX()
```
    Get the horizontal position.
    
    Returns:
    
    int
  - setX
```
public void setX(int x)
```
    Set the horizontal position.
    
    Parameters:
    
    x - new x value
  - getY
```
public int getY()
```
    Get the vertical position.
    
    Returns:
    
    int
  - setY
```
public void setY(int y)
```
    Set the vertical position.
    
    Parameters:
    
    y - new y value
  - getCX
```
public int getCX()
```
    Get the width.
    
    Returns:
    
    int
  - setCX
```
public void setCX(int cx)
```
    Set the width.
    
    Parameters:
    
    cx - new cx value
  - getCY
```
public int getCY()
```
    Get the height.
    
    Returns:
    
    int
  - setCY
```
public void setCY(int cy)
```
    Set the height.
    
    Parameters:
    
    cy - new cy value
  - getNext
```
public PhantomHostField getNext()
```
    Gets the next normal host field. If this host field is continued from a previous one, this method will return null.
    
    Returns:
    
    null if no more host fields exist.
  - getRowRelative
```
public int getRowRelative()
```
    Get this field row relative position.
  - getColumnRelative
```
public int getColumnRelative()
```
    Get this field column relative position.
  - getWidth
```
public int getWidth()
```
    Get this field width. Note: always returns the length of the first line in the host field, because we want to keep 100% compatible with old bugs.
  - getWidth
```
public int getWidth(int line)
```
    Gets the with of a specific line in the host field. If the index is negative, the total with is returned.
    
    Returns:
    
    -1 if not found, otherwise the width.
    
    See Also:
    
    getTotalWidth()
  - getTotalWidth
```
public int getTotalWidth()
```
    Get this field total width. If the field is continued or has multiple lines, the entire size is calculated. This size is mostly used for e.g. an entry field that is connected to a host field that wraps over the screen (and is therefore continued).
  - getTotalWidth
```
public int getTotalWidth(HostScreen screen,
                         boolean isDynamic)
```
    Get this field total width. If the field is continued or has multiple lines, the entire size is calculated. This size is mostly used for e.g. an entry field that is connected to a host field that wraps over the screen (and is therefore continued).
  - getTotalWidth
```
public int getTotalWidth(HostScreen screen,
                         boolean isDynamic,
                         boolean dontWrap)
```
    Get this field total width. If the field is continued or has multiple lines, the entire size is calculated. This size is mostly used for e.g. an entry field that is connected to a host field that wraps over the screen (and is therefore continued).
    The "dontWrap" flag is only valid when the flag "isDynamic" is true.
  - getLineCount
```
public int getLineCount()
```
    Gets the line count in this host field.
  - getHostString
```
public String getHostString(HostScreen screen)
```
    Gets the contents of this host field. Hidden characters are returned as spaces.
    
    Returns:
    
    null if the host field is not inside screen (because there has been a screen change).
  - getHostString
```
public String getHostString(HostScreen screen,
                            int line)
```
    Gets the contents of this host field. Hidden characters are returned as spaces.
    
    Returns:
    
    null if the host field is not inside screen (because there has been a screen change).
  - getHostString
```
public String getHostString(HostScreen screen,
                            boolean doGetHidden)
```
    Gets the contents of this host field.
    
    Returns:
    
    null if the host field is not inside screen (because there has been a screen change).
  - getHostString
```
public String getHostString(HostScreen screen,
                            boolean doGetHidden,
                            boolean isDynamic)
```
    Gets the contents of this host field.
    
    Returns:
    
    null if the host field is not inside screen (because there has been a screen change).
  - getHostString
```
public String getHostString(HostScreen screen,
                            boolean doGetHidden,
                            boolean isDynamic,
                            boolean dontWrap,
                            boolean doCheckMatch)
```
    Gets the contents of this host field.
    The "dontWrap" flag is only valid when "isDynamic" is true.
    
    Returns:
    
    null if the host field is not inside screen (because there has been a screen change).
  - getHostString
```
public String getHostString(HostScreen screen,
                            boolean doGetHidden,
                            int line)
```
    Gets the contents of this host field at a certain line.
    
    Returns:
    
    null if the host field is not inside screen (because there has been a screen change).
  - getHostString
```
public String getHostString(HostScreen screen,
                            boolean doGetHidden,
                            int line,
                            boolean doCheckMatch)
```
    Gets the contents of this host field at a certain line.
    
    Returns:
    
    null if the host field is not inside screen (because there has been a screen change).
  - getHiddenHostString
```
public String getHiddenHostString(HostScreen screen)
```
    Gets the contents of this host field.
    
    Returns:
    
    null if the host field is not inside screen (because there has been a screen change).
  - getHiddenHostString
```
public String getHiddenHostString(HostScreen screen,
                                  boolean isDynamic)
```
    Gets the contents of this host field.
    
    Returns:
    
    null if the host field is not inside screen (because there has been a screen change).
  - getHiddenHostString
```
public String getHiddenHostString(HostScreen screen,
                                  boolean isDynamic,
                                  boolean dontWrap)
```
    Gets the contents of this host field.
    The "dontWrap" flag is only valid when "isDynamic" is true.
    
    Returns:
    
    null if the host field is not inside screen (because there has been a screen change).
  - getHiddenHostString
```
public String getHiddenHostString(HostScreen screen,
                                  int line)
```
    Gets the contents of this host field.
    
    Returns:
    
    null if the host field is not inside screen (because there has been a screen change).
  - getColor
```
public int getColor(HostScreen screen)
```
    Gets the CGA color of this field.
    
    Returns:
    
    -1 if the host field is not inside screen (because there has been a screen change).
  - getColor2
```
public int getColor2(HostScreen screen,
                     boolean doCheckMatch)
```
    Gets the CGA color of this field.
    
    Returns:
    
    -1 if the host field is not inside screen (because there has been a screen change).
  - getColor
```
public int getColor(HostScreen screen,
                    boolean isDynamic)
```
    Gets the CGA color of this field.
    
    Returns:
    
    -1 if the host field is not inside screen (because there has been a screen change).
  - getColor
```
public int getColor(HostScreen screen,
                    int line)
```
    Gets the CGA color of a line in this field.
    
    Returns:
    
    -1 if the host field is not inside screen (because there has been a screen change).
  - getColor
```
public int getColor(HostScreen screen,
                    int line,
                    boolean doCheckMatch)
```
    Gets the CGA color of a line in this field.
    
    Returns:
    
    -1 if the host field is not inside screen (because there has been a screen change).
  - getHostField
```
public HostField getHostField(HostScreen screen)
```
    Gets the corresponding host field on the current host screen.
    
    Returns:
    
    null if the host field is not found. or if the host field is not inside screen (because there has been a screen change).
  - getHostField
```
public HostField getHostField(HostScreen screen,
                              boolean isDynamic)
```
    Gets the corresponding host field on the current host screen.
    
    Returns:
    
    null if the host field is not found. or if the host field is not inside screen (because there has been a screen change).
  - getHostField
```
public HostField getHostField(HostScreen screen,
                              int line)
```
    Gets the corresponding host field on the current host screen. The line number indicates the Y offset in the Phantom Host Field.
    
    Returns:
    
    null if the host field is not found. or if the host field is not inside screen (because there has been a screen change).
  - getHiddenHostFieldColumn
```
public PhantomHostFieldColumnCell[] getHiddenHostFieldColumn(HostSession hostSession)
```
    Gets an array of all host field cells in a column. This is typically used with list boxes and business graphics.
    
    Returns:
    
    null if the host session is not the current one.
  - getHostFieldColumn
```
public PhantomHostFieldColumnCell[] getHostFieldColumn(HostSession hostSession)
```
    Gets an array of all host field cells in a column. This is typically used with list boxes and business graphics.
    
    Returns:
    
    null if the host session is not the current one.
  - getHostFieldColumn
```
public PhantomHostFieldColumnCell[] getHostFieldColumn(HostSession hostSession,
                                                       boolean doGetHidden)
```
    Gets an array of all host field cells in a column. This is typically used with list boxes and business graphics.
    
    Returns:
    
    null if the host session is not the current one.
  - hasHostFieldColumnChanged
```
public boolean hasHostFieldColumnChanged(PhantomHostFieldColumnCell[] oldCells)
```
    Checks if the contents in the PhantomHostFieldColumnCells has changed.
    The check is done according to the following rules:
    If both the new and the old PhantomHostFieldColumnCells are null, then it is considered unchanged.
    If either one of the PhantomHostFieldColumnCells is null, but the other is not, then it has changed.
    If the length of the arrays are not equal, then it has changed.
    Finally a comparison is done between the individual data items in the new and the old PhantomHostFieldColumnCells.
    
    Parameters:
    
    oldCells - An array with the old PhantomHostFieldColumnCells to compare to.
    
    Returns:
    
    true if the contents has changed, false otherwise.
  - getCursorPositionInField
```
public PhantomHostFieldLocation getCursorPositionInField(int cursorX,
                                                         int cursorY)
```
    Checks if the cursor position in inside this host field. If so, an instance of the PhantomHostFieldLocation class is returned.
    Note: no checking is done if this screen matches the current host screen.
    Note: if it's a host pop-up window, the offset for the pop-up window must be subtracted.
    
    Returns:
    
    null if not found.
  - save
```
public void save(PhantomOutputFile file)
          throws IOException
```
    Saves the host field from the runtime file.
    
    Parameters:
    
    file -
    
    Throws:
    
    IOException - if an I/O error occurs.
  - setCursor
```
public boolean setCursor(HostSession hostSession,
                         int line)
```
    Set cursor to the position of this field with line offset. If line offset is larger than field height, search for continue field.
    
    Returns:
    
    false if cursor cannot be set or if line is invalid.
  - setCursor
```
public boolean setCursor(HostSession hostSession,
                         int line,
                         int charpos)
```
    Set cursor to the position of this field with line offset and the character offset. If line offset is larger than field height, search for continue field.
    
    Returns:
    
    false if cursor cannot be set or if line is invalid.
  - setCursor
```
public boolean setCursor(HostSession hostSession)
```
    Set cursor to the position of this field, first line.
    
    Returns:
    
    false if cursor cannot be set in the host session.
  - setCursor
```
public boolean setCursor(HostSession hostSession,
                         boolean isDynamic)
```
    Set cursor to the position of this field, first line.
    
    Returns:
    
    false if cursor cannot be set in the host session.
  - setHostField
```
public boolean setHostField(HostSession hostSession,
                            String text)
```
    Sets the corresponding host field on the current host screen to the specified string.
    
    Returns:
    
    false if the text couldn't be set, true otherwise.
  - setHostField
```
public boolean setHostField(HostSession hostSession,
                            String text,
                            boolean isDynamic)
```
    Sets the corresponding host field on the current host screen to the specified string.
    
    Returns:
    
    false if the text couldn't be set, true otherwise.
  - setHostField
```
public boolean setHostField(HostSession hostSession,
                            String text,
                            int line)
```
    Sets the corresponding host field on the current host screen to the specified string.
    The line number indicates the Y offset in the Phantom Host Field.
    
    Returns:
    
    false if the text couldn't be set or line is invalid, true otherwise.
  - doesScreenMatch
```
public boolean doesScreenMatch(HostSession hostSession)
```
    Checks if this host field belongs to a screen that is currently matching or not.
  - doesScreenMatch
```
public boolean doesScreenMatch(HostScreen screen)
```
    Checks if this host field belongs to a screen that is currently matching or not.
  - isScreenNonCurrentPopup
```
public boolean isScreenNonCurrentPopup()
```
    Check if data is to be retrieved from this screen and it's not the current pop-up screen, rather a "main screen" behind, then methods fetching data using "relative" methods should use "absolute" ones instead.
    Typically his would be used when e,g, REXX used HostGetFld('MAINSCREEN','SOMEFLD') and without this method it wouldn't work.
    
    Returns:
    
    true if this PhantomScreen is not a pop-up.
  - compareTo
```
public int compareTo(PhantomHostField hf)
```
    The compare method used to sort host fields by name.
    
    Specified by:
    
    compareTo in interface Comparable<PhantomHostField>
  - equals
```
public boolean equals(Object o)
```
    Two host fields are identical, used by screen equals.
    
    Overrides:
    
    equals in class Object
  - getTypeDescription
```
public String getTypeDescription()
```
    Gets the type string for a field type.
  - getNPObject
```
public ENPObject getNPObject()
```
    Gets a new NPObject for this screen identification.

Class PhantomHostField

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TYPE_CONTINUE

TYPE_ALPHA

TYPE_NUMERIC

TYPE_ALPHALIMITED

TYPE_NUMERICOTHER

TYPE_SIGNNUMERIC

TYPE_3270NUMERIC

TYPE_MARKED

TYPE_OUTPUT

TYPES

ADJ_LEFT

ADJ_RIGHT

ADJ_NONE

ADJ_MASK

FORMAT_FIELDEXIT

FORMAT_STRIPBEGIN

FORMAT_STRIPEND

FORMAT_SNAP

FORMAT_STRIPCUA

phantomScreen

type

flags

filler

name

nextContinuedField

nextNormalField

cells

Constructor Detail

PhantomHostField

PhantomHostField

PhantomHostField

PhantomHostField

PhantomHostField

Method Detail

getTypeDescription

createCopy

createCopy

updateGuiOnTheFlyValue

propagateNextNormalField

getName

getType

isContinuation

isContinued

setNextContinuedHostField

setNextNormalHostField

getX

setX

getY

setY

getCX

setCX

getCY

setCY

getNext

getRowRelative

getColumnRelative

getWidth

getWidth

getTotalWidth

getTotalWidth

getTotalWidth

getLineCount

getHostString

getHostString

getHostString

getHostString

getHostString

getHostString

getHostString

getHiddenHostString

getHiddenHostString

getHiddenHostString

getHiddenHostString

getColor