Package com.iizix.prop
Class FixedVirtualizedAbstractReference<TARGET extends IPropCnr>
- java.lang.Object
- com.iizix.prop.GProp<ReferenceString>
- com.iizix.prop.AbstractReference<TARGET>
- com.iizix.prop.FixedVirtualizedAbstractReference<TARGET>
 
 
 
- All Implemented Interfaces:
- EventListener,- ICircularRetargetParent,- IGProp<ReferenceString>,- IPropReference,- java.lang.Cloneable
 - Direct Known Subclasses:
- AbstractFixedVirtualizedBaseRelativeReference,- AssetReference,- ContextMenuReference,- DatabaseTransactionReference,- ImageReference,- PanelPartReference,- ScreenActionReference,- SelectorReference,- TextTableReference,- VSParticipantReference,- WebServiceReference
 - public abstract class FixedVirtualizedAbstractReference<TARGET extends IPropCnr> extends AbstractReference<TARGET> The Fixed Virtualized Abstract Reference property class hold the reference to another property.- When virtualizing this property reference, the referenced target from the original is "burned in" as a fixed value for the virtualized copy. This class is typically used for references that cannot be modified dynamically, e.g. a reference to an image, data connector, text ID, etc. - Author:
- Christopher Mindus
 
- Nested Class Summary- Nested classes/interfaces inherited from interface com.iizix.prop.IPropReference- IPropReference.ReferenceChangeEvent
 
 - Field Summary- Fields - Modifier and Type - Field - Description - protected TARGET- fixedTargetTarget fixed at virtualization.- Fields inherited from class com.iizix.prop.AbstractReference- ERROR_ID, hasBeenValidated, QUICK_FIX_DELETE_PROP, reference
 - 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 - Modifier - Constructor - Description - protected- FixedVirtualizedAbstractReference()Creates a Abstract Reference property with no name and with a null value.- protected- FixedVirtualizedAbstractReference(Atom propertyAtom)Creates a Abstract Reference property with the specified name with a null value.- protected- FixedVirtualizedAbstractReference(Atom propertyAtom, java.lang.String newValue)Creates a Abstract Reference property with the specified name and value.
 - Method Summary- All Methods Instance Methods Concrete Methods - Modifier and Type - Method - Description - protected void- clearFixedTarget()Called to clear the fixed reference in case the reference is changed.- protected TARGET- getFixedTarget()Support for a fixed reference.- protected void- informClearError()Called when the property has been cleared from error.- protected void- informError()Called when the property has an error.- protected void- informResolved()Called when the property has been resolved.- protected void- onBroken(TARGET target)Called when the target is broken.- protected void- onReferenceDisposed()Called when the reference is disposed of.- protected void- onResolved(TARGET target)Called when the target is resolved.- protected void- onVirtualizationCompleted(IAppSessionGyro appGyro, IClientSessionGyro clientGyro, VirtualSpace virtualSpace, PropCnr virtualizedProp, boolean isPostResolve)Called when virtualization completed.- protected void- onVirtualized(IAppSessionGyro appGyro, IClientSessionGyro clientGyro, VirtualSpace virtualSpace, PropCnr virtualizedProp, GProp<?> clonedProp)Called when this property has been virtualized.- Methods inherited from class com.iizix.prop.AbstractReference- appendPropValue, assignError, assignNotFoundError, changeReference, checkCreateReference, clearError, clone, createUpdateReference, disposeReference, doPostResolve, equalsErrors, equalValues, getAbsoluteReference, getLookupPropReference, getPropertyClass, getPropValue0, getReference, getReferenceDescription, getReferences, getReferenceString, getTargetReference, getTargetReference, getValueClasses, initializeValue, isReferenceValid, isValid, onEventSelf, onProjectNameChanged, onPropDispose, onPropParentChanged, onRefactored, onReferenceEvent, onReferenceEvent, setLookedUpReference, setPropValue, toNativeValue0, updateReference, validatePropType, validateReferenceScope, wouldValidate
 - Methods inherited from class com.iizix.prop.GProp- addPropError, addPropListener, convertPropError, dispose, equals, equals, equalsObj, equalsPropValue, equalsTree, 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, getPropBaseReference, 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, getVSReference, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeElement, initializeGElement, initializeGProp, initializeProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCommunicating, 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, list, list, mapAliasToReference, mapAliasToReference, mapReferenceToAlias, mapReferenceToAlias, mapReferenceToProjectRelative, modifyPropValue, moveProp, moveProp, moveProp, onEvent, onPrepare, onPropInvalidateCache, onPropTreeInitialized, onPropValueSet, onRemoteEvent, paramString, paramValue, post, post, removePropError, removePropListener, removePropUSER, renameProp, renameProp2, resetChangedTree, resolveRuntimeReferences, setChanged, setConstraints, setConstraints, setCreateRequiredProp, setParent, setPrivateChangeEventProp, setPrivateCreateRequiredProp, setPropError, setPropErroredName, setPropExtended, setPropExtendsFinal, setPropExtendsPrivate, setPropForEditor, setPropNullable, setPropPrivate, setPropReadOnly, setPropUSER, setPropValue, setPropValue, setPropValue, setPropValueIncognito, setPropVolatile, severe, severe, severe, shouldSerializeToXML, throwIfReadOnly, toElementString, toNativeValue, toString, toString, triggerRemoteEvent, triggerRemoteEvent, validateProp, validatePropValue, verify, verifyHasPropertyItem, virtualize, warning, warning, warning
 - Methods inherited from class java.lang.Object- getClass, hashCode, notify, notifyAll, wait, wait, wait
 - Methods inherited from interface com.iizix.prop.ICircularRetargetParent- isCircularRetargetParent
 
 
