PhantomHostScreenIdentification (NetPhantom® 7.7 Java API Specification)

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

All Implemented Interfaces:

Comparable<PhantomHostScreenIdentification>
```
public class PhantomHostScreenIdentification
extends Object
implements Comparable<PhantomHostScreenIdentification>
```
This class contains the Phantom Host Screen identification.

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`cx` Width of the identifier.
`int`	`cy` Height of the identifier.
`static int`	`ID_ALPHA` Identification type: Alphanumeric
`static int`	`ID_ALPHANOSPACE` Identification type: Alphanumeric without space
`static int`	`ID_EXACT` Identification type: Exact rectangle contents
`static int`	`ID_FIELDLEN` Identification type: Field: same position and length
`static int`	`ID_NOSPACE` Identification type: No space
`static int`	`ID_NOTEXACT` Identification type: Not rectangle contents
`static int`	`ID_NOTPOPUPWIN` Identification type: Not pop-up window
`static int`	`ID_NUM` Identification type: Numeric (0-9)
`static int`	`ID_SPACE` Identification type: Only space
`static int`	`ID_VALUE` Identification type: Numeric (0-9, +-,.:)
`int`	`type` Host field type.
`static String[]`	`TYPES` The types.
`int`	`x` Position of the screen identifier in X.
`int`	`y` Position of the identifier in Y.

Constructor Summary

Constructors
Constructor and Description
`PhantomHostScreenIdentification(int type, int x, int y, int cx, int cy)` Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(PhantomHostScreenIdentification hsi)` Compares two screen identifications by type then rectangle positions and then size.
`PhantomHostScreenIdentification`	`createCopy()` Creates a copy of this identification.
`boolean`	`equals(Object obj)` Checks if one identification is equal to another.
`String`	`getMatchString()` Gets the matching string for this identification.
`ENPObject`	`getNPObject()` Gets a new NPObject for this screen identification.
`String`	`getTypeDescription()` Gets the type string for an identification type.
`static String`	`getTypeDescription(int type)` Gets the type string for an identification type.
`boolean`	`isIdentificationMatching(HostScreen screen, int xOffset, int yOffset)` Checks if this identification matches the host screen.
`boolean`	`isIdentificationMatchingLax(HostScreen screen, int xOffset, int yOffset)` Checks if this identification matches the host screen.
`static boolean`	`isIdentificationMatchingLax(String str, int type, String matchString)` Checks if this identification matches the host screen.
`void`	`save(PhantomOutputFile file)` Saves the host screen identification to file.
`void`	`setMatchString(String data)` Sets the matching string for this identification.
`boolean`	`updateFromScreen(HostScreen hs, int offsetX, int offsetY)` Update the match data from the indicated screen.

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

- Field Detail
  - ID_EXACT
```
public static final int ID_EXACT
```
    Identification type: Exact rectangle contents
    
    See Also:
    
    Constant Field Values
  - ID_ALPHA
```
public static final int ID_ALPHA
```
    Identification type: Alphanumeric
    
    See Also:
    
    Constant Field Values
  - ID_ALPHANOSPACE
```
public static final int ID_ALPHANOSPACE
```
    Identification type: Alphanumeric without space
    
    See Also:
    
    Constant Field Values
  - ID_NUM
```
public static final int ID_NUM
```
    Identification type: Numeric (0-9)
    
    See Also:
    
    Constant Field Values
  - ID_VALUE
```
public static final int ID_VALUE
```
    Identification type: Numeric (0-9, +-,.:)
    
    See Also:
    
    Constant Field Values
  - ID_NOSPACE
```
public static final int ID_NOSPACE
```
    Identification type: No space
    
    See Also:
    
    Constant Field Values
  - ID_SPACE
```
public static final int ID_SPACE
```
    Identification type: Only space
    
    See Also:
    
    Constant Field Values
  - ID_FIELDLEN
```
public static final int ID_FIELDLEN
```
    Identification type: Field: same position and length
    
    See Also:
    
    Constant Field Values
  - ID_NOTEXACT
```
public static final int ID_NOTEXACT
```
    Identification type: Not rectangle contents
    
    See Also:
    
    Constant Field Values
  - ID_NOTPOPUPWIN
```
public static final int ID_NOTPOPUPWIN
```
    Identification type: Not pop-up window
    
    See Also:
    
    Constant Field Values
  - TYPES
```
public static final String[] TYPES
```
    The types.
  - x
```
public int x
```
    Position of the screen identifier in X.
  - y
```
public int y
```
    Position of the identifier in Y.
  - cx
```
public int cx
```
    Width of the identifier.
    For ID_FIELDLEN, cx contains the required field length.
    For ID_NOTPOPUPWIN, cx contains the width of the pop-up window that cannot match.
    
    See Also:
    
    ID_FIELDLEN, ID_NOTPOPUPWIN
  - cy
```
public int cy
```
    Height of the identifier.
    For ID_NOTPOPUPWIN, cy contains the height of the pop-up window that cannot match.
    
    See Also:
    
    ID_NOTPOPUPWIN
  - type
```
public int type
```
    Host field type.
    
    See Also:
    
    ID_EXACT, ID_ALPHA, ID_ALPHANOSPACE, ID_NUM, ID_VALUE, ID_NOSPACE, ID_SPACE, ID_FIELDLEN, ID_NOTEXACT, ID_NOTPOPUPWIN
- Constructor Detail
  - PhantomHostScreenIdentification
```
public PhantomHostScreenIdentification(int type,
                                       int x,
                                       int y,
                                       int cx,
                                       int cy)
