com.iizix.prop.vs

Class VSOnUIEvent

java.lang.Object

com.iizix.prop.GProp<String>

com.iizix.prop.StringProp

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

com.iizix.prop.vs.VSOnUIEvent

All Implemented Interfaces:

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

Direct Known Subclasses:

EditorVSOnUIEvent

public class VSOnUIEvent
extends VSRelativeReference<VSComponent>

Class to hold a reference to a VS Action (to invoke) or a VS component (for focus) when a UI component is "on"-something, such as "onClick".

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
VSOnUIEvent() Creates the event listener property without name.
VSOnUIEvent(Atom atom) Creates the event listener property.

Method Summary

Modifier and Type	Method and Description
protected void	appendPropValue(PropMgr propertyManager, Transaction trans, Object value) Appends the string property value.
Class<VSComponent>	getPropertyClass() Gets the class wanted.
String	getReferenceDescription() Gets a short description of this reference, e.g.
boolean	initializeValue(PropMgr propertyManager, Transaction trans) Initializes the property value from a transaction.
protected boolean	isPropPrivateAtCreation() Called upon creation of the property to check it's private state.
void	onRemoteEvent(RemoteEvent event) Remote event to invoke the action or set focus to the VS component.
protected void	onRemoved(VSComponent oldTarget) Called when the property reference has been disposed of e.g.
protected void	onResolved(VSComponent target) Called when the property reference has been resolved.

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

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

Methods inherited from class com.iizix.prop.StringProp

getPropValue0, getString, getString, getValueClasses, 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, 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

VSOnUIEvent

public VSOnUIEvent()

Creates the event listener property without name.

VSOnUIEvent

public VSOnUIEvent(Atom atom)

Creates the event listener property.

Parameters:

atom - The property name.

Method Detail

isPropPrivateAtCreation

protected 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 VSRelativeReference<VSComponent>

Returns:

false, always.

appendPropValue

protected void appendPropValue(PropMgr propertyManager,
                               Transaction trans,
                               Object value)

Appends the string property value. If uninitialized, an empty string is appended.

Overrides:

appendPropValue in class StringProp

Parameters:

propertyManager - the property manager instance.

trans - transaction to append the properties to.

value - the value to append to the transaction, a reference to the current property value.

initializeValue

public boolean initializeValue(PropMgr propertyManager,
                               Transaction trans)
                        throws PropException

Initializes the property value from a transaction.

Overrides:

initializeValue in class StringProp

Parameters:

propertyManager - the property manager.

trans - the transaction to initialize the property with.

Returns:

true if the value has changed, false otherwise.

Throws:

PropException

getPropertyClass

public Class<VSComponent> getPropertyClass()

Gets the class wanted.

Specified by:

getPropertyClass in class VSRelativeReference<VSComponent>

getReferenceDescription

public String getReferenceDescription()

Gets a short description of this reference, e.g. "VirtualSpace" or "Label For".

Specified by:

getReferenceDescription in interface IPropReference

Specified by:

getReferenceDescription in class VSRelativeReference<VSComponent>

Returns:

The reference description string.

onResolved

protected void onResolved(VSComponent target)

Called when the property reference has been resolved.

Specified by:

onResolved in class VSRelativeReference<VSComponent>

Parameters:

target - The target reference.

onRemoved

protected void onRemoved(VSComponent 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<VSComponent>

Parameters:

oldTarget - The old target reference.

onRemoteEvent

public void onRemoteEvent(RemoteEvent event)

Remote event to invoke the action or set focus to the VS component.

Specified by:

onRemoteEvent in interface IGProp<String>

Overrides:

onRemoteEvent in class GProp<String>

Parameters:

event - The remote event.