java.lang.Object
- com.iizix.prop.GProp<ReferenceString>
- - com.iizix.prop.AbstractReference<VirtualSpace>
  - - com.iizix.prop.vs.VSReference

All Implemented Interfaces:
EventListener, ICircularRetargetParent, IGProp<ReferenceString>, IPropReference, java.lang.Cloneable
Direct Known Subclasses:
VSParticipant
```
public class VSReference
extends AbstractReference<VirtualSpace>
```
The VirtualSpace Reference property class hold the reference to a VirtualSpace.
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.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
`VSReference()`	Creates a VirtualSpace Reference property with no name and with a null value.
`VSReference(Atom propertyAtom)`	Creates a VirtualSpace Reference property with the specified name with a null value.
`VSReference(Atom propertyAtom, java.lang.String newValue)`	Creates a VirtualSpace 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 VirtualSpace`	`getFixedTarget()`	Support for a fixed reference.
`VirtualSpace`	`getNonVirtualizedVirtualSpace()`	Gets the non-virtualized VirtualSpace instance.
`java.lang.Class<VirtualSpace>`	`getPropertyClass()`	Gets the class wanted.
`java.lang.String`	`getReferenceDescription()`	Gets a short description of this reference.
`VirtualSpace`	`getVirtualSpace()`	Gets the VirtualSpace for this reference.
`VSComponent`	`getVSComponent(VSRelativeReference<?> relRef)`	Gets a VirtualSpace component from a relative reference.
`VSComponent`	`getVSComponent(java.lang.String rel)`	Gets a VirtualSpace component from a relative reference.
`protected boolean`	`isPropPrivateAtCreation()`	Called upon creation of the property to check it's private state.
`boolean`	`isReferenceValid(GProp<?> property)`	Validates the property reference that has been looked up.
`void`	`onReferenceEvent(PropReference ref, IPropReference.ReferenceChangeEvent event, GEvent triggerEvent)`	Called when a property reference event occurs.
`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.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, 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, onVirtualizationCompleted, 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
  - VSReference
```
public VSReference()
```
    Creates a VirtualSpace Reference property with no name and with a null value.
  - VSReference
```
public VSReference(Atom propertyAtom)
```
    Creates a VirtualSpace Reference property with the specified name with a null value.
    Parameters:
    propertyAtom - the property atom.
  - VSReference
```
public VSReference(Atom propertyAtom,
                   java.lang.String newValue)
```
    Creates a VirtualSpace Reference property with the specified name and value.
    Parameters:
    propertyAtom - the property atom.
    newValue - the new string value for the property.
- Method Detail
  - isPropPrivateAtCreation
```
protected final boolean isPropPrivateAtCreation()
```
    Called upon creation of the property to check it's private state. This is used by properties that are not distributed to the remote party.
    Overrides:
    isPropPrivateAtCreation in class GProp<ReferenceString>
    Returns:
    true, always.
  - 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:
    onVirtualized in class GProp<ReferenceString>
    Parameters:
    appGyro - The application gyro instance performing the virtualization.
    clientGyro - The client gyro session, can be null if 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.
  - getFixedTarget
```
protected VirtualSpace getFixedTarget()
```
    Support for a fixed reference.
    Override to provide the support.
    Overrides:
    getFixedTarget in class AbstractReference<VirtualSpace>
    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 null causes 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:
    clearFixedTarget in class AbstractReference<VirtualSpace>
  - onReferenceEvent
```
public void onReferenceEvent(PropReference ref,
                             IPropReference.ReferenceChangeEvent event,
                             GEvent triggerEvent)
```
    Called when a property reference event occurs. The events are ReferenceChangeEvent.FOUND, FOUND_WRONG_CLASS, RENAMED, MOVED, NEW_PROPERTY, BROKEN.
    Specified by:
    onReferenceEvent in interface IPropReference
    Overrides:
    onReferenceEvent in class AbstractReference<VirtualSpace>
    Parameters:
    ref - The property reference object.
    event - The event.
    triggerEvent - The event that triggered this reference event, null for none.
  - 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<VirtualSpace>
    Returns:
    "VirtualSpace".
  - getPropertyClass
```
public java.lang.Class<VirtualSpace> getPropertyClass()
```
    Gets the class wanted.
    Specified by:
    getPropertyClass in class AbstractReference<VirtualSpace>
    Returns:
    VirtualSpace.class.
  - 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<VirtualSpace>
    Parameters:
    property - The property to validate.
    Returns:
    true if valid, false otherwise.
  - getVSComponent
```
public VSComponent getVSComponent(VSRelativeReference<?> relRef)
```
    Gets a VirtualSpace component from a relative reference.
    Parameters:
    relRef - The relative reference.
    Returns:
    A property container of VSField, VSTable, VSColumnHeader, VSRow instance, or null if not found.
  - getVSComponent
```
public VSComponent getVSComponent(java.lang.String rel)
```
    Gets a VirtualSpace component from a relative reference.
    Parameters:
    rel - The relative reference.
    Returns:
    A property container of VSField, VSTable, VSColumnHeader, VSRow instance, or null if not found.
  - getVirtualSpace
```
public VirtualSpace getVirtualSpace()
```
    Gets the VirtualSpace for this reference.
    The method first attempts to use the resolved mechanism of getting the VirtualSpace. 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 VirtualSpace instance, or null if not found.
  - getNonVirtualizedVirtualSpace
```
public VirtualSpace getNonVirtualizedVirtualSpace()
```
    Gets the non-virtualized VirtualSpace instance.
    Returns:
    The non-virtualized VirtualSpace instance if reference is found.

Class VSReference

Nested Class Summary

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

Field Summary

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

VSReference

VSReference

VSReference

Method Detail

isPropPrivateAtCreation

onVirtualized

getFixedTarget

clearFixedTarget

onReferenceEvent

getReferenceDescription

getPropertyClass

isReferenceValid

getVSComponent

getVSComponent

getVirtualSpace

getNonVirtualizedVirtualSpace