Class ScreenProp
- java.lang.Object
- com.iizix.prop.GProp<GProp<?>[]>
- com.iizix.prop.PropCnr
- com.iizix.term.prop.ScreenProp
 
 
 
- All Implemented Interfaces:
- EventListener,- IGProp<GProp<?>[]>,- IPropCnr,- IReferrerParticipant,- IVSAccessor,- IVSParticipant,- java.lang.Cloneable,- java.lang.Comparable<ScreenProp>
 - Direct Known Subclasses:
- EditorScreenProp
 - public class ScreenProp extends PropCnr implements java.lang.Comparable<ScreenProp>, IVSParticipant This Screen property container holds the screen identifications and fields for a terminal host screen.
- Field Summary- Fields - Modifier and Type - Field - Description - protected ScreenActionsProp- actionsThe actions.- static ScreenProp[]- EMPTY_ARRAYAn empty array of ScreenProp's.- protected ScreenFieldsProp- fieldsThe fields.- protected ScreenIdentificationsProp- identificationsThe identifications.- 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 - ScreenProp()Creates the style property container without a name.- ScreenProp(Atom propertyAtom)Creates the style property container with the specified name.
 - Method Summary- All Methods Instance Methods Concrete Methods - Modifier and Type - Method - Description - protected void- addPredefinedProps()Adds the predefined containers for identifications, fields and actions.- protected void- addPredefinedPropsImpl()Adds the predefined containers for identifications, fields and actions.- int- compareTo(ScreenProp hs)Comparator method to sort screens into screen groups.- VSParticipant- createVSReference(Atom refAtom, PropCnr[] returnParent)Creates a VSReference instance from the container or any parent containers.- boolean- equalsIdentification(ScreenProp s)Checks if another screen equals in the screen identification.- ScreenActionsProp- getActions()Gets the screen actions container.- java.lang.String- getDescription()Gets the screen description.- ScreenFieldProp- getField(java.lang.String name)Gets the field with specified name.- ScreenFieldsProp- getFields()Gets the screen fields container.- int- getHeight()Gets the height of this screen.- ScreenIdentificationsProp- getIdentifications()Gets the screen identifications container.- int- getMatchingPopup(HostScreen screen)Matches the screen with available pop-up windows.- java.lang.String- getParticipantDescription()Returns the given description of the referrer participant.- java.lang.String- getParticipantType()Returns the given type of the referrer participant.- protected void- getPredefinedProps()Adds the predefined containers for identifications, fields and actions.- PropCnr- getPropBaseReference()Gets a base property container reference instance from the container or any parent containers.- java.lang.String- getScreenName()Gets the screen name.- VirtualSpace- getVirtualSpace()Gets the VirtualSpace for this panel.- VSParticipant- getVSParticipant()Gets the VSParticipant instance.- VSParticipant- getVSReference(Atom refAtom)Gets a VSReference instance from the container or any parent containers.- int- getWidth()Gets the width of this screen.- boolean- hasVirtualSpaceConnection()Checks for connection to VS.- boolean- isMatching(HostScreen screen)Checks if this screen matches the current host screen, checking size and possible pop-up windows.- boolean- isMatching(HostScreen screen, Rect popupWindow)Checks if this screen matches the current host screen of the specified pop-up window.- boolean- isPopup()Checks if this screen is of pop-up window type.- boolean- isPrimaryParticipant()Checks if this panel is primary or not.- void- onEventSelf(GEvent event)Event checking to clear cache.- void- onVirtualSpaceVirtualized(IAppSessionGyro appGyro, VirtualSpace virtualizedVirtualSpace)Called when the VirtualSpace has been virtualized, giving the opportunity for e.g.- int- populateVirtualSpace(HostScreen hostScreen, boolean alwaysOverwrite)Populates the VirtualSpace from the host screen.- protected void- updateCachedValues()Gets the cached value if not retrieved yet, or not valid.- Methods inherited from class com.iizix.prop.PropCnr- __transferChildProps, addProp, addProp, addProp2, addProp2, appendPropValue, canRequestFocus, clone, completeVirtualize, containsProp, containsProp, convertLoadedProp, couldRequestFocusIfVirtualized, createCopyOfAtom, createUniqueAtom, createUniqueAtom, createUniqueAtom, 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, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getPropCnr, getPropCount, getPropCount, getPropIndex, getPropIndex, getPropIndexes, getProps, getProps, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue0, getReferences, getRetargetedVerifyContainer, getString, getString, getString, getString, getValueClasses, 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, usesPropIndex, 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, 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, getReferences, getRelativePropName, getRootParent, getTreeLock, getValueClasses, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCommunicating, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropNullable, isPropPrivate, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropVirtualized, list, list, list, list, list, mapAliasToReference, mapReferenceToAlias, mapReferenceToProjectRelative, moveProp, moveProp, moveProp, onEvent, onPropTreeInitialized, onRemoteEvent, removePropError, removePropListener, renameProp, resolveRuntimeReferences, setChanged, setConstraints, setConstraints, setParent, setPrivateChangeEventProp, setPropError, setPropExtendsFinal, setPropExtendsPrivate, setPropNullable, setPropPrivate, setPropReadOnly, setPropValue, setPropValue, severe, severe, severe, toElementString, toNativeValue, triggerRemoteEvent, triggerRemoteEvent, validateProp, validatePropType, validatePropValue, verify, verifyHasPropertyItem, warning, warning, warning
 - Methods inherited from interface com.iizix.prop.IPropCnr- addProp, addProp, addProp2, addProp2, canRequestFocus, canRequestFocus, canRequestFocus, containsProp, containsProp, couldRequestFocusIfVirtualized, couldRequestFocusIfVirtualized, couldRequestFocusIfVirtualized, createCopyOfAtom, createUniqueAtom, createUniqueAtom, enablePropCommunication, enablePropHashMap, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getBool, getBool, getBool, getBool, getChildPropError, getChildPropError, getChildPropErrorSeverity, getChildPropErrorSeverity, getErrorsProp, getExtendsError, getExtendsName, getExtendsPossibleClasses, getFirstProp, getFirstProp, getFocusEngine, getInt, getInt, getInt, getInt, getLong, getLong, getLong, getLong, getNumber, getNumber, getNumber, getNumber, getPossibleChildren, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getPropCnr, getPropCount, getPropIndex, getPropIndex, getPropIndexes, getProps, getProps, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getString, getString, getString, getString, hasFocus, initializeExtendsFramework, insertProp, insertProp2, isChild, isExtendsOverriden, isExtendsRoot, isPropAddRemoveAllowed, isPropExtended, isSibling, removeAllProps, removeAllProps2, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, reorderProps, requestFocus, requestFocusEx, setBool, setBool, setBool, setBool, 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, usePropHashMap, usesPropIndex, validateClassInstances
 - Methods inherited from interface com.iizix.prop.IReferrerParticipant- isParticipating
 - Methods inherited from interface com.iizix.prop.vs.IVSParticipant- assignVirtualSpace, getVSParticipantAtom
 
 