```
    Constructor.
    
    Parameters:
    
    type -
    
    x -
    
    y -
    
    cx -
    
    cy -
- Method Detail
  - getTypeDescription
```
public static String getTypeDescription(int type)
```
    Gets the type string for an identification type.
  - createCopy
```
public PhantomHostScreenIdentification createCopy()
```
    Creates a copy of this identification.
  - getMatchString
```
public String getMatchString()
```
    Gets the matching string for this identification. It should not be called if the type is not ID_EXACT or ID_NOTEXACT, otherwise the string returned is null.
  - setMatchString
```
public void setMatchString(String data)
```
    Sets the matching string for this identification.
    
    Parameters:
    
    data - The matching string.
  - isIdentificationMatching
```
public boolean isIdentificationMatching(HostScreen screen,
                                        int xOffset,
                                        int yOffset)
```
    Checks if this identification matches the host screen.
  - isIdentificationMatchingLax
```
public boolean isIdentificationMatchingLax(HostScreen screen,
                                           int xOffset,
                                           int yOffset)
```
    Checks if this identification matches the host screen.
  - isIdentificationMatchingLax
```
public static boolean isIdentificationMatchingLax(String str,
                                                  int type,
                                                  String matchString)
```
    Checks if this identification matches the host screen.
  - save
```
public void save(PhantomOutputFile file)
          throws IOException
```
    Saves the host screen identification to file.
    
    Parameters:
    
    file -
    
    Throws:
    
    IOException - if an I/O error occurs.
  - equals
```
public boolean equals(Object obj)
```
    Checks if one identification is equal to another.
    
    Overrides:
    
    equals in class Object
  - updateFromScreen
```
public boolean updateFromScreen(HostScreen hs,
                                int offsetX,
                                int offsetY)
```
    Update the match data from the indicated screen.
    
    Parameters:
    
    hs - The HostScreen.
    
    offsetX - Horizontal offset.
    
    offsetY - Vertical offset.
    
    Returns:
    
    boolean true for changed, false otherwise.
  - getTypeDescription
```
public String getTypeDescription()
```
    Gets the type string for an identification type.
  - getNPObject
```
public ENPObject getNPObject()
```
    Gets a new NPObject for this screen identification.
  - compareTo
```
public int compareTo(PhantomHostScreenIdentification hsi)
```
    Compares two screen identifications by type then rectangle positions and then size.
    
    Specified by:
    
    compareTo in interface Comparable<PhantomHostScreenIdentification>

Class PhantomHostScreenIdentification

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ID_EXACT

ID_ALPHA

ID_ALPHANOSPACE

ID_NUM

ID_VALUE

ID_NOSPACE

ID_SPACE

ID_FIELDLEN

ID_NOTEXACT

ID_NOTPOPUPWIN

TYPES

x

y

cx

cy

type

Constructor Detail

PhantomHostScreenIdentification

Method Detail

getTypeDescription

createCopy

getMatchString

setMatchString

isIdentificationMatching

isIdentificationMatchingLax

isIdentificationMatchingLax

save

equals

updateFromScreen

getTypeDescription

getNPObject

compareTo