com.iizigo.term.prop

Class EditorScreenIdentificationProp

java.lang.Object

com.iizix.prop.GProp<GProp<?>[]>

com.iizix.prop.PropCnr

com.iizix.term.prop.ScreenIdentificationProp

com.iizigo.term.prop.EditorScreenIdentificationProp

All Implemented Interfaces:

IScreenRectangle, EventListener, IGProp<GProp<?>[]>, IPropCnr, Cloneable, Comparable<ScreenIdentificationProp>

public class EditorScreenIdentificationProp
extends ScreenIdentificationProp
implements IScreenRectangle

This Screen identification property container for a terminal host screen property.

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	TYPES The strings for the type.

Fields inherited from class com.iizix.term.prop.ScreenIdentificationProp

ID_ALPHA, ID_ALPHANOSPACE, ID_EXACT, ID_FIELDLEN, ID_NOSPACE, ID_NOTEXACT, ID_NOTPOPUPWIN, ID_NUM, ID_SPACE, ID_VALUE, NAME_MATCH, NAME_TYPE

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 and Description
EditorScreenIdentificationProp() Creates the screen identification property container without a name.
EditorScreenIdentificationProp(Atom propertyAtom) Creates the screen identification property container with the specified name.

Method Summary

Modifier and Type	Method and Description
void	appendCNStyledTextAdditions(StyledString ss) Appends optional items to styled text.
EditorScreenIdentificationProp	clone() Clone must be overridden.
Composite	createToolTip(Composite parent, ITermEditor editor) Creates the tooltip composite.
String	getCNText() Gets the text for viewers.
int	getColorType() Gets the type.
int	getCX() Gets the width.
int	getCY() Gets the height.
ScreenDesignerProp	getDesigner() Gets the Designer Extension for Properties.
int	getHeight() Gets the height.
String	getMatchString(HostScreen screen, int xPopupOffset, int yPopupOffset) Get the current match string from host screen.
String	getMatchString(HostScreen screen, int xPopupOffset, int yPopupOffset, int x, int y, int cx, int cy) Get the match string from host screen for an identification at x,y with size cx,cy.
Rectangle	getRectangle() Gets the Rectangle.
ScreenRectangleInfo	getRectInfo() Gets the screen rectangle info object.
int	getWidth() Gets the width.
int	getX() Gets the X position.
int	getY() Gets the Y position.
boolean	isShown() Checks if shown on screen.
boolean	isVerifiedSuccessfully() Checks for verification success.
boolean	mustWrap() Check if the rectangle must wrap (for host fields).
void	saveRectInfo(ScreenRectangleInfo rectInfo) Saves the screen rectangle info object.
void	setRectangle(Rectangle r) Sets the Rectangle.
void	verify(PropVerification verification) Verifies this property container.

Methods inherited from class com.iizix.term.prop.ScreenIdentificationProp

compareTo, getMatchString, getType, getTypeDescription, isMatching, isMatchingLax, setMatchString, updateCachedValues, usesPropIndex

Methods inherited from class com.iizix.prop.PropCnr

__transferChildProps, addPredefinedProps, addProp, addProp, addProp2, addProp2, appendPropValue, canRequestFocus, 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, getPropBaseReference, getPropCnr, 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, isChild, isExtendsOverriden, isExtendsPropertyValid, isExtendsRoot, isPropAddRemoveAllowed, isPropCommunicating, isPropExtended, isSibling, list, list, logPropNotFound, maybeAddProp, onInsertProp, onPropDispose, onPropRemoved, onPropTreeInitialized, onReferenceEvent, paramString, prepare, removeAllProps, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, 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, toElementString, toNativeValue0, usePropHashMap, validateChildPropInValue, validateClassInstances, validatePropType, validatePropValue, 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, 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, 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

Field Detail

TYPES

public static final String[] TYPES

The strings for the type.

Constructor Detail

EditorScreenIdentificationProp

public EditorScreenIdentificationProp()

Creates the screen identification property container without a name. The name must be set in all cases using the setPropertyAtom call.

