Package com.iizix.prop.vs
Class VSComponentReference
- All Implemented Interfaces:
EventListener,IGProp<String>,IPropReference,IReferencingGProp,Cloneable
VS component reference implementation that calls the parent property when changes occurs in the resolved VS component when changes of the VS component (value or contents) occurs. The parent property must implement the interface
IVSFieldListenerVSField references and.... TODO!- 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 a VirtualSpace component reference property with no name and with a null value.VSComponentReference(Atom propertyAtom) Creates a VirtualSpace component reference property with the specified name with a null value.VSComponentReference(Atom propertyAtom, String newValue) Creates a VirtualSpace component reference property with the specified name and value.Method Summary
Modifier and TypeMethodDescriptionclone()Overrides clone to clear existing parent listener.Gets the class wanted.Gets the reference Type.booleanisReferenceValid(GProp<?> property) Validates the property reference that has been looked up.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.protected StringReturns the parameter string representing the state of this event.Methods inherited from class com.iizix.prop.vs.VSRelativeReference
addError, clearError, createReference, disposeReference, equalsErrors, getReference, getVSTarget, isPropPrivateAtCreation, onEventSelf, onPropDispose, onPropParentChanged, onReferenceEvent, onReferenceEvent, onVirtualizationCompleted, onVSReferenceChanged, resolve, resolve, setInvalid, targetChanged, virtualizeMethods inherited from class com.iizix.prop.StringProp
appendPropValue, getPropValue0, getString, getString, getValueClasses, initializeValue, 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, 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, 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
VSComponentReference
public VSComponentReference()Creates a VirtualSpace component reference property with no name and with a null value.VSComponentReference
Creates a VirtualSpace component reference property with the specified name with a null value.- Parameters:
propertyAtom- the property atom.
VSComponentReference
Creates a VirtualSpace component reference property with the specified name and value.- Parameters:
propertyAtom- the property atom.newValue- the new string value for the property.
Method Details
clone
Overrides clone to clear existing parent listener.- Overrides:
clonein classVSRelativeReference<VSComponent>- Returns:
- A new cloned String property.
getPropertyClass
Gets the class wanted.- Specified by:
getPropertyClassin classVSRelativeReference<VSComponent>- Returns:
- The VSComponent.class.
isReferenceValid
Validates the property reference that has been looked up. Override to provide additional functionality than checking for property class type matching withgetPropertyClass()- Specified by:
isReferenceValidin interfaceIPropReference- Overrides:
isReferenceValidin classVSRelativeReference<VSComponent>- Parameters:
property- The property to validate.- Returns:
- true if valid, false otherwise.
getReferenceType
Gets the reference Type.- Specified by:
getReferenceTypein interfaceIPropReference- Specified by:
getReferenceTypein interfaceIReferencingGProp- Specified by:
getReferenceTypein classVSRelativeReference<VSComponent>- Returns:
- The reference type, generally a value from the enum
IPropReference.RefType, otherwise a static final implementation of the reference type with locale support.
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.
paramString
Returns the parameter string representing the state of this event. This string is useful for debugging. Subclasses adds extra information to the string by preceding it with a comma followed by the extra information.- Overrides:
paramStringin classVSRelativeReference<VSComponent>- Returns:
- the parameter string of this event.