- Field Detail- EMPTY_ARRAY- public static final ScreenProp[] EMPTY_ARRAY An empty array of ScreenProp's.
 - identifications- protected ScreenIdentificationsProp identifications The identifications.
 - fields- protected ScreenFieldsProp fields The fields.
 - actions- protected ScreenActionsProp actions The actions.
 
 - Constructor Detail- ScreenProp- public ScreenProp() Creates the style property container without a name. The name must be set in all cases using the- setPropertyAtomcall.
 - ScreenProp- public ScreenProp(Atom propertyAtom) Creates the style 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- addPredefinedProps- protected void addPredefinedProps() throws PropExceptionAdds the predefined containers for identifications, fields and actions.- Overrides:
- addPredefinedPropsin class- PropCnr
- Throws:
- PropException- for property exceptions.
 
 - addPredefinedPropsImpl- protected void addPredefinedPropsImpl() throws PropExceptionAdds the predefined containers for identifications, fields and actions. This method is overridden fully by the Editor versions of the class.- Throws:
- PropException
 
 - getPredefinedProps- protected void getPredefinedProps() Adds the predefined containers for identifications, fields and actions. This method is overridden fully by the Editor versions of the class.- Overrides:
- getPredefinedPropsin class- PropCnr
 
 - getScreenName- public java.lang.String getScreenName() Gets the screen name.- Returns:
