Package com.iizix.prop.vs
Class VSOnUIEvent
- All Implemented Interfaces:
EventListener,IGProp<String>,IPropReference,IReferencingGProp,Cloneable
- Direct Known Subclasses:
EditorVSOnUIEvent
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.IRefType, IPropReference.ReferenceChangeEvent, IPropReference.RefTypeField Summary
Fields inherited from class com.iizix.prop.vs.VSRelativeReference
currentTarget, fixedTarget, reference, vsRefBaseFields 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_2Fields inherited from interface com.iizix.prop.IGProp
EQC_ERROR_IGNORE_ALL, EQC_ERROR_IGNORE_REFERENCES, EQC_IGNORE_ARRAY, EQC_IGNORE_VOLATILE_OR_EDITOR, EQC_INCLUDE_PRIVATE, EQC_SAVE_FILE, EXT_CONTAINER_EXTENDS, EXT_CONTAINER_EXTENDS_VALID, EXT_EXTENDED, EXT_FINAL, EXT_OVERRIDES, EXT_OVERRIDES_FINAL_ERR, EXT_PRIVATEConstructor Summary
ConstructorsConstructorDescriptionCreates the event listener property without name.VSOnUIEvent(Atom atom) Creates the event listener property.Method Summary
Modifier and TypeMethodDescriptionprotected voidappendPropValue(PropMgr propertyManager, SendTransaction trans, Object value) Appends the string property value.Gets the class wanted.Gets the reference Type.booleaninitializeValue(PropMgr propertyManager, ReadTransaction trans) Initializes the property value from a transaction.protected booleanCalled upon creation of the property to check it's private state.voidonRemoteEvent(RemoteEvent event) Remote event to invoke the action or set focus to the VS component.protected voidonRemoved(VSComponent oldTarget) Called when the property reference has been disposed of e.g.protected voidonResolved(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, getVSTarget, isReferenceValid, onEventSelf, onPropDispose, onPropParentChanged, onReferenceEvent, onReferenceEvent, onVirtualizationCompleted, onVSReferenceChanged, paramString, resolve, resolve, setInvalid, targetChanged, virtualizeMethods inherited from class com.iizix.prop.StringProp
getPropValue0, getString, getString, getValueClasses, setPropValue, toNativeValue0, validatePropTypeMethods inherited from class com.iizix.prop.GProp
addPropError, addPropListener, appendProp, convertPropError, dispose, equals, equals, equalsObj, equalsPropValue, equalsTree, equalValues, 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, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropRootLoading, isPropRootTreeModificationsAllowed, isPropUSER, isPropValueTreeLockNeeded, isPropVirtualized, isPropVirtualizing, isPropVolatile, isPropVolatileOrEditorOnly, isProxied, isSibling, 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, warning, warning, warningMethods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.iizix.prop.IReferencingGProp
getDirectReferencedTarget, getDirectReferencedTargetSet, getParent, getReferencingOwner, isReferencingMultipleTargets
Constructor Details
VSOnUIEvent
public VSOnUIEvent()Creates the event listener property without name.VSOnUIEvent
Creates the event listener property.- Parameters:
atom- The property name.
Method Details
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:
isPropPrivateAtCreationin classVSRelativeReference<VSComponent>- Returns:
- false, always.
appendPropValue
Appends the string property value. If uninitialized, an empty string is appended.- Overrides:
appendPropValuein classStringProp- 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
Initializes the property value from a transaction.- Overrides:
initializeValuein classStringProp- 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
Gets the class wanted.- Specified by:
getPropertyClassin classVSRelativeReference<VSComponent>
getReferenceType
Gets the reference Type.- Specified by:
getReferenceTypein interfaceIPropReference- Specified by:
getReferenceTypein interfaceIReferencingGProp- Specified by:
getReferenceTypein classVSRelativeReference<VSComponent>- Returns:
IPropReference.RefType.VSOnUIEvent.
onResolved
Called when the property reference has been resolved.- Specified by:
onResolvedin classVSRelativeReference<VSComponent>- Parameters:
target- The target reference.
onRemoved
Called when the property reference has been disposed of e.g. due to new reference or pure disposal of this property.- Specified by:
onRemovedin classVSRelativeReference<VSComponent>- Parameters:
oldTarget- The old target reference.
onRemoteEvent
Remote event to invoke the action or set focus to the VS component.- Specified by:
onRemoteEventin interfaceIGProp<String>- Overrides:
onRemoteEventin classGProp<String>- Parameters:
event- The remote event.