EditorScreenIdentificationProp

public EditorScreenIdentificationProp(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

getDesigner

public ScreenDesignerProp getDesigner()

Gets the Designer Extension for Properties.

Returns:

The instance of the Designer Extension.

clone

public EditorScreenIdentificationProp clone()
                                     throws CloneNotSupportedException

Clone must be overridden.

Overrides:

clone in class PropCnr

Throws:

CloneNotSupportedException - If a subclass doesn't allow cloning, e.g. the client properties.

mustWrap

public boolean mustWrap()

Check if the rectangle must wrap (for host fields).

Specified by:

mustWrap in interface IScreenRectangle

getX

public int getX()

Gets the X position.

Specified by:

getX in interface IScreenRectangle

Overrides:

getX in class ScreenIdentificationProp

Returns:

X, zero based.

getY

public int getY()

Gets the Y position.

Specified by:

getY in interface IScreenRectangle

Overrides:

getY in class ScreenIdentificationProp

Returns:

Y, zero based.

getCX

public int getCX()

Gets the width.

Overrides:

getCX in class ScreenIdentificationProp

Returns:

Character width.

getWidth

public int getWidth()

Gets the width.

Specified by:

getWidth in interface IScreenRectangle

getCY

public int getCY()

Gets the height.

Overrides:

getCY in class ScreenIdentificationProp

Returns:

Character height.

getHeight

public int getHeight()

Gets the height.

Specified by:

getHeight in interface IScreenRectangle

getRectangle

public Rectangle getRectangle()

Gets the Rectangle.

Specified by:

getRectangle in interface IScreenRectangle

setRectangle

public void setRectangle(Rectangle r)

Sets the Rectangle.

Specified by:

setRectangle in interface IScreenRectangle

getColorType

public int getColorType()

Gets the type. The type value below is offset by 3 (range will be 3-11), see the PluginPreferences.TERM_RECTANGLE_TYPES.

 0=exact rectangle,
 1=alphanumeric,
 2=alphanumeric without space,
 3=numeric digits,
 4=numeric signed value,
 5=no space,only space,
 6=field: same position and length,
 7=not rectangle contents,
 8=not pop-up window.
 

Specified by:

getColorType in interface IScreenRectangle

getRectInfo

public ScreenRectangleInfo getRectInfo()

Gets the screen rectangle info object. One is allocated if not present.

Specified by:

getRectInfo in interface IScreenRectangle

saveRectInfo

public void saveRectInfo(ScreenRectangleInfo rectInfo)

Saves the screen rectangle info object.

Specified by:

saveRectInfo in interface IScreenRectangle

createToolTip

public Composite createToolTip(Composite parent,
                               ITermEditor editor)

Creates the tooltip composite.

Specified by:

createToolTip in interface IScreenRectangle

isShown

public boolean isShown()

Checks if shown on screen.

Specified by:

isShown in interface IScreenRectangle

getCNText

public String getCNText()

Gets the text for viewers.

Returns:

Text.

appendCNStyledTextAdditions

public void appendCNStyledTextAdditions(StyledString ss)

Appends optional items to styled text.

Parameters:

ss - The StyledString.

isVerifiedSuccessfully

public boolean isVerifiedSuccessfully()

Checks for verification success.

Specified by:

isVerifiedSuccessfully in interface IScreenRectangle

getMatchString

public String getMatchString(HostScreen screen,
                             int xPopupOffset,
                             int yPopupOffset)

Get the current match string from host screen.

getMatchString

public String getMatchString(HostScreen screen,
                             int xPopupOffset,
                             int yPopupOffset,
                             int x,
                             int y,
                             int cx,
                             int cy)

Get the match string from host screen for an identification at x,y with size cx,cy.

verify

public void verify(PropVerification verification)

Verifies this property container. The check performed is the extension of classes and that no circular reference is present.

Specified by:

verify in interface IGProp<GProp<?>[]>

Overrides:

verify in class PropCnr

Parameters:

verification - The property verification class.