- The screen name.
 
 - hasVirtualSpaceConnection- public boolean hasVirtualSpaceConnection() Checks for connection to VS.- Returns:
- If screen is connected to a VirtualSpace.
 
 - getVSReference- public VSParticipant getVSReference(Atom refAtom) Gets a VSReference instance from the container or any parent containers. The method is used by- VSRelativeReferenceto look up the- VSReferenceinstance in order to resolve the relative path to the target property.- Specified by:
- getVSReferencein interface- IGProp<GProp<?>[]>
- Overrides:
- getVSReferencein class- PropCnr
- Parameters:
- refAtom- The property atom of the requesting relative reference property.
- Returns:
- The instance of the VSReferenceornullif unassigned.
 
 - createVSReference- public VSParticipant createVSReference(Atom refAtom, PropCnr[] returnParent) Creates a VSReference instance from the container or any parent containers. The method is used in the Designer to create a VirtualSpace connection for- VSRelativeReferenceto look up the- VSReferenceinstance in order to resolve the relative path to the target property.- This method needs to be overridden by subclasses of - PropCnrthat has a VSReference as property, and *SHOULD* match- getVSReference(Atom).- The default is to re-target the call to the parent container, and if the root, a folder or a file property is reached, - nullis returned.- Overrides:
- createVSReferencein class- PropCnr
- Parameters:
- refAtom- The property asking for the VSReference.
- returnParent- An array of PropCnr [1] that will be filled in with the parent property of the VSRefernce.
- Returns:
- The instance of the VSReferenceornullif unassigned. The returned instance could also be a VSParticipant and should therefore be processed accordingly.For this method, it's a VSParticipant. 
 
 - getVSParticipant- public VSParticipant getVSParticipant() Gets the VSParticipant instance. This is also an instance of- VSReference.- Returns:
- The instance of the VSParticipant, or null if not yet defined.
 
 - getVirtualSpace- public VirtualSpace getVirtualSpace() Gets the VirtualSpace for this panel.- Method for IVSParticipant: Gets the referrer's back-reference to the VirtualSpace. This is used by the VSParticipantReference when verifying its references. - Specified by:
- getVirtualSpacein interface- IVSAccessor
- Returns:
- The VirtualSpace reference, or null for none.
 
 - getParticipantDescription- public java.lang.String getParticipantDescription() Returns the given description of the referrer participant.- Specified by:
- getParticipantDescriptionin interface- IReferrerParticipant
- Returns:
- The string the Designer entered in the Description field, or "n/a" for none.
 
 - getParticipantType- public java.lang.String getParticipantType() Returns the given type of the referrer participant.- Specified by:
- getParticipantTypein interface- IReferrerParticipant
 
 - isPrimaryParticipant- public boolean isPrimaryParticipant() Checks if this panel is primary or not. A primary participant is chosen in the selection processing when multiple participants are ordered in a VS ParticipantsHolder container.- Specified by:
- isPrimaryParticipantin interface- IReferrerParticipant
- Returns:
- The default implementation returns true.
 
 - getDescription- public java.lang.String getDescription() Gets the screen description.- Returns:
- The screen description, or null for none.
 
 - getPropBaseReference- public PropCnr getPropBaseReference() Gets a base property container reference instance from the container or any parent containers. The method is used by- PropRelativeReferenceto look up the reference instance in order to resolve the relative path to the target property.- This method needs to be overridden by subclasses of - PropCnrthat has a PropRelativeReference as property, e.g. the- ScreenPropclass in the Terminal Core plug-in.- The default is to re-target the call to the parent container, and if the root, a folder or a file property is reached, - nullis returned.- Specified by:
- getPropBaseReferencein interface- IGProp<GProp<?>[]>
- Overrides:
- getPropBaseReferencein class- PropCnr
- Returns:
- The instance of the PropCnrornullif unassigned.
 
 - getIdentifications- public ScreenIdentificationsProp getIdentifications() Gets the screen identifications container.- Returns:
- The screen identifications container.
 
 - getFields- public ScreenFieldsProp getFields() Gets the screen fields container.- Returns:
- The screen fields container.
 
 - getActions- public ScreenActionsProp getActions() Gets the screen actions container.- Returns:
- The screen actions container.
 
 - onEventSelf- public void onEventSelf(GEvent event) Event checking to clear cache.- Specified by:
- onEventSelfin interface- IGProp<GProp<?>[]>
- Overrides:
- onEventSelfin class- GProp<GProp<?>[]>
- Parameters:
- event- The property event.
 
 - updateCachedValues- protected void updateCachedValues() Gets the cached value if not retrieved yet, or not valid.
 - getField- public ScreenFieldProp getField(java.lang.String name) Gets the field with specified name.- Parameters:
- name- The field name (case sensitive).
- Returns:
- The screen field property or null if not found.
 
 - isPopup- public boolean isPopup() Checks if this screen is of pop-up window type.- Returns:
- true for popup, false for full screen.
 
 - getWidth- public int getWidth() Gets the width of this screen.- Returns:
- Width of screen or popup.
 
 - getHeight- public int getHeight() Gets the height of this screen.- Returns:
- Height of screen or popup.
 
 - isMatching- public boolean isMatching(HostScreen screen) Checks if this screen matches the current host screen, checking size and possible pop-up windows.- Parameters:
- screen- The host screen.
- Returns:
- true if it matches current host screen, false otherwise.
 
 - getMatchingPopup- public int getMatchingPopup(HostScreen screen) Matches the screen with available pop-up windows.- Parameters:
- screen- The host screen.
- Returns:
- The pop-up window index matching, or -1 for none.
 
 - isMatching- public boolean isMatching(HostScreen screen, Rect popupWindow) Checks if this screen matches the current host screen of the specified pop-up window.- Parameters:
- screen- The host screen.
- popupWindow- If null, entire screen, otherwise a pop-up window.
- Returns:
- true if it matches current host screen, false otherwise.
 
 - compareTo- public int compareTo(ScreenProp hs) Comparator method to sort screens into screen groups.- Specified by:
- compareToin interface- java.lang.Comparable<ScreenProp>
 
 - equalsIdentification- public boolean equalsIdentification(ScreenProp s) Checks if another screen equals in the screen identification.- Parameters:
- s- Another screen to compare identifications with.
- Returns:
- If screen identifications are equal.
 
 - populateVirtualSpace- public int populateVirtualSpace(HostScreen hostScreen, boolean alwaysOverwrite) Populates the VirtualSpace from the host screen.- Parameters:
- hostScreen- The host screen.
- alwaysOverwrite- Flag to always set the VS fields, even if there is no difference in the host data.
- Returns:
- The number of VirtualSpace Fields that has been set.
 
 - onVirtualSpaceVirtualized- public void onVirtualSpaceVirtualized(IAppSessionGyro appGyro, VirtualSpace virtualizedVirtualSpace) Called when the VirtualSpace has been virtualized, giving the opportunity for e.g. data connectors to prepare it's virtualized counterparts if this is required.- This call is done to the non-virtualized instance of the VirtualSpace participant. - Specified by:
- onVirtualSpaceVirtualizedin interface- IVSParticipant
- Parameters:
- appGyro- The application gyro instance.
- virtualizedVirtualSpace- The virtualized VirtualSpace instance.