java.lang.Object

com.iizix.prop.GProp<GProp<?>[]>

com.iizix.prop.PropCnr

com.iizix.prop.Selector

All Implemented Interfaces:: EventListener, IGProp<GProp<?>[]>, IPropCnr, IReferencingPropCnr, ISelectorExpression, Cloneable

Direct Known Subclasses:: EditorSelector

public class Selector extends PropCnr implements ISelectorExpression, IReferencingPropCnr

The Selector class is used to enable or disable participants such as panels, text tables and translation tables, perhaps images.

Field Summary
Fields
Modifier and Type
Field
Description
static final Selector[]
EMPTY
Empty array of selectors.
Fields inherited from class com.iizix.prop.PropCnr
EMPTY_CLASSES, EMPTY_CNRS, EXTENDS_FRAMEWORK_ERROR_ID
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_INCLUDE_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
Selector()
Creates the Selector property container without a name.
Selector(Atom propertyAtom)
Creates the Selector property container with the specified name.
Method Summary
Modifier and Type
Method
Description
Selector
clone()
Creates a clone out of this property.
protected ClassReference
createClassReference(Atom atom, String ref)
Creates a ClassReference, overridden by the Designer version of the class.
protected SelectorExpression
createSelectorExpression(String expression)
Creates the SelectorExpression, overridden by the Designer version of the class.
protected SelectorReference
createSelectorReference(Atom atom, String ref)
Creates a SelectorReference, overridden by the Designer version of the class.
ISelectorExpression
getJavaClassInstance(String className)
In Server run mode, gets the class name instance object created.
IPropReference.IRefType
getReferenceType()
Gets the reference Type.
IReferencingGProp
getReferencingProp()
Gets the single potential instance of a referencing property instance.
IReferencingGProp[]
getReferencingProps()
Gets the array of referencing property instances.
SelectorExpression
getSelectorExpression(boolean doParse)
Gets the selector expression.
SelectorReference[]
getSelectorReferences()
Gets the target Selector references for this Selector.
boolean
isSelected(EnvProps envProps)
Called to resolve the SelectorExpression.
void
onEventSelf(GEvent event)
Checks for expression changes to define references.
protected void
onExpressionChanged(SelectorExpression expression)
Called when the expression has changed.
protected void
onPropParentChanged(PropCnr oldParent, PropCnr newParent)
Verify when loaded/created.
boolean
usesMultipleReferencing()
Checks if this referencing Property Container has single or multiple referencing properties at maximum.
boolean
verify(PropVerification verification)
Verifies this property container.
Methods inherited from class com.iizix.prop.PropCnr
__transferChildProps, addPredefinedProps, addProp, addProp, addProp2, addProp2, appendPropValue, canRequestFocus, completeVirtualize, containsProp, containsProp, convertLoadedProp, couldRequestFocusIfVirtualized, createCopyOfAtom, createUniqueAtom, createUniqueAtom, createUniqueAtom, createVSReference, doPropEqualsArrayValues, enablePropCommunication, enablePropHashMap, equalsTree, equalsTree, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getBool, getBool, getBool, getBool, getChildPropError, getChildPropError, getChildPropErrorSeverity, getChildPropErrorSeverity, getErrorsProp, getExtendsContainer, getExtendsError, getExtendsName, getExtendsOverride, getExtendsPossibleClasses, getFirstProp, getFirstProp, getFocusEngine, getInt, getInt, getInt, getInt, getLong, getLong, getLong, getLong, getNumber, getNumber, getNumber, getNumber, getPossibleChildren, getPredefinedProps, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getPropBaseReference, getPropCnr, getPropCount, getPropCount, getPropIndex, getPropIndex, getPropIndexes, getProps, getProps, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue0, getRetargetedVerifyContainer, getString, getString, getString, getString, getValueClasses, getVSReference, hasFocus, hasSendData, initializeElement, initializeExtendsFramework, initializeProp, initializeValue, initPropCnr, insertProp, insertProp2, isChild, isExtendsOverriden, isExtendsPropertyValid, isExtendsRoot, isPropAddRemoveAllowed, isPropCommunicating, isPropExtended, list, list, logPropNotFound, maybeAddProp, onInsertProp, onPropDispose, onPropRemoved, onPropTreeInitialized, onReferenceEvent, onVirtualContainerCreated, onVirtualizationCompleted, paramString, prepare, removeAllProps, removeAllProps2, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, reorderProps, replaceProps, requestFocus, requestFocus, requestFocusEx, requestFocusEx, resolveReferences, resolveRuntimeReferences, setBool, setBool, setBool, setBool, setCreateRequiredProp, setExtendsName, setExtendsOverride, setInt, setInt, setInt, setLong, setLong, setLong, setLong, setNumber, setNumber, setNumber, setNumber, setProp, setProp, setProp, setProp2, setProp2, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setString, setString, setString, setString, shouldCreateProps, shouldSerializeToXML, toElementString, toNativeValue0, usePropHashMap, usesPropIndex, validateChildPropInValue, validateClassInstances, validatePropType, validatePropValue, verifyInternalUseOnly, verifyTree, virtualize
Methods inherited from class com.iizix.prop.GProp
addPropError, addPropListener, appendProp, convertPropError, dispose, equals, equals, equalsErrors, equalsObj, equalsPropValue, 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, 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, hasChanged, hasCircularReferencesError, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropForEditor, isPropNullable, isPropPrivate, isPropPrivateAtCreation, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropRootLoading, isPropRootTreeModificationsAllowed, isPropUSER, isPropValueTreeLockNeeded, isPropVirtualized, isPropVirtualizing, isPropVolatile, isPropVolatileOrEditorOnly, isProxied, isSibling, list, list, list, mapAliasToReference, mapAliasToReference, mapReferenceToAlias, mapReferenceToAlias, mapReferenceToProjectRelative, modifyPropValue, moveProp, moveProp, moveProp, onEvent, onPrepare, onPropInvalidateCache, onPropValueSet, onRemoteEvent, paramString, paramValue, post, post, removePropError, removePropListener, removePropUSER, renameProp, renameProp2, resetChangedTree, setChanged, setConstraints, setConstraints, setParent, setPrivateChangeEventProp, setPrivateCreateRequiredProp, setPropError, setPropErroredName, setPropExtended, setPropExtendsFinal, setPropExtendsPrivate, setPropForEditor, setPropNullable, setPropPrivate, setPropReadOnly, setPropUSER, setPropValue, setPropValue, setPropValue, setPropValueIncognito, setPropVolatile, severe, severe, severe, shouldSerializeToXML, throwIfReadOnly, toNativeValue, toString, toString, triggerRemoteEvent, triggerRemoteEvent, validateProp, warning, warning, warning
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.iizix.prop.IGProp
addPropError, addPropListener, dispose, equals, fine, fine, finer, finer, finest, finest, fromElementString, getAppSessionGyro, getAtomPath, getClientSessionGyro, getConstraints, getEnvironment, getErroredPropItems, getErroredProps, getErrorsProp, getExtendsRootContainer, getFullPropName, getFullPropNameDebug, getModuleFolder, getModuleFolder, getParent, getParent, getPropAtom, getPropBaseReference, getPropError, getPropError, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getReferencePropName, getRelativePropName, getRootParent, getTreeLock, getValueClasses, getVSReference, hasChanged, hasCircularReferencesError, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCommunicating, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropNullable, isPropPrivate, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropVirtualized, isSibling, list, list, list, list, list, mapAliasToReference, mapReferenceToAlias, mapReferenceToProjectRelative, moveProp, moveProp, moveProp, onEvent, onPropTreeInitialized, onRemoteEvent, removePropError, removePropListener, renameProp, resolveRuntimeReferences, setChanged, setConstraints, setConstraints, setParent, setPrivateChangeEventProp, setPropError, setPropExtendsFinal, setPropExtendsPrivate, setPropNullable, setPropPrivate, setPropReadOnly, setPropValue, setPropValue, severe, severe, severe, toElementString, toNativeValue, triggerRemoteEvent, triggerRemoteEvent, validateProp, validatePropType, validatePropValue, warning, warning, warning
Methods inherited from interface com.iizix.prop.IPropCnr
addProp, addProp, addProp2, addProp2, canRequestFocus, canRequestFocus, canRequestFocus, containsProp, containsProp, couldRequestFocusIfVirtualized, couldRequestFocusIfVirtualized, couldRequestFocusIfVirtualized, createCopyOfAtom, createUniqueAtom, createUniqueAtom, enablePropCommunication, enablePropHashMap, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getBool, getBool, getBool, getBool, getChildPropError, getChildPropError, getChildPropErrorSeverity, getChildPropErrorSeverity, getErrorsProp, getExtendsError, getExtendsName, getExtendsPossibleClasses, getFirstProp, getFirstProp, getFocusEngine, getInt, getInt, getInt, getInt, getLong, getLong, getLong, getLong, getNumber, getNumber, getNumber, getNumber, getPossibleChildren, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getPropCnr, getPropCount, getPropIndex, getPropIndex, getPropIndexes, getProps, getProps, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getString, getString, getString, getString, hasFocus, initializeExtendsFramework, insertProp, insertProp2, isChild, isExtendsOverriden, isExtendsRoot, isPropAddRemoveAllowed, isPropExtended, removeAllProps, removeAllProps2, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, reorderProps, requestFocus, requestFocusEx, setBool, setBool, setBool, setBool, setExtendsName, setExtendsOverride, setInt, setInt, setInt, setLong, setLong, setLong, setLong, setNumber, setNumber, setNumber, setNumber, setProp, setProp, setProp, setProp2, setProp2, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setString, setString, setString, setString, usePropHashMap, usesPropIndex, validateClassInstances

