Package com.iizix.prop.vs
Class VSParticipantReference
java.lang.Object
com.iizix.prop.GProp<ReferenceString>
com.iizix.prop.AbstractReference<TARGET>
com.iizix.prop.FixedVirtualizedAbstractReference<IVSParticipant>
com.iizix.prop.vs.VSParticipantReference
- All Implemented Interfaces:
- EventListener,- IGProp<ReferenceString>,- IPropReference,- IReferencingGProp,- Cloneable
The VirtualSpace Participant Reference handles references to the VirtualSpace participants that implements the 
IVSParticipant interface, such as panels. Instances of this class are located in the VSParticipantsHolder container in a priority order.- Author:
- Christopher Mindus
- Nested Class Summary- Nested classes/interfaces inherited from interface com.iizix.prop.IPropReference- IPropReference.IRefType, IPropReference.ReferenceChangeEvent, IPropReference.RefType
- Field Summary- Fields inherited from class com.iizix.prop.FixedVirtualizedAbstractReference- fixedTarget- 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 SummaryConstructorsConstructorDescriptionCreates a VirtualSpace Participant property with no name and with a null value.- VSParticipantReference- (Atom propertyAtom) Creates a VirtualSpace Participant property with the specified name with a null value.- VSParticipantReference- (Atom propertyAtom, String ref) Creates a VirtualSpace Participant property with the specified name with a null value.
- Method SummaryModifier and TypeMethodDescription- protected booleanReturns if resolving of this reference should be done in post- (true) or pre-stage (false).Gets the VirtualSpace participant instance for this reference.Gets the class wanted.Gets the reference Type.Gets the VirtualSpace.- boolean- isReferenceValid- (GProp<?> property) Validates the property reference that has been looked up.- boolean- verify- (PropVerification verification) Verifies this property container.- Methods inherited from class com.iizix.prop.FixedVirtualizedAbstractReference- clearFixedTarget, getFixedTarget, informClearError, informError, informReference, informResolved, onBroken, onReferenceDisposed, onResolved, onVirtualizationCompleted, paramString, virtualize- Methods inherited from class com.iizix.prop.AbstractReference- appendPropValue, assignError, assignNotFoundError, changeReference, checkCreateReference, clearError, clone, createUpdateReference, disposeReference, equalsErrors, equalValues, getAbsoluteReference, getDirectReferencedTarget, getDirectReferencedTargetSet, getLookupPropReference, getPropValue0, getReference, getReferenceString, getTargetReference, getTargetReference, getValueClasses, initializeValue, isReferencingMultipleTargets, isValid, modifyPropValue, onEventSelf, onProjectNameChanged, onPropDispose, onPropParentChanged, onRefactored, onReferenceEvent, onReferenceEvent, setLookedUpReference, setPropValue, toNativeValue0, updateReference, validatePropType, validatePropValue, 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, getReferencePropNameNoAssert, getRelativePropName, getRootFromName, getRootName, getRootParent, getRootParentNoAssert, getTreeLock, getVSReference, hasChanged, hasCircularReferencesError, 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, isPropRootLoading, isPropRootTreeModificationsAllowed, isPropUSER, isPropValueTreeLockNeeded, isPropVirtualized, isPropVirtualizing, isPropVolatile, isPropVolatileOrEditorOnly, isProxied, list, list, list, list, list, mapAliasToReference, mapAliasToReference, mapReferenceToAlias, mapReferenceToAlias, mapReferenceToProjectRelative, 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, warning, warning, warning- Methods inherited from class java.lang.Object- getClass, hashCode, notify, notifyAll, wait, wait, wait- Methods inherited from interface com.iizix.prop.IReferencingGProp- getParent, getReferencingOwner
- Constructor Details- VSParticipantReferencepublic VSParticipantReference()Creates a VirtualSpace Participant property with no name and with a null value.
- VSParticipantReferenceCreates a VirtualSpace Participant property with the specified name with a null value.- Parameters:
- propertyAtom- the property atom.
 
- VSParticipantReferenceCreates a VirtualSpace Participant property with the specified name with a null value.- Parameters:
- propertyAtom- the property atom.
- ref- the reference string of the participant.
 
 
- Method Details- getParticipantGets the VirtualSpace participant instance for this reference.- The method first attempts to use the resolved mechanism of getting the participant. If this has failed or has not been resolved yet, the property tree will be used to search for it. The latter is, of course, slower. - Returns:
- The IVSParticipantinstance, ornullif not found.
 
- getReferenceTypeGets the reference Type.- Specified by:
- getReferenceTypein interface- IPropReference
- Specified by:
- getReferenceTypein interface- IReferencingGProp
- Specified by:
- getReferenceTypein class- AbstractReference<IVSParticipant>
- Returns:
- IPropReference.RefType.VirtualSpaceParticipant.
 
- getPropertyClassGets the class wanted.- Specified by:
- getPropertyClassin class- AbstractReference<IVSParticipant>
- Returns:
- IVSParticipant.class.
 
- doPostResolveprotected boolean doPostResolve()Returns if resolving of this reference should be done in post- (true) or pre-stage (false).- Overrides:
- doPostResolvein class- AbstractReference<IVSParticipant>
- Returns:
- false to resolve the reference in the pre-stage.
 
- isReferenceValidValidates the property reference that has been looked up.- Specified by:
- isReferenceValidin interface- IPropReference
- Specified by:
- isReferenceValidin class- AbstractReference<IVSParticipant>
- Parameters:
- property- The property to validate.
- Returns:
- true if valid, false otherwise.
 
- getVirtualSpaceGets the VirtualSpace.- Returns:
- The VirtualSpace, null if property is not valid.
 
- verifyVerifies this property container. The check performed is the extension of classes and that no circular reference is present.- Specified by:
- verifyin interface- IGProp<ReferenceString>
- Overrides:
- verifyin class- GProp<ReferenceString>
- Parameters:
- verification- The property verification class.
- Returns:
- true if verification should proceed, false if disposed of and verification should not take place.