Package com.iizix.prop
Class ValueProp
- java.lang.Object
- com.iizix.prop.GProp<Value>
- com.iizix.prop.ValueProp
- All Implemented Interfaces:
EventListener,IGProp<Value>,java.lang.Cloneable
public class ValueProp extends GProp<Value>
The value property holds the VirtualSpace Value object.
Field Summary
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
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidappendPropValue(PropMgr propertyManager, SendTransaction trans, java.lang.Object value)Appends the property value.protected java.lang.ObjectgetPropValue0(java.lang.Object value, int index)Gets the property value in another class form than the "native" one.java.lang.Class<?>[]getValueClasses()Gets the list of possible native Java classes that can be used to set a value usingsetPropertyValue, in order of importance.Value.TypegetValueType()Gets the value type.protected voidinitializeElement(org.w3c.dom.Element element)Called when the XML file for the property tree is serialized from properties.protected voidinitializeProp(org.w3c.dom.Element element)Called to initialize the property from anElement.booleaninitializeValue(PropMgr propertyManager, ReadTransaction trans)Initializes the property value from a transaction.protected voidonPropParentChanged(PropCnr oldParent, PropCnr newParent)If the value property is added in any component that is not a VS field, make it private.protected java.lang.StringparamValue(java.lang.Object value)Formats the value as a string to add toparamString.protected java.lang.ObjecttoNativeValue0(java.lang.Object value, int index)Tries conversion of possibly accepted properties values using thesetPropertyValuemethod into the most preferred property value type.voidvalidatePropType(java.lang.Object newValue)Validates that the value to set is of GColor instance.Methods inherited from class com.iizix.prop.GProp
addPropError, addPropListener, clone, convertPropError, dispose, equals, equals, equalsErrors, 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, getReferences, getRelativePropName, getRootFromName, getRootName, getRootParent, getRootParent, getTreeLock, getVSReference, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCommunicating, 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, list, list, mapAliasToReference, mapAliasToReference, mapReferenceToAlias, mapReferenceToAlias, mapReferenceToProjectRelative, modifyPropValue, moveProp, moveProp, moveProp, onEvent, onEventSelf, onPrepare, onPropDispose, onPropInvalidateCache, onPropTreeInitialized, onPropValueSet, onReferenceEvent, onRemoteEvent, onVirtualizationCompleted, onVirtualized, paramString, 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
Constructor Detail
ValueProp
public ValueProp()
Creates the value property without a name. The name must be set in all cases using thesetPropertyAtomcall.
ValueProp
public ValueProp(Atom propertyAtom)
Creates the value property with the specified name. All system-reserved names for components begins with "$".- Parameters:
propertyAtom- the name of the component, unique within it's parent.
ValueProp
public ValueProp(Atom propertyAtom, Value value) throws PropException
Creates the value property with the specified name. All system-reserved names for components begins with "$".- Parameters:
propertyAtom- the name of the component, unique within it's parent.value- the value.- Throws:
PropException- If property value cannot be set.
Method Detail
getValueType
public Value.Type getValueType()
Gets the value type.- Returns:
- The value type, or null if Value instance is null or unassigned.
appendPropValue
protected void appendPropValue(PropMgr propertyManager, SendTransaction trans, java.lang.Object value)
Appends the property value.This method throws InternalError as the Value is not supposed to be transferred using a Transaction if the remote party is not a JavaScript client.
- Specified by:
appendPropValuein classGProp<Value>- Parameters:
propertyManager- the property manager instance.trans- transaction to append the properties to.value- the value to append to the transaction, a reference to the current property value.
initializeValue
public boolean initializeValue(PropMgr propertyManager, ReadTransaction trans)
Initializes the property value from a transaction.This method throws InternalError as the Value is not supposed to be transferred using a Transaction if the remote party is not a JavaScript client.
- Specified by:
initializeValuein classGProp<Value>- Parameters:
propertyManager- the property manager.trans- the transaction to initialize the property with.- Returns:
- Only throws, no "return".
initializeProp
protected void initializeProp(org.w3c.dom.Element element) throws PropExceptionCalled to initialize the property from anElement. The property should initialize itself from attributes and nodes with appropriate information.- Overrides:
initializePropin classGProp<Value>- Parameters:
element- TheElement.- Throws:
PropException- when the initialization fails.
initializeElement
protected void initializeElement(org.w3c.dom.Element element)
Called when the XML file for the property tree is serialized from properties. The property should fill attributes and nodes with appropriate information.- Overrides:
initializeElementin classGProp<Value>- Parameters:
element- TheElementto initialize.
getValueClasses
public java.lang.Class<?>[] getValueClasses()
Gets the list of possible native Java classes that can be used to set a value usingsetPropertyValue, in order of importance.- Specified by:
getValueClassesin interfaceIGProp<Value>- Specified by:
getValueClassesin classGProp<Value>- Returns:
- The array of Java classes that can be accepted in the
setPropertyValuemethod. The first type is the "native" or most preferred type. The array is at least one item in length and never null.
validatePropType
public void validatePropType(java.lang.Object newValue) throws PropTypeExceptionValidates that the value to set is of GColor instance.Note: When this method is called, synchronization is done at the property itself, so no synchronization on the tree should be done.
- Specified by:
validatePropTypein interfaceIGProp<Value>- Specified by:
validatePropTypein classGProp<Value>- Parameters:
newValue- The new value to set.- Throws:
PropTypeException- when the new value isn't of the correct class.
getPropValue0
protected java.lang.Object getPropValue0(java.lang.Object value, int index) throws java.lang.ExceptionGets the property value in another class form than the "native" one. This method tries conversion of a "native" property value into another class type. This method is used when filling in a POJO variable (Plain Old Java Object Field) from a "native" property value.- Specified by:
getPropValue0in classGProp<Value>- Parameters:
value- The property value.index- The index in the Class array returned bygetValueClasses().- Returns:
- The property value in the requested class, after conversion.
- Throws:
java.lang.Exception- Other exceptions that could occur.
toNativeValue0
protected java.lang.Object toNativeValue0(java.lang.Object value, int index) throws java.lang.ExceptionTries conversion of possibly accepted properties values using thesetPropertyValuemethod into the most preferred property value type. If the input value already is of the preferred type, the same object is returned.- Specified by:
toNativeValue0in classGProp<Value>- Parameters:
value- The input value to convert to native value.index- The index in the array returned bygetValueClasses(), or -1 if not found.- Returns:
- The converted input value in the preferred property value object type.
- Throws:
java.lang.Exception- For conversion exceptions.
paramValue
protected java.lang.String paramValue(java.lang.Object value)
Formats the value as a string to add toparamString. The default is to do "value.toString()" if value is not null, otherwise "[null]" is returned.- Overrides:
paramValuein classGProp<Value>
onPropParentChanged
protected void onPropParentChanged(PropCnr oldParent, PropCnr newParent)
If the value property is added in any component that is not a VS field, make it private.- Overrides:
onPropParentChangedin classGProp<Value>- Parameters:
oldParent- The old parent (or null if none).newParent- The new parent (or null if none).