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, ICircularRetargetParent, IGProp<ReferenceString>, IPropReference, java.lang.Cloneable
```
public class VSParticipantReference
extends FixedVirtualizedAbstractReference<IVSParticipant>
```
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.ReferenceChangeEvent

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 Summary

Constructors
Constructor	Description
`VSParticipantReference()`	Creates 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, java.lang.String ref)`	Creates a VirtualSpace Participant property with the specified name with a null value.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected boolean`	`doPostResolve()`	Returns if resolving of this reference should be done in post- (true) or pre-stage (false).
`IVSParticipant`	`getParticipant()`	Gets the VirtualSpace participant instance for this reference.
`java.lang.Class<IVSParticipant>`	`getPropertyClass()`	Gets the class wanted.
`java.lang.String`	`getReferenceDescription()`	Gets a short description of this reference.
`VirtualSpace`	`getVirtualSpace()`	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, informResolved, onBroken, onReferenceDisposed, onResolved, onVirtualizationCompleted, onVirtualized

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, 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
  - VSParticipantReference
```
public VSParticipantReference()
```
    Creates a VirtualSpace Participant property with no name and with a null value.
  - VSParticipantReference
```
public VSParticipantReference(Atom propertyAtom)
```
    Creates a VirtualSpace Participant property with the specified name with a null value.
    Parameters:
    propertyAtom - the property atom.
  - VSParticipantReference
```
public VSParticipantReference(Atom propertyAtom,
                              java.lang.String ref)
```
    Creates 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 Detail
  - getParticipant
```
public IVSParticipant getParticipant()
```
    Gets 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 IVSParticipant instance, or null if not found.
  - getReferenceDescription
```
public java.lang.String getReferenceDescription()
```
    Gets a short description of this reference.
    Specified by:
    getReferenceDescription in interface IPropReference
    Specified by:
    getReferenceDescription in class AbstractReference<IVSParticipant>
    Returns:
    "VirtualSpace Participant".
  - getPropertyClass
```
public java.lang.Class<IVSParticipant> getPropertyClass()
```
    Gets the class wanted.
    Specified by:
    getPropertyClass in class AbstractReference<IVSParticipant>
    Returns:
    IVSParticipant.class.
  - doPostResolve
```
protected boolean doPostResolve()
```
    Returns if resolving of this reference should be done in post- (true) or pre-stage (false).
    Overrides:
    doPostResolve in class AbstractReference<IVSParticipant>
    Returns:
    false to resolve the reference in the pre-stage.
  - isReferenceValid
```
public boolean isReferenceValid(GProp<?> property)
```
    Validates the property reference that has been looked up.
    Specified by:
    isReferenceValid in interface IPropReference
    Specified by:
    isReferenceValid in class AbstractReference<IVSParticipant>
    Parameters:
    property - The property to validate.
    Returns:
    true if valid, false otherwise.
  - getVirtualSpace
```
public VirtualSpace getVirtualSpace()
```
    Gets the VirtualSpace.
    Returns:
    The VirtualSpace, null if property is not valid.
  - verify
```
public boolean 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<ReferenceString>
    Overrides:
    verify in 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.

Class VSParticipantReference

Nested Class Summary

Nested classes/interfaces inherited from interface com.iizix.prop.IPropReference

Field Summary

Fields inherited from class com.iizix.prop.FixedVirtualizedAbstractReference

Fields inherited from class com.iizix.prop.AbstractReference

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.FixedVirtualizedAbstractReference

Methods inherited from class com.iizix.prop.AbstractReference

Methods inherited from class com.iizix.prop.GProp

Methods inherited from class java.lang.Object

Methods inherited from interface com.iizix.prop.ICircularRetargetParent

Constructor Detail

VSParticipantReference

VSParticipantReference

VSParticipantReference

Method Detail

getParticipant

getReferenceDescription

getPropertyClass

doPostResolve

isReferenceValid

getVirtualSpace

verify