Field Details
- EMPTY
  public static final Selector[] EMPTY
  Empty array of selectors.
Constructor Details
- Selector
  public Selector()
  Creates the Selector property container without a name. The name must be set in all cases using the setPropertyAtom call.
- Selector
  public Selector(Atom propertyAtom)
  Creates the Selector property container with the specified name. All system-reserved names for components begins with "$".
  Parameters:
  propertyAtom - the name of the component, unique within it's parent.
Method Details
- clone
  public Selector clone()
  Creates a clone out of this property. The cloning is overridden by the subclasses in order to handle cloning of its class variables appropriately.
  Overrides:
  clone in class PropCnr
- onEventSelf
  public void onEventSelf(GEvent event)
  Checks for expression changes to define references.
  Specified by:
  onEventSelf in interface IGProp<GProp<?>[]>
  Overrides:
  onEventSelf in class GProp<GProp<?>[]>
  Parameters:
  event - The property event.
- onPropParentChanged
  protected void onPropParentChanged(PropCnr oldParent, PropCnr newParent)
  Verify when loaded/created.
  Overrides:
  onPropParentChanged in class GProp<GProp<?>[]>
  Parameters:
  oldParent - The old parent (or null if none).
  newParent - The new parent (or null if none).
- isSelected
  public boolean isSelected(EnvProps envProps)
  Called to resolve the SelectorExpression.
  This method will return false if there are errors present in the Selector such as circular or unresolved references.
  Specified by:
  isSelected in interface ISelectorExpression
  Parameters:
  envProps - The Client Environment properties.
  Returns:
  true if the Selector is selected to be used and does not contain errors, false otherwise.
