com.iizix.prop.vs

Class VSActionReference

java.lang.Object

com.iizix.prop.GProp<String>

com.iizix.prop.StringProp

com.iizix.prop.vs.VSRelativeReference<VSAction>

com.iizix.prop.vs.VSActionReference

All Implemented Interfaces:

EventListener, ICircularRetargetParent, IGProp<String>, IPropReference, Cloneable

Direct Known Subclasses:

VSActionActorParticipant

public class VSActionReference
extends VSRelativeReference<VSAction>

The VirtualSpace Action Reference property class hold the relative reference to a VSAction instance.

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

currentTarget, fixedTarget, reference, vsRefBase

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 and Description
VSActionReference() Creates a VirtualSpace Action Reference property with no name and with a null value.
VSActionReference(Atom propertyAtom) Creates a VirtualSpace Action Reference property with the specified name with a null value.
VSActionReference(Atom propertyAtom, String newValue) Creates a VirtualSpace Action Reference property with the specified name and value.

Method Summary

Modifier and Type	Method and Description
VSActionReference	clone() Overrides clone to clear existing parent listener.
protected IVSActionListener	getCurrentListener() Gets the current listener, i.e.
Class<? extends GProp<?>>	getPropertyClass() Gets the class wanted.
String	getReferenceDescription() Gets a short description of this reference.
String	invokeAction(IClientSessionGyro clientGyro, GProp<?> trigger, boolean isRemote, IVSActionProcessComplete completeCallback) Invokes the action.
protected void	onRemoved(VSAction oldTarget) Called when the property reference has been disposed of e.g.
protected void	onResolved(VSAction target) Called when the property reference has been resolved.

Methods inherited from class com.iizix.prop.vs.VSRelativeReference

addError, clearError, createReference, disposeReference, equalsErrors, getReference, getReferences, getVSTarget, isPropPrivateAtCreation, isReferenceValid, onEventSelf, onPropDispose, onPropParentChanged, onReferenceEvent, onReferenceEvent, onVirtualizationCompleted, onVirtualized, onVSReferenceChanged, resolve, resolve, setInvalid, targetChanged

Methods inherited from class com.iizix.prop.StringProp

appendPropValue, getPropValue0, getString, getString, getValueClasses, initializeValue, setPropValue, toNativeValue0, validatePropType

Methods inherited from class com.iizix.prop.GProp

addPropError, addPropListener, convertPropError, dispose, equals, equals, equalsObj, equalsPropValue, equalsTree, 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, 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, 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

VSActionReference

public VSActionReference()

Creates a VirtualSpace Action Reference property with no name and with a null value.

VSActionReference

public VSActionReference(Atom propertyAtom)

Creates a VirtualSpace Action Reference property with the specified name with a null value.

Parameters:

propertyAtom - the property atom.

VSActionReference

public VSActionReference(Atom propertyAtom,
                         String newValue)

Creates a VirtualSpace Action Reference property with the specified name and value.

Parameters:

propertyAtom - the property atom.

newValue - the new string value for the property.

Method Detail

clone

public VSActionReference clone()

Overrides clone to clear existing parent listener.

Overrides:

clone in class VSRelativeReference<VSAction>

Returns:

A new cloned String property.

getCurrentListener

protected IVSActionListener getCurrentListener()

Gets the current listener, i.e. the parent property.

Returns:

The current listener, or null for none.

getPropertyClass

public Class<? extends GProp<?>> getPropertyClass()

Gets the class wanted.

Specified by:

getPropertyClass in class VSRelativeReference<VSAction>

getReferenceDescription

public String getReferenceDescription()

Gets a short description of this reference.

Specified by:

getReferenceDescription in interface IPropReference

Specified by:

getReferenceDescription in class VSRelativeReference<VSAction>

Returns:

"VS Action".

onResolved

protected void onResolved(VSAction target)

Called when the property reference has been resolved.

Specified by:

onResolved in class VSRelativeReference<VSAction>

Parameters:

target - The target reference.

onRemoved

protected void onRemoved(VSAction oldTarget)

Called when the property reference has been disposed of e.g. due to new reference or pure disposal of this property.

Specified by:

onRemoved in class VSRelativeReference<VSAction>

Parameters:

oldTarget - The old target reference.

invokeAction

public String invokeAction(IClientSessionGyro clientGyro,
                           GProp<?> trigger,
                           boolean isRemote,
                           IVSActionProcessComplete completeCallback)

Invokes the action. The action is posted to the appropriate worker thread for execution, or run in a separate thread depending on settings.

If not enabled or read-only, the method will fail with an error message. The same message will then also be logged as a warning,

If this method is called from a Run Mode not being any of the Server Run Modes, the method will just log an informational message and return null

Parameters:

clientGyro - Client gyro to use, null to look-it up if needed from current thread.

trigger - The trigger property, null for none.

isRemote - Flag indicating that the reason for the action invocation is remote, i.e. from the Client.

completeCallback - Called when complete (in the action execution thread), null for none.

Returns:

null for success, otherwise an error message. The return from this method may be done prior to completion of the TX process (use the completeCallback to monitor completion).