PhantomHostScreen (NetPhantom(R) 5.5 Java API documentation)

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

```
public class PhantomHostScreen
extends Object
```
This class contains the Phantom Host screen definition and the host fields.

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`height` The height of the screen (if pop-up window, smaller that "real" screen).
`boolean`	`isPopup` If this flag is set, the screen is floating, i.e.
`String`	`name` The name of the screen.
`int`	`width` The width of the screen (if pop-up window, smaller that "real" screen).

Constructor Summary

Constructors
Constructor and Description
`PhantomHostScreen(int width, int height, boolean isPopup)` Creates a new host screen for Gui-on-the-fly without host fields.
`PhantomHostScreen(String name, int width, int height, boolean isPopup)` Creates a new host screen for the editor.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`add(PhantomHostScreenIdentification newIdentification)` Add a new screen identification.
`void`	`addHostField(PhantomHostField field)` Adds a new host field for Gui-on-the-fly.
`boolean`	`constrainPopup(HostPopupWindow.Rect rect, HostScreen hostScreen, VirtualSessionManager vsm)` Constrain the the host screen definition according to the rectangle.
`PhantomHostScreen`	`createCopy()` Create a copy of this object.
`boolean`	`equalsGuiOnTheFly(PhantomHostScreen s)` Checks if two screens are equal to one another using the Gui-on-the-fly value calculated when it was created.
`int`	`findMatchingPopup(HostScreen screen)` Finds the rectangle of the pop-up that matches the host screen.
`int`	`findPopup(HostScreen screen)` Finds the rectangle of the pop-up on the screen.
`String`	`getFastSearchMatchString()` Gets the fast search string.
`int`	`getHeight()` Gets the height of this screen.
`PhantomHostField`	`getHostField(String fieldName)` Gets a host field by name.
`PhantomHostFieldLocation`	`getHostFieldFromPosition(int x, int y)` Gets the current host field from a cursor position.
`PhantomHostField[]`	`getHostFields()` Gets the host fields of the host screen.
`Hashtable<String,PhantomHostField>`	`getHostFieldsByName()` Gets a hash table of host fields sorted by key = name.
`PhantomHostScreenIdentification[]`	`getIdentifications()` Gets the identifications of the screen.
`int`	`getIndex()` Gets the index of this screen in the screen array.
`String`	`getName()` Get the name of the host screen.
`Vector<PhantomHostScreenIdentification>`	`getUnmatchingIdentifications(HostScreen hs, int xOffset, int yOffset)` Gets the identifications of the screen that do not match the indicated host screen.
`int`	`getWidth()` Gets the width of this screen.
`boolean`	`hasConstrainPopup()` Check if this host screen definition has any pop-up constraints.
`boolean`	`isPopup()` Checks if this screen is of pop-up window type.
`boolean`	`isScreenMatching(HostScreen screen, int xOffset, int yOffset)` Checks if this screen matches the current host screen.
`boolean`	`isScreenMatchingLax(HostScreen screen, int xOffset, int yOffset)` Checks if this screen matches the current host screen.
`boolean`	`remove(PhantomHostField hf)` Removes a field definition.
`boolean`	`remove(String name)` Removes a field definition.
`void`	`removeFieldDefinitions()` Removes the field definitions of the screen.
`void`	`removeIdentification(PhantomHostScreenIdentification id)` Removes the identifications of the screen.
`void`	`removeIdentifications()` Removes the identifications of the screen.
`void`	`saveHostFields(PhantomOutputFile file)` Saves the host fields.
`void`	`unconstrainPopup()` Remove all pop-up constraints.

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

- Field Detail
  - name
```
public String name
```
    The name of the screen.
  - isPopup
```
public boolean isPopup
```
    If this flag is set, the screen is floating, i.e. a host pop-up window.
  - height
```
public int height
```
    The height of the screen (if pop-up window, smaller that "real" screen).
  - width
```
public int width
```
    The width of the screen (if pop-up window, smaller that "real" screen).
- Constructor Detail
  - PhantomHostScreen
```
public PhantomHostScreen(int width,
                 int height,
                 boolean isPopup)
```
    Creates a new host screen for Gui-on-the-fly without host fields. Use the method addHostField in order to create requested fields.
    
    See Also:
    addHostField(se.entra.phantom.server.PhantomHostField)
  - PhantomHostScreen
```
public PhantomHostScreen(String name,
                 int width,
                 int height,
                 boolean isPopup)
```
    Creates a new host screen for the editor.
- Method Detail
  - addHostField
```
public void addHostField(PhantomHostField field)
```
    Adds a new host field for Gui-on-the-fly.
  - add
```
public boolean add(PhantomHostScreenIdentification newIdentification)
```
    Add a new screen identification.
    
    Parameters:
    PhantomHostScreenIdentification -
    
    Returns:
    boolean - successful or not
  - createCopy
```
public PhantomHostScreen createCopy()
```
    Create a copy of this object.
    
    Returns:
    PhantomHostScreen
  - equalsGuiOnTheFly
```
public boolean equalsGuiOnTheFly(PhantomHostScreen s)
```
    Checks if two screens are equal to one another using the Gui-on-the-fly value calculated when it was created.
  - saveHostFields
```
public void saveHostFields(PhantomOutputFile file)
                    throws IOException
```
    Saves the host fields.
    
    Parameters:
    file -
    
    Throws:
    
    IOException - if an I/O error occurs.
  - getHostFields
