java.lang.Object
- com.iizix.prop.GProp<GProp<?>[]>
- - com.iizix.prop.PropCnr
  - - com.iizix.term.prop.ScreenIdentificationProp

All Implemented Interfaces:
EventListener, IGProp<GProp<?>[]>, IPropCnr, java.lang.Cloneable, java.lang.Comparable<ScreenIdentificationProp>
Direct Known Subclasses:
EditorScreenIdentificationProp
```
public class ScreenIdentificationProp
extends PropCnr
implements java.lang.Comparable<ScreenIdentificationProp>
```
This Screen identification property container for a terminal host screen.

Field Summary

Fields
Modifier and Type	Field	Description
`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, +-,.:).
`static java.lang.String`	`NAME_MATCH`	The property name for "match" data string.
`static java.lang.String`	`NAME_TYPE`	The property name for "type" of identification.
`static java.lang.String[]`	`TYPES`	The types.

Fields inherited from class com.iizix.prop.PropCnr
EMPTY, EMPTY_CLASSES, EMPTY_CNRS, EXTENDS_FRAMEWORK_ERROR_ID

Fields inherited from class com.iizix.prop.GProp
GPDEBUG, PROP_ATTR_STRING_EDITOR_PROP, PROP_ATTR_STRING_ERRORED_NAME, PROP_ATTR_STRING_EXTENDS, PROP_ATTR_STRING_EXTENDS_FINAL, PROP_ATTR_STRING_EXTENDS_PRIVATE, PROP_ATTR_STRING_NULLABLE, PROP_ATTR_STRING_PRIVATE, PROP_ATTR_STRING_PRIVATE_CHANGE_EVENT, PROP_ATTR_STRING_READ_ONLY, PROP_USER_1, PROP_USER_2

Fields inherited from interface com.iizix.prop.IGProp
EQC_ERROR_IGNORE_ALL, EQC_ERROR_IGNORE_REFERENCES, EQC_IGNORE_ARRAY, EQC_IGNORE_VOLATILE_OR_EDITOR, EQC_PRIVATE, EQC_SAVE_FILE, EXT_CONTAINER_EXTENDS, EXT_CONTAINER_EXTENDS_VALID, EXT_EXTENDED, EXT_FINAL, EXT_OVERRIDES, EXT_OVERRIDES_FINAL_ERR, EXT_PRIVATE

Constructor Summary

Constructors
Constructor	Description
`ScreenIdentificationProp()`	Creates the screen identification property container without a name.
`ScreenIdentificationProp(Atom propertyAtom)`	Creates the screen identification property container with the specified name.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`compareTo(ScreenIdentificationProp id)`	Compares two screen identifications by type then rectangle positions and then size.
`int`	`getCX()`	Gets the width.
`int`	`getCY()`	Gets the height.
`java.lang.String`	`getMatchString()`	Gets the matching string for this identification.
`int`	`getType()`	Gets the type.
`static java.lang.String`	`getTypeDescription(int type)`	Gets the type string for an identification type.
`int`	`getX()`	Gets the X position.
`int`	`getY()`	Gets the Y position.
`boolean`	`isMatching(HostScreen screen, int xOffset, int yOffset)`	Checks if this identification matches the host screen.
`static boolean`	`isMatchingLax(int type, java.lang.String data, int x, int y, int cx, int cy, HostScreen screen, int xOffset, int yOffset)`	Checks if this identification matches the host screen.
`void`	`setMatchString(java.lang.String data)`	Sets the matching string for this identification.
`protected void`	`updateCachedValues()`	Updates the cached values.
`boolean`	`usesPropIndex()`	This property is index based.

Methods inherited from class com.iizix.prop.PropCnr
__transferChildProps, addPredefinedProps, addProp, addProp, addProp2, addProp2, appendPropValue, canRequestFocus, clone, completeVirtualize, containsProp, containsProp, convertLoadedProp, couldRequestFocusIfVirtualized, createCopyOfAtom, createUniqueAtom, createUniqueAtom, createUniqueAtom, createVSReference, doPropEqualsArrayValues, doVirtualizePropCnr, enablePropCommunication, enablePropHashMap, equalsTree, equalsTree, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getBool, getBool, getBool, getBool, getChildPropError, getChildPropError, getChildPropErrorSeverity, getChildPropErrorSeverity, getErrorsProp, getExtendsContainer, getExtendsError, getExtendsName, getExtendsOverride, getExtendsPossibleClasses, getFirstProp, getFirstProp, getFocusEngine, getInt, getInt, getInt, getInt, getLong, getLong, getLong, getLong, getNumber, getNumber, getNumber, getNumber, getPossibleChildren, getPredefinedProps, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getPropBaseReference, getPropCnr, getPropCount, getPropCount, getPropIndex, getPropIndex, getPropIndexes, getProps, getProps, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue0, getReferences, getRetargetedVerifyContainer, getString, getString, getString, getString, getValueClasses, getVSReference, hasFocus, hasSendData, initializeElement, initializeExtendsFramework, initializeProp, initializeValue, initPropCnr, insertProp, insertProp2, isChild, isExtendsOverriden, isExtendsPropertyValid, isExtendsRoot, isPropAddRemoveAllowed, isPropCommunicating, isPropExtended, isSibling, list, list, logPropNotFound, maybeAddProp, onInsertProp, onPropDispose, onPropRemoved, onPropTreeInitialized, onReferenceEvent, paramString, prepare, removeAllProps, removeAllProps2, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, reorderProps, replaceProps, requestFocus, requestFocus, requestFocusEx, requestFocusEx, resolveReferences, resolveRuntimeReferences, setBool, setBool, setBool, setBool, setCreateRequiredProp, setExtendsName, setExtendsOverride, setInt, setInt, setInt, setLong, setLong, setLong, setLong, setNumber, setNumber, setNumber, setNumber, setProp, setProp, setProp, setProp2, setProp2, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setString, setString, setString, setString, shouldCreateProps, shouldSerializeToXML, toElementString, toNativeValue0, usePropHashMap, validateChildPropInValue, validateClassInstances, validatePropType, validatePropValue, verify, verifyInternalUseOnly, verifyTree, virtualize

Methods inherited from class com.iizix.prop.GProp
addPropError, addPropListener, convertPropError, dispose, equals, equals, equalsErrors, equalsObj, equalsPropValue, equalValues, extendsClone, finalize, fine, fine, finer, finer, finest, finest, fromElementString, getAliasName, getAppSessionGyro, getAppWorker, getAtomPath, getAttribute, getChildReferencePropName, getClientSessionGyro, getClientWorker, getConstraints, getEnvironment, getErroredPropItems, getErroredProps, getErrorsProp, getExtendsRootContainer, getFullPropName, getFullPropName, getFullPropNameDebug, getFullPropNameDebug, getListeners, getModuleFolder, getModuleFolder, getParent, getParent, getProjectName, getPropAtom, getPropError, getPropError, getPropErroredName, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromPath, getPropFromReference, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropReferenceTarget, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getPropValueObject, getReferencePropName, getRelativePropName, getRootFromName, getRootName, getRootParent, getRootParent, getTreeLock, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropForEditor, isPropNullable, isPropPrivate, isPropPrivateAtCreation, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropUSER, isPropValueTreeLockNeeded, isPropVirtualized, isPropVirtualizing, isPropVolatile, isPropVolatileOrEditorOnly, isProxied, list, list, list, mapAliasToReference, mapAliasToReference, mapReferenceToAlias, mapReferenceToAlias, mapReferenceToProjectRelative, modifyPropValue, moveProp, moveProp, moveProp, onEvent, onEventSelf, onPrepare, onPropInvalidateCache, onPropParentChanged, onPropValueSet, onRemoteEvent, onVirtualizationCompleted, onVirtualized, paramValue, post, post, removePropError, removePropListener, removePropUSER, renameProp, renameProp2, resetChangedTree, setChanged, setConstraints, setConstraints, setParent, setPrivateChangeEventProp, setPrivateCreateRequiredProp, setPropError, setPropErroredName, setPropExtended, setPropExtendsFinal, setPropExtendsPrivate, setPropForEditor, setPropNullable, setPropPrivate, setPropReadOnly, setPropUSER, setPropValue, setPropValue, setPropValue, setPropValueIncognito, setPropVolatile, severe, severe, severe, shouldSerializeToXML, throwIfReadOnly, toNativeValue, toString, toString, triggerRemoteEvent, triggerRemoteEvent, validateProp, verifyHasPropertyItem, warning, warning, warning

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

Methods inherited from interface com.iizix.prop.IGProp
addPropError, addPropListener, dispose, equals, fine, fine, finer, finer, finest, finest, fromElementString, getAppSessionGyro, getAtomPath, getClientSessionGyro, getConstraints, getEnvironment, getErroredPropItems, getErroredProps, getErrorsProp, getExtendsRootContainer, getFullPropName, getFullPropNameDebug, getModuleFolder, getModuleFolder, getParent, getParent, getPropAtom, getPropError, getPropError, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getReferencePropName, getRelativePropName, getRootParent, getTreeLock, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropNullable, isPropPrivate, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropVirtualized, list, list, list, mapAliasToReference, mapReferenceToAlias, mapReferenceToProjectRelative, moveProp, moveProp, moveProp, onEvent, onEventSelf, onRemoteEvent, removePropError, removePropListener, renameProp, setChanged, setConstraints, setConstraints, setParent, setPrivateChangeEventProp, setPropError, setPropExtendsFinal, setPropExtendsPrivate, setPropNullable, setPropPrivate, setPropReadOnly, setPropValue, setPropValue, severe, severe, severe, toNativeValue, triggerRemoteEvent, triggerRemoteEvent, validateProp, verifyHasPropertyItem, warning, warning, warning

Methods inherited from interface com.iizix.prop.IPropCnr
canRequestFocus, canRequestFocus, couldRequestFocusIfVirtualized, couldRequestFocusIfVirtualized

- Field Detail
  - NAME_TYPE
```
public static final java.lang.String NAME_TYPE
```
    The property name for "type" of identification.
    See Also:
    Constant Field Values
  - NAME_MATCH
```
public static final java.lang.String NAME_MATCH
```
    The property name for "match" data string.
    See Also:
    Constant Field Values
  - 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 java.lang.String[] TYPES
```
    The types.
