Package com.iizix.prop.vs
Class VSTableColumnReference
- java.lang.Object
- com.iizix.prop.GProp<java.lang.String>
- com.iizix.prop.StringProp
- com.iizix.prop.vs.VSRelativeReference<VSColumnHeader>
- com.iizix.prop.vs.VSTableColumnReference
- All Implemented Interfaces:
EventListener,ICircularRetargetParent,IGProp<java.lang.String>,IPropReference,java.lang.Cloneable
public class VSTableColumnReference extends VSRelativeReference<VSColumnHeader>
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.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 Description VSTableColumnReference()Creates 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, java.lang.String newValue)Creates a VirtualSpace Reference property with the specified name and value.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description VSTableColumnReferenceclone()Overrides clone to clear existing reference.protected voidcreateReference(GEvent event)Creates the reference.intgetColumnIndex()Gets the column index in the table.java.lang.StringgetColumnName()Gets the column name.protected IVSColumnListenergetCurrentListener()Gets the current listener, i.e.java.lang.Class<? extends GProp<?>>getPropertyClass()Gets the class wanted.java.lang.StringgetReference()Gets the full reference string.java.lang.StringgetReferenceDescription()Gets a short description of this reference, e.g.VSColumnHeadergetVSColumnHeader()Gets the target VS component.booleanisReferenceValid(GProp<?> property)Validates the property reference that has been looked up.voidonReferenceEvent(PropReference reference, IPropReference.ReferenceChangeEvent event, GEvent triggerEvent)Called when a property reference event occurs.protected voidonRemoved(VSColumnHeader oldTarget)Called when the property reference has been disposed of e.g.protected voidonResolved(VSColumnHeader target)Called when the property reference has been resolved.protected voidonVSReferenceChanged(GEvent event)Rechecks the reference, the VSReference has changed.voidresolve(boolean doReCheck, GEvent event)Resolves the reference.protected voidsetInvalid()Sets as invalid.Methods inherited from class com.iizix.prop.vs.VSRelativeReference
addError, clearError, disposeReference, equalsErrors, getReferences, getVSTarget, isPropPrivateAtCreation, onEventSelf, onPropDispose, onPropParentChanged, onReferenceEvent, onVirtualizationCompleted, onVirtualized, resolve, 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, 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, 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
VSTableColumnReference
public VSTableColumnReference()
Creates a VirtualSpace Reference property with no name and with a null value.
VSTableColumnReference
public VSTableColumnReference(Atom propertyAtom)
Creates a VirtualSpace Reference property with the specified name with a null value.- Parameters:
propertyAtom- the property atom.
VSTableColumnReference
public VSTableColumnReference(Atom propertyAtom, java.lang.String newValue)
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 Detail
clone
public VSTableColumnReference clone()
Overrides clone to clear existing reference.- Overrides:
clonein classVSRelativeReference<VSColumnHeader>- Returns:
- A new cloned String property.
getColumnName
public java.lang.String 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
public void resolve(boolean doReCheck, GEvent event)Resolves the reference.- Overrides:
resolvein classVSRelativeReference<VSColumnHeader>- Parameters:
doReCheck- Performs a re-check in case e.g. reference class type changes.event- The triggering event, null for none.
getReference
public java.lang.String getReference()
Gets the full reference string.- Overrides:
getReferencein 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
protected void onVSReferenceChanged(GEvent event)
Rechecks the reference, the VSReference has changed.- Overrides:
onVSReferenceChangedin classVSRelativeReference<VSColumnHeader>
setInvalid
protected void setInvalid()
Sets as invalid.- Overrides:
setInvalidin classVSRelativeReference<VSColumnHeader>
createReference
protected void createReference(GEvent event)
Creates the reference.- Overrides:
createReferencein 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:
onReferenceEventin interfaceIPropReference- Overrides:
onReferenceEventin classVSRelativeReference<VSColumnHeader>- Parameters:
reference- The property reference object.event- The event.triggerEvent- The event that triggered this reference event, null for none.
getVSColumnHeader
public VSColumnHeader getVSColumnHeader()
Gets the target VS component.- Returns:
- The target resolved, null for none (or not a valid reference).
isReferenceValid
public boolean isReferenceValid(GProp<?> property)
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:
isReferenceValidin interfaceIPropReference- Overrides:
isReferenceValidin classVSRelativeReference<VSColumnHeader>- Parameters:
property- The property to validate.- Returns:
- true if valid, false otherwise.
getReferenceDescription
public java.lang.String getReferenceDescription()
Gets a short description of this reference, e.g. "VirtualSpace" or "Label For".- Specified by:
getReferenceDescriptionin interfaceIPropReference- Specified by:
getReferenceDescriptionin classVSRelativeReference<VSColumnHeader>- Returns:
- The reference description string.
getPropertyClass
public java.lang.Class<? extends GProp<?>> getPropertyClass()
Gets the class wanted.- Specified by:
getPropertyClassin classVSRelativeReference<VSColumnHeader>
getCurrentListener
protected IVSColumnListener getCurrentListener()
Gets the current listener, i.e. the parent property.- Returns:
- The current listener, or null for none.
onResolved
protected void onResolved(VSColumnHeader target)
Called when the property reference has been resolved.- Specified by:
onResolvedin classVSRelativeReference<VSColumnHeader>- Parameters:
target- The target reference.
onRemoved
protected void onRemoved(VSColumnHeader oldTarget)
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<VSColumnHeader>- Parameters:
oldTarget- The old target reference.