- Constructor Detail- FixedVirtualizedAbstractReference- protected FixedVirtualizedAbstractReference() Creates a Abstract Reference property with no name and with a null value.
 - FixedVirtualizedAbstractReference- protected FixedVirtualizedAbstractReference(Atom propertyAtom) Creates a Abstract Reference property with the specified name with a null value.- Parameters:
- propertyAtom- the property atom.
 
 - FixedVirtualizedAbstractReference- protected FixedVirtualizedAbstractReference(Atom propertyAtom, java.lang.String newValue) Creates a Abstract Reference property with the specified name and value.- Parameters:
- propertyAtom- the property atom.
- newValue- the new string value for the property.
 
 
 - Method Detail- getFixedTarget- protected TARGET getFixedTarget() Support for a fixed reference.- Override to provide the support. - Overrides:
- getFixedTargetin class- AbstractReference<TARGET extends IPropCnr>
- Returns:
- The fixed reference to return in cases the target reference is needed, and also serves as a verification if a new reference should be created or not. Returning nullcauses normal behavior (default).
 
 - clearFixedTarget- protected void clearFixedTarget() Called to clear the fixed reference in case the reference is changed. This will revert back to normal processing.- The "clone" method does not change to be overridden to clear the fixed target as this method is called during cloning. - This method is called prior to calling "initializeReferenceClone()" during cloning. - Override to provide the support. It is important to also implement this method along with "getFixedTarget". - Overrides:
- clearFixedTargetin class- AbstractReference<TARGET extends IPropCnr>
 
 - informResolved- protected void informResolved() Called when the property has been resolved. Subclasses override this method to implement some behavior. The default implementation performs nothing, i.e. there is no need to call- super.informResolved().- Overrides:
- informResolvedin class- AbstractReference<TARGET extends IPropCnr>
 
 - informError- protected void informError() Called when the property has an error. Subclasses override this method to implement some behavior. The default implementation performs nothing, i.e. there is no need to call- super.informError().- Overrides:
- informErrorin class- AbstractReference<TARGET extends IPropCnr>
 
 - informClearError- protected void informClearError() Called when the property has been cleared from error. Subclasses override this method to implement some behavior. The default implementation performs nothing, i.e. there is no need to call- super.informClearError().- Overrides:
- informClearErrorin class- AbstractReference<TARGET extends IPropCnr>
 
 - onReferenceDisposed- protected void onReferenceDisposed() Called when the reference is disposed of.- Overrides:
- onReferenceDisposedin class- AbstractReference<TARGET extends IPropCnr>
 
 - onVirtualized- protected void onVirtualized(IAppSessionGyro appGyro, IClientSessionGyro clientGyro, VirtualSpace virtualSpace, PropCnr virtualizedProp, GProp<?> clonedProp) Called when this property has been virtualized.- Override to perform required processing. - Overrides:
- onVirtualizedin class- GProp<ReferenceString>
- Parameters:
- appGyro- The application gyro instance performing the virtualization.
- clientGyro- The client gyro session, can be- nullif not initialized from the client gyro.
- virtualSpace- The virtualized VirtualSpace.
- virtualizedProp- The property being virtualized.
- clonedProp- The property that is cloned to produce this virtualized property.
 
 - onVirtualizationCompleted- protected void onVirtualizationCompleted(IAppSessionGyro appGyro, IClientSessionGyro clientGyro, VirtualSpace virtualSpace, PropCnr virtualizedProp, boolean isPostResolve) Called when virtualization completed.- This method is called to the entire tree of the newly virtualized property container. - Overrides:
- onVirtualizationCompletedin class- GProp<ReferenceString>
- Parameters:
- appGyro- The application gyro instance performing the virtualization.
- clientGyro- The client gyro session, can be- nullif not initialized from the client gyro.
- virtualSpace- The virtualized VirtualSpace.
- virtualizedProp- The property being virtualized.
- isPostResolve- Flag indicating this call is done after references are attempted to be resolved.
 
 - onResolved- protected void onResolved(TARGET target) Called when the target is resolved.- Parameters:
- target- The target.
 
 - onBroken- protected void onBroken(TARGET target) Called when the target is broken.- Parameters:
- target- The target.