- Constructor Detail
  - ScreenIdentificationProp
```
public ScreenIdentificationProp()
```
    Creates the screen identification property container without a name. The name must be set in all cases using the setPropertyAtom call.
  - ScreenIdentificationProp
```
public ScreenIdentificationProp(Atom propertyAtom)
```
    Creates the screen identification property container with the specified name. All system-reserved names for components begins with "$".
    Parameters:
    propertyAtom - the name of the component, unique within it's parent.
- Method Detail
  - getTypeDescription
```
public static java.lang.String getTypeDescription(int type)
```
    Gets the type string for an identification type.
    Parameters:
    type - The identification type as ID_* value.
    Returns:
    A descriptive text.
  - usesPropIndex
```
public boolean usesPropIndex()
```
    This property is index based.
    Specified by:
    usesPropIndex in interface IPropCnr
    Overrides:
    usesPropIndex in class PropCnr
    Returns:
    true.
  - updateCachedValues
```
protected void updateCachedValues()
```
    Updates the cached values.
  - getX
```
public int getX()
```
    Gets the X position.
    Returns:
    X, zero based.
  - getY
```
public int getY()
```
    Gets the Y position.
    Returns:
    Y, zero based.
  - getCX
```
public int getCX()
```
    Gets the width.
    Returns:
    Character width.
  - getCY
