Package com.iizix.prop.vs
Class VSTableColumnReference
- All Implemented Interfaces:
EventListener
,IGProp<String>
,IPropReference
,IReferencingGProp
,Cloneable
The VirtualSpace Table Column Reference property class hold the name of a Column in a Table.
- Author:
- Christopher Mindus
Nested Class Summary
Nested classes/interfaces inherited from interface com.iizix.prop.IPropReference
IPropReference.IRefType, IPropReference.ReferenceChangeEvent, IPropReference.RefType
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
ConstructorDescriptionCreates a VirtualSpace Reference property with no name and with a null value.VSTableColumnReference
(Atom propertyAtom) Creates a VirtualSpace Reference property with the specified name with a null value.VSTableColumnReference
(Atom propertyAtom, String newValue) Creates a VirtualSpace Reference property with the specified name and value.Method Summary
Modifier and TypeMethodDescriptionclone()
Overrides clone to clear existing reference.protected void
createReference
(GEvent event) Creates the reference.int
Gets the column index in the table.Gets the column name.protected IVSColumnListener
Gets the current listener, i.e.Gets the class wanted.Gets the full reference string.Gets the reference Type.Gets the target VS component.boolean
isReferenceValid
(GProp<?> property) Validates the property reference that has been looked up.void
onReferenceEvent
(PropReference reference, IPropReference.ReferenceChangeEvent event, GEvent triggerEvent) Called when a property reference event occurs.protected void
onRemoved
(VSColumnHeader oldTarget) Called when the property reference has been disposed of e.g.protected void
onResolved
(VSColumnHeader target) Called when the property reference has been resolved.protected void
onVSReferenceChanged
(GEvent event) Rechecks the reference, the VSReference has changed.protected String
Returns the parameter string representing the state of this event.void
Resolves the reference.protected void
Sets as invalid.Methods inherited from class com.iizix.prop.vs.VSRelativeReference
addError, clearError, disposeReference, equalsErrors, getVSTarget, isPropPrivateAtCreation, onEventSelf, onPropDispose, onPropParentChanged, onReferenceEvent, onVirtualizationCompleted, resolve, targetChanged, virtualize
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, 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, 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, warning
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.iizix.prop.IReferencingGProp
getDirectReferencedTarget, getDirectReferencedTargetSet, getParent, getReferencingOwner, isReferencingMultipleTargets
Constructor Details
VSTableColumnReference
public VSTableColumnReference()Creates a VirtualSpace Reference property with no name and with a null value.VSTableColumnReference
Creates a VirtualSpace Reference property with the specified name with a null value.- Parameters:
propertyAtom
- the property atom.
VSTableColumnReference
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 Details
clone
Overrides clone to clear existing reference.- Overrides:
clone
in classVSRelativeReference<VSColumnHeader>
- Returns:
- A new cloned String property.
getColumnName
Gets the column name.- Returns:
- The column name, or null if not defined.
getColumnIndex
public int getColumnIndex()Gets the column index in the table.- Returns:
- The column index, or -1 if reference is not resolved.
resolve
Resolves the reference.- Overrides:
resolve
in classVSRelativeReference<VSColumnHeader>
- Parameters:
doReCheck
- Performs a re-check in case e.g. reference class type changes.event
- The triggering event, null for none.
getReference
Gets the full reference string.- Overrides:
getReference
in classVSRelativeReference<VSColumnHeader>
- Returns:
- The full reference string, or another reference string for failure in case it cannot be retrieved, or null for no reference defined.
onVSReferenceChanged
Rechecks the reference, the VSReference has changed.- Overrides:
onVSReferenceChanged
in classVSRelativeReference<VSColumnHeader>
setInvalid
protected void setInvalid()Sets as invalid.- Overrides:
setInvalid
in classVSRelativeReference<VSColumnHeader>
createReference
Creates the reference.- Overrides:
createReference
in classVSRelativeReference<VSColumnHeader>
onReferenceEvent
public void onReferenceEvent(PropReference reference, 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 interfaceIPropReference
- Overrides:
onReferenceEvent
in classVSRelativeReference<VSColumnHeader>
- Parameters:
reference
- The property reference object.event
- The event.triggerEvent
- The event that triggered this reference event, null for none.
getVSColumnHeader
Gets the target VS component.- Returns:
- The target resolved, null for none (or not a valid reference).
isReferenceValid
Validates the property reference that has been looked up. Override to provide additional functionality than checking for property class type matching with
.getPropertyClass()
- Specified by:
isReferenceValid
in interfaceIPropReference
- Overrides:
isReferenceValid
in classVSRelativeReference<VSColumnHeader>
- Parameters:
property
- The property to validate.- Returns:
- true if valid, false otherwise.
getReferenceType
Gets the reference Type.- Specified by:
getReferenceType
in interfaceIPropReference
- Specified by:
getReferenceType
in interfaceIReferencingGProp
- Specified by:
getReferenceType
in classVSRelativeReference<VSColumnHeader>
- Returns:
IPropReference.RefType.VSTableColumn
.
getPropertyClass
Gets the class wanted.- Specified by:
getPropertyClass
in classVSRelativeReference<VSColumnHeader>
getCurrentListener
Gets the current listener, i.e. the parent property.- Returns:
- The current listener, or null for none.
onResolved
Called when the property reference has been resolved.- Specified by:
onResolved
in classVSRelativeReference<VSColumnHeader>
- 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:
onRemoved
in classVSRelativeReference<VSColumnHeader>
- 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:
paramString
in classVSRelativeReference<VSColumnHeader>
- Returns:
- the parameter string of this event.