Package com.iizix.prop

Class Selector

java.lang.Object

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

com.iizix.prop.PropCnr

com.iizix.prop.Selector

All Implemented Interfaces:

EventListener, IGProp<GProp<?>[]>, IPropCnr, ISelectorExpression, java.lang.Cloneable

Direct Known Subclasses:

EditorSelector

public class Selector
extends PropCnr
implements ISelectorExpression

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 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_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, java.lang.String ref)	Creates a ClassReference, overridden by the Designer version of the class.
protected SelectorExpression	createSelectorExpression(java.lang.String expression)	Creates the SelectorExpression, overridden by the Designer version of the class.
protected SelectorReference	createSelectorReference(Atom atom, java.lang.String ref)	Creates a SelectorReference, overridden by the Designer version of the class.
ISelectorExpression	getJavaClassInstance(java.lang.String className)	In Server run mode, gets the class name instance object created.
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.
void	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, doVirtualizePropCnr, 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, getPropBaseReference, getPropCnr, getPropCount, getPropCount, getPropIndex, getPropIndex, getPropIndexes, getProps, getProps, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue0, getReferences, getRetargetedVerifyContainer, getString, getString, getString, getString, getValueClasses, getVSReference, hasFocus, hasSendData, initializeElement, initializeExtendsFramework, initializeProp, initializeValue, initPropCnr, insertProp, insertProp2, isChild, isExtendsOverriden, isExtendsPropertyValid, isExtendsRoot, isPropAddRemoveAllowed, isPropCommunicating, isPropExtended, isSibling, list, list, logPropNotFound, maybeAddProp, onInsertProp, onPropDispose, onPropRemoved, onPropTreeInitialized, onReferenceEvent, paramString, prepare, removeAllProps, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, 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, convertPropError, dispose, equals, equals, equalsErrors, equalsObj, equalsPropValue, 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, getParent, getParent, getProjectName, getPropAtom, 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, hasChanged, 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, isPropUSER, isPropValueTreeLockNeeded, isPropVirtualized, isPropVirtualizing, isPropVolatile, isPropVolatileOrEditorOnly, isProxied, list, list, list, mapAliasToReference, mapAliasToReference, mapReferenceToAlias, mapReferenceToAlias, mapReferenceToProjectRelative, modifyPropValue, moveProp, moveProp, moveProp, onEvent, onPrepare, onPropInvalidateCache, onPropValueSet, onRemoteEvent, onVirtualizationCompleted, onVirtualized, 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, verifyHasPropertyItem, 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, getParent, getParent, getPropAtom, getPropError, getPropError, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getReferencePropName, getRelativePropName, getRootParent, getTreeLock, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropNullable, isPropPrivate, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropVirtualized, list, list, list, mapAliasToReference, mapReferenceToAlias, mapReferenceToProjectRelative, moveProp, moveProp, moveProp, onEvent, onRemoteEvent, removePropError, removePropListener, renameProp, setChanged, setConstraints, setConstraints, setParent, setPrivateChangeEventProp, setPropError, setPropExtendsFinal, setPropExtendsPrivate, setPropNullable, setPropPrivate, setPropReadOnly, setPropValue, setPropValue, severe, severe, severe, toNativeValue, triggerRemoteEvent, triggerRemoteEvent, validateProp, verifyHasPropertyItem, warning, warning, warning

Methods inherited from interface com.iizix.prop.IPropCnr

canRequestFocus, canRequestFocus, couldRequestFocusIfVirtualized, couldRequestFocusIfVirtualized

Field Detail

EMPTY

public static final Selector[] EMPTY

Empty array of selectors.

Constructor Detail

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 Detail

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(java.lang.String expression)

Creates the SelectorExpression, overridden by the Designer version of the class.

Parameters:

expression - The reference.

createClassReference

protected ClassReference createClassReference(Atom atom,
                                              java.lang.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,
                                                    java.lang.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(java.lang.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.

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 void 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.