- createSelectorExpression
  protected SelectorExpression createSelectorExpression(String expression)
  Creates the SelectorExpression, overridden by the Designer version of the class.
  Parameters:
  expression - The reference.
- createClassReference
  protected ClassReference createClassReference(Atom atom, String ref)
  Creates a ClassReference, overridden by the Designer version of the class.
  Parameters:
  atom - The atom name.
  ref - The reference.
- createSelectorReference
  protected SelectorReference createSelectorReference(Atom atom, String ref)
  Creates a SelectorReference, overridden by the Designer version of the class.
  Parameters:
  atom - The atom name.
  ref - The reference.
- getSelectorExpression
  public SelectorExpression getSelectorExpression(boolean doParse)
  Gets the selector expression. If the expression already has been parsed successfully, that expression instance is returned.
  Parameters:
  doParse - Flag to return the expression parsed, with error logging.
  Note: if the expression cannot be parsed, null is returned.
  Returns:
  The selector expression if it defined and can be parsed, null otherwise.
- getJavaClassInstance
  public ISelectorExpression getJavaClassInstance(String className)
  In Server run mode, gets the class name instance object created. If the class name is not found in the references or by resolving the class name, an error is logged.
  Parameters:
  className - The class name.
  Returns:
  The instance, or null for failure.
- getReferenceType
  public IPropReference.IRefType getReferenceType()
  Gets the reference Type.
  Specified by:
  getReferenceType in interface IReferencingPropCnr
  Returns:
  IPropReference.RefType.Selector.
- usesMultipleReferencing
  public boolean usesMultipleReferencing()
  Checks if this referencing Property Container has single or multiple referencing properties at maximum.
  Specified by:
  usesMultipleReferencing in interface IReferencingPropCnr
  Returns:
  Always true for multiple references to retrieve the referencing properties using the method getReferencingProps().
- getReferencingProp
  public IReferencingGProp getReferencingProp()
  Gets the single potential instance of a referencing property instance.
  Specified by:
  getReferencingProp in interface IReferencingPropCnr
  Returns:
  Always null as there is no single referencing property. Use the method getReferencingProps() to retrieve the referencing properties.
- getReferencingProps
  public IReferencingGProp[] getReferencingProps()
  Gets the array of referencing property instances.
  Specified by:
  getReferencingProps in interface IReferencingPropCnr
  Returns:
  The array of referencing properties, or null none is found. The array may also be empty.
- onExpressionChanged
  protected void onExpressionChanged(SelectorExpression expression)
  Called when the expression has changed.
- getSelectorReferences
  public SelectorReference[] getSelectorReferences()
  Gets the target Selector references for this Selector.
  Returns:
  The target Selector references or null if not found.
- verify
  public boolean verify(PropVerification verification)
  Verifies this property container. The check performed is the extension of classes and that no circular reference is present.
  Specified by:
  verify in interface IGProp<GProp<?>[]>
  Overrides:
  verify in class PropCnr
  Parameters:
  verification - The property verification class.
  Returns:
  true if verification should proceed, false if disposed of and verification should not take place.

Class Selector

Field Summary

Fields inherited from class com.iizix.prop.PropCnr

Fields inherited from class com.iizix.prop.GProp

Fields inherited from interface com.iizix.prop.IGProp

Constructor Summary

Method Summary

Methods inherited from class com.iizix.prop.PropCnr

Methods inherited from class com.iizix.prop.GProp

Methods inherited from class java.lang.Object

Methods inherited from interface com.iizix.prop.IGProp

Methods inherited from interface com.iizix.prop.IPropCnr

Field Details

EMPTY

Constructor Details

Selector

Selector

Method Details

clone

onEventSelf

onPropParentChanged

isSelected

createSelectorExpression

createClassReference

createSelectorReference

getSelectorExpression

getJavaClassInstance

getReferenceType

usesMultipleReferencing

getReferencingProp

getReferencingProps

onExpressionChanged

getSelectorReferences

verify