```
public PhantomHostField[] getHostFields()
```
    Gets the host fields of the host screen.
    
    Returns:
    null if none exists.
  - getName
```
public String getName()
```
    Get the name of the host screen.
  - isPopup
```
public boolean isPopup()
```
    Checks if this screen is of pop-up window type.
  - getWidth
```
public int getWidth()
```
    Gets the width of this screen.
  - getHeight
```
public int getHeight()
```
    Gets the height of this screen.
  - getIndex
```
public int getIndex()
```
    Gets the index of this screen in the screen array.
  - getHostField
```
public PhantomHostField getHostField(String fieldName)
```
    Gets a host field by name.
    
    Returns:
    null if field is not found.
  - getHostFieldsByName
```
public Hashtable<String,PhantomHostField> getHostFieldsByName()
```
    Gets a hash table of host fields sorted by key = name.
    
    Returns:
    null if field is not found.
  - getFastSearchMatchString
```
public String getFastSearchMatchString()
```
    Gets the fast search string. This string is the concatenation of all the exact rectangle contents identifications. It should always be ID_EXACT, otherwise there is an internal Phantom error in the algorithm, in the Editor or the Merge programs.
  - isScreenMatching
```
public boolean isScreenMatching(HostScreen screen,
                       int xOffset,
                       int yOffset)
```
    Checks if this screen matches the current host screen.
    
    Parameters:
    screen - - HostScreen
    int - - horizontal offset
    int - - vertical offset
    
    Returns:
    boolean
  - isScreenMatchingLax
```
public boolean isScreenMatchingLax(HostScreen screen,
                          int xOffset,
                          int yOffset)
```
    Checks if this screen matches the current host screen. Note: this check does not include checking pop-up constraints.
    
    Parameters:
    screen - - HostScreen
    int - - horizontal offset
    int - - vertical offset
    
    Returns:
    boolean
  - findMatchingPopup
```
public int findMatchingPopup(HostScreen screen)
```
    Finds the rectangle of the pop-up that matches the host screen. Returns -1 no matching pop-up was found.
    
    Parameters:
    screen -
    
    Returns:
    int - index of the matching pop-up, -1 if not found
  - findPopup
```
public int findPopup(HostScreen screen)
```
    Finds the rectangle of the pop-up on the screen. The screen must match with the exception of pop-up constraints. Returns -1 no pop-up was found.
    
    Parameters:
    screen -
    
    Returns:
    int - index of the matching pop-up, -1 if not found
  - constrainPopup
```
public boolean constrainPopup(HostPopupWindow.Rect rect,
                     HostScreen hostScreen,
                     VirtualSessionManager vsm)
```
    Constrain the the host screen definition according to the rectangle.
    
    Parameters:
    screen -
    
    Returns:
    boolean - true = ok to proceed
  - unconstrainPopup
```
public void unconstrainPopup()
```
    Remove all pop-up constraints.
    
    Parameters:
    screen -
  - hasConstrainPopup
```
public boolean hasConstrainPopup()
```
    Check if this host screen definition has any pop-up constraints.
    
    Parameters:
    screen -
    
    Returns:
    int - index of the matching pop-up, -1 if not found
  - removeIdentifications
```
public void removeIdentifications()
```
    Removes the identifications of the screen.
  - removeIdentification
```
public void removeIdentification(PhantomHostScreenIdentification id)
```
    Removes the identifications of the screen.
    
    Parameters:
    PhantomHostScreenIdentification -
  - removeFieldDefinitions
```
public void removeFieldDefinitions()
```
    Removes the field definitions of the screen.
  - remove
```
public boolean remove(PhantomHostField hf)
```
    Removes a field definition.
  - remove
```
public boolean remove(String name)
```
    Removes a field definition.
  - getIdentifications
```
public PhantomHostScreenIdentification[] getIdentifications()
```
    Gets the identifications of the screen.
  - getUnmatchingIdentifications
```
public Vector<PhantomHostScreenIdentification> getUnmatchingIdentifications(HostScreen hs,
                                                                   int xOffset,
                                                                   int yOffset)
```
    Gets the identifications of the screen that do not match the indicated host screen.
    
    Parameters:
    screen - - HostScreen
    int - - horizontal offset
    int - - vertical offset
    
    Returns:
    boolean
  - getHostFieldFromPosition
```
public PhantomHostFieldLocation getHostFieldFromPosition(int x,
                                                int y)
```
    Gets the current host field from a cursor position. The cursor position is relative to the PhantomHostScreen, i.e. if it's a host pop-up window, the offset for the pop-up window must be subtracted.
    
    Returns:
    null if not found.

Class PhantomHostScreen

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

isPopup

height

width

Constructor Detail

PhantomHostScreen

PhantomHostScreen

Method Detail

addHostField

add

createCopy

equalsGuiOnTheFly

saveHostFields

getHostFields

getName

isPopup

getWidth

getHeight

getIndex

getHostField

getHostFieldsByName

getFastSearchMatchString

isScreenMatching

isScreenMatchingLax

findMatchingPopup

findPopup

constrainPopup

unconstrainPopup

hasConstrainPopup

removeIdentifications

removeIdentification

removeFieldDefinitions

remove

remove

getIdentifications

getUnmatchingIdentifications

getHostFieldFromPosition