Package com.iizix.prop
Class SelectorReference
- java.lang.Object
- com.iizix.prop.GProp<ReferenceString>
- com.iizix.prop.AbstractReference<TARGET>
- com.iizix.prop.FixedVirtualizedAbstractReference<Selector>
- com.iizix.prop.SelectorReference
- All Implemented Interfaces:
EventListener
,ICircularRetargetParent
,IGProp<ReferenceString>
,IPropReference
,java.lang.Cloneable
- Direct Known Subclasses:
EditorSelectorReference
public class SelectorReference extends FixedVirtualizedAbstractReference<Selector>
The SelectorReference property class hold the reference to a Selector that defines if the owner of this reference should be selected or active, or if it should be inactive.- 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.FixedVirtualizedAbstractReference
fixedTarget
Fields inherited from class com.iizix.prop.AbstractReference
ERROR_ID, hasBeenValidated, QUICK_FIX_DELETE_PROP, reference
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 SelectorReference()
Creates a Selector Reference property with no name and with a null value.SelectorReference(Atom propertyAtom)
Creates a Selector Reference property with the specified name with a null value.SelectorReference(Atom propertyAtom, java.lang.String newValue)
Creates a Selector Reference property with the specified name and value.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Class<?>
getPropertyClass()
Gets the class wanted.java.lang.String
getReferenceDescription()
Gets a short description of this reference.Selector
getSelector()
Gets the Selector for this reference.protected boolean
isPropPrivateAtCreation()
Called upon creation of the property to check it's private state.boolean
isReferenceValid(GProp<?> property)
Validates the property reference that has been looked up.boolean
isSelectorSelected(EnvProps envProps)
Verifies if this selector reference causes the owner to be selected or not.Methods inherited from class com.iizix.prop.FixedVirtualizedAbstractReference
clearFixedTarget, getFixedTarget, informClearError, informError, informResolved, onBroken, onReferenceDisposed, onResolved, onVirtualizationCompleted, onVirtualized
Methods inherited from class com.iizix.prop.AbstractReference
appendPropValue, assignError, assignNotFoundError, changeReference, checkCreateReference, clearError, clone, createUpdateReference, disposeReference, doPostResolve, equalsErrors, equalValues, getAbsoluteReference, getLookupPropReference, getPropValue0, getReference, getReferences, getReferenceString, getTargetReference, getTargetReference, getValueClasses, initializeValue, isValid, onEventSelf, onProjectNameChanged, onPropDispose, onPropParentChanged, onRefactored, onReferenceEvent, onReferenceEvent, setLookedUpReference, setPropValue, toNativeValue0, updateReference, validatePropType, validateReferenceScope, wouldValidate
Methods inherited from class com.iizix.prop.GProp
addPropError, addPropListener, convertPropError, dispose, equals, equals, equalsObj, equalsPropValue, equalsTree, 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
SelectorReference
public SelectorReference()
Creates a Selector Reference property with no name and with a null value.
SelectorReference
public SelectorReference(Atom propertyAtom)
Creates a Selector Reference property with the specified name with a null value.- Parameters:
propertyAtom
- the property atom.
SelectorReference
public SelectorReference(Atom propertyAtom, java.lang.String newValue)
Creates a Selector Reference property with the specified name and value.- Parameters:
propertyAtom
- the property atom.newValue
- the new string value for the property.
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 classGProp<ReferenceString>
- Returns:
- true, always.
getReferenceDescription
public java.lang.String getReferenceDescription()
Gets a short description of this reference.- Specified by:
getReferenceDescription
in interfaceIPropReference
- Specified by:
getReferenceDescription
in classAbstractReference<Selector>
- Returns:
- "Selector".
getPropertyClass
public java.lang.Class<?> getPropertyClass()
Gets the class wanted.- Specified by:
getPropertyClass
in classAbstractReference<Selector>
- Returns:
- Selector.class.
isReferenceValid
public boolean isReferenceValid(GProp<?> property)
Validates the property reference that has been looked up.- Specified by:
isReferenceValid
in interfaceIPropReference
- Specified by:
isReferenceValid
in classAbstractReference<Selector>
- Parameters:
property
- The property to validate.- Returns:
- true if valid, false otherwise.
getSelector
public Selector getSelector()
Gets the Selector for this reference.The method first attempts to use the resolved mechanism of getting the selector. If this has failed or has not been resolved yet, the property tree will be used to search for it. The latter is, of course, slower.
- Returns:
- The
Selector
instance, ornull
if not found.
isSelectorSelected
public boolean isSelectorSelected(EnvProps envProps)
Verifies if this selector reference causes the owner to be selected or not.- Parameters:
envProps
- The Client Properties for the Client connections.- Returns:
- true if selected, false if unselected or the reference is not resolved.