```
public int getCY()
```
    Gets the height.
    Returns:
    Character height.
  - getType
```
public int getType()
```
    Gets the type.
    Returns:
    Value for the identification type ID_*.
  - getMatchString
```
public java.lang.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.
    Returns:
    The match string or null for ID_EXACT or ID_NOTEXACT.
  - setMatchString
```
public void setMatchString(java.lang.String data)
```
    Sets the matching string for this identification.
    Parameters:
    data - Match string, not null.
  - isMatching
```
public boolean isMatching(HostScreen screen,
                          int xOffset,
                          int yOffset)
```
    Checks if this identification matches the host screen.
    Parameters:
    screen - The screen.
    xOffset - Offset on screen for pop-up window, zero-based.
    yOffset - Offset on screen for pop-up window, zero-based.
    Returns:
    Match flag.
  - isMatchingLax
```
public static boolean isMatchingLax(int type,
                                    java.lang.String data,
                                    int x,
                                    int y,
                                    int cx,
                                    int cy,
                                    HostScreen screen,
                                    int xOffset,
                                    int yOffset)
```
    Checks if this identification matches the host screen.
  - compareTo
```
public int compareTo(ScreenIdentificationProp id)
```
    Compares two screen identifications by type then rectangle positions and then size.
    Specified by:
    compareTo in interface java.lang.Comparable<ScreenIdentificationProp>

Class ScreenIdentificationProp

Field Summary

Fields inherited from class com.iizix.prop.PropCnr

Fields inherited from class com.iizix.prop.GProp

Fields inherited from interface com.iizix.prop.IGProp

Constructor Summary

Method Summary

Methods inherited from class com.iizix.prop.PropCnr

Methods inherited from class com.iizix.prop.GProp

Methods inherited from class java.lang.Object

Methods inherited from interface com.iizix.prop.IGProp

Methods inherited from interface com.iizix.prop.IPropCnr

Field Detail

NAME_TYPE

NAME_MATCH

ID_EXACT

ID_ALPHA

ID_ALPHANOSPACE

ID_NUM

ID_VALUE

ID_NOSPACE

ID_SPACE

ID_FIELDLEN

ID_NOTEXACT

ID_NOTPOPUPWIN

TYPES

Constructor Detail

ScreenIdentificationProp

ScreenIdentificationProp

Method Detail

getTypeDescription

usesPropIndex

updateCachedValues

getX

getY

getCX

getCY

getType

getMatchString

setMatchString

isMatching

isMatchingLax

compareTo