Class VSField
- All Implemented Interfaces:
- EventListener,- IFocusComp,- IMessageBox,- ICustomDataProvider,- IGProp<GProp<?>[]>,- IPatternOwner,- IPropCnr,- IReferencingPropCnr,- IVSComponent,- IVSComponentListener,- IVSComponentState,- IVSMessageComponent,- Cloneable
- Direct Known Subclasses:
- EditorVSField
The field has a raw string format or a specific data type (e.g. Date or Number). It then has a formatted string that represents a displayable field text, formatted e.g. with the correct client locale.
- Author:
- Christopher Mindus
- Nested Class Summary- Nested classes/interfaces inherited from interface com.iizix.gyro.IMessageBox- IMessageBox.Icon- Nested classes/interfaces inherited from interface com.iizix.prop.vs.IVSComponentState- IVSComponentState.State
- Field SummaryFields- Fields inherited from class com.iizix.prop.vs.VSComponent- statesMap- Fields inherited from class com.iizix.prop.PropCnr- EMPTY, EMPTY_CLASSES, EMPTY_CNRS, EXTENDS_FRAMEWORK_ERROR_ID, nameTable- 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- Fields inherited from interface com.iizix.gyro.IMessageBox- ICON_ERROR, ICON_INFORMATION, ICON_MAP, ICON_NONE, ICON_QUESTION, ICON_WARNING- Fields inherited from interface com.iizix.prop.vs.IVSComponent- ATOM_IGNORE_UI_FOCUS, ERROR, INFORMATION, NONE, WARNING
- Constructor SummaryConstructors
- Method SummaryModifier and TypeMethodDescription- boolean- addListener- (IVSFieldListener listener) Adds a new listener to the VS field.- protected voidAdds the predefined properties for this container.- adjustValue- (TemporalAdjuster temporalAdjuster, GProp<?> trigger) Adjusts the current temporal value with a temporal adjuster.- adjustValue- (ZoneId zoneID, GProp<?> trigger) Adjusts the current ZonedDateTime value with a new Zone ID.- booleanAssigns an acceptable value to the field in order to be able to use it properly.- clone()Clones this VSField.- int- convertEqualsValue- (GProp<?> trigger, Value... values) Verifies if a value could potentially be equal to the value in the field using conversion.- protected FieldActorsCreates a new instance of the field actors, overridden for the Editor.- get_BigDecimal- (boolean doTranslate) - get_BigDecimal- (boolean doTranslate, GProp<?> trigger) - get_BigDecimal- (GProp<?> trigger) - get_BigInteger- (boolean doTranslate) - get_BigInteger- (boolean doTranslate, GProp<?> trigger) - get_BigInteger- (GProp<?> trigger) - byte[]- byte[]- get_Binary- (boolean doTranslate) - byte[]- get_Binary- (boolean doTranslate, GProp<?> trigger) - byte[]- get_Binary- (GProp<?> trigger) - get_Boolean- (boolean doTranslate) - get_Boolean- (boolean doTranslate, GProp<?> trigger) - get_Boolean- (GProp<?> trigger) - get_Byte()- get_Byte- (boolean doTranslate) - get_Double- (boolean doTranslate) - get_Double- (boolean doTranslate, GProp<?> trigger) - get_Double- (GProp<?> trigger) - get_Duration- (boolean doTranslate) - get_Duration- (boolean doTranslate, GProp<?> trigger) - get_Duration- (GProp<?> trigger) - get_Float- (boolean doTranslate) - get_Integer- (boolean doTranslate) - get_Integer- (boolean doTranslate, GProp<?> trigger) - get_Integer- (GProp<?> trigger) Gets the value of this field as a KString with translation and no trigger property using the field actors.- get_KString- (boolean doTranslate) Gets the value of this field as a KString with translation and no trigger property using the field actors depending on the- doTranslateflag.- get_KString- (boolean doTranslate, GProp<?> trigger) Gets the value of this field as a KString with translation and optional trigger property using the field actors depending on the- doTranslateflag.- get_KString- (LocaleInfo localeInfo) Gets the value of this field as a KString with translation using the field actors.- get_KString- (LocaleInfo localeInfo, boolean doTranslate) Gets the value of this field as a KString with translation using the field actors depending on the- doTranslateflag.- get_KString- (LocaleInfo localeInfo, boolean doTranslate, GProp<?> trigger) Gets the value of this field as a KString with translation and optional trigger property using the field actors depending on the- doTranslateflag.- get_KString- (LocaleInfo localeInfo, GProp<?> trigger) Gets the value of this field as a KString with translation and optional trigger property using the field actors.- get_KString- (GProp<?> trigger) Gets the value of this field as a KString with translation and optional trigger property using the field actors.- get_LocalDate- (boolean doTranslate) - get_LocalDate- (boolean doTranslate, GProp<?> trigger) - get_LocalDate- (GProp<?> trigger) - get_LocalDateTime- (boolean doTranslate) - get_LocalDateTime- (boolean doTranslate, GProp<?> trigger) - get_LocalDateTime- (GProp<?> trigger) - get_LocalTime- (boolean doTranslate) - get_LocalTime- (boolean doTranslate, GProp<?> trigger) - get_LocalTime- (GProp<?> trigger) - get_Long()- get_Long- (boolean doTranslate) - get_MonthDay- (boolean doTranslate) - get_MonthDay- (boolean doTranslate, GProp<?> trigger) - get_MonthDay- (GProp<?> trigger) - get_OffsetDateTime- (boolean doTranslate) - get_OffsetDateTime- (boolean doTranslate, GProp<?> trigger) - get_OffsetDateTime- (GProp<?> trigger) - get_OffsetTime- (boolean doTranslate) - get_OffsetTime- (boolean doTranslate, GProp<?> trigger) - get_OffsetTime- (GProp<?> trigger) - get_Period- (boolean doTranslate) - get_Period- (boolean doTranslate, GProp<?> trigger) - get_Period- (GProp<?> trigger) - get_Short- (boolean doTranslate) Gets the value of this field as a String with translation and no trigger property using the field actors.- get_String- (boolean doTranslate) Gets the value of this field as a String with translation and no trigger property using the field actors depending on the- doTranslateflag.- get_String- (boolean doTranslate, GProp<?> trigger) Gets the value of this field as a String with translation and optional trigger property using the field actors depending on the- doTranslateflag.- get_String- (LocaleInfo localeInfo) Gets the value of this field as a String with translation using the field actors.- get_String- (LocaleInfo localeInfo, boolean doTranslate) Gets the value of this field as a String with translation using the field actors depending on the- doTranslateflag.- get_String- (LocaleInfo localeInfo, boolean doTranslate, GProp<?> trigger) Gets the value of this field as a String with translation and optional trigger property using the field actors depending on the- doTranslateflag.- get_String- (LocaleInfo localeInfo, GProp<?> trigger) Gets the value of this field as a String with translation and optional trigger property using the field actors.- get_String- (GProp<?> trigger) Gets the value of this field as a String with translation and optional trigger property using the field actors.Gets the value of this field as a String using the native Value object- toString()method, i.e.- get_XMLDuration- (boolean doTranslate) - get_XMLDuration- (boolean doTranslate, GProp<?> trigger) - get_XMLDuration- (GProp<?> trigger) - get_Year()- get_Year- (boolean doTranslate) - get_YearMonth- (boolean doTranslate) - get_YearMonth- (boolean doTranslate, GProp<?> trigger) - get_YearMonth- (GProp<?> trigger) - get_ZonedDateTime- (boolean doTranslate) - get_ZonedDateTime- (boolean doTranslate, GProp<?> trigger) - get_ZonedDateTime- (GProp<?> trigger) Gets the field actors container.Gets the column instance of this field when it is in a table.- intGets the column index of this field in the table.Gets the focus message for "Component is disabled" but for the component in question.Gets the focus message for "Component is hidden" but for the component in question.Gets the listeners of the VS field events.Gets the cached locale information for the session, or if not available caches the one from the environment.- getLocaleInfo- (LocaleInfo localeInfo) Uses the localeInfo parameter as the locale information if non-null, otherwise gets the cached locale information for the session, or if not available caches the one from the environment.Gets the pattern used by the value formatter.Gets the pattern used by the value formatter.Gets the pattern property.- protected voidGets potential references to predefined properties for this container.Gets the raw value of the field.Gets the raw value type of the field.Gets the reference Type.Gets the single potential instance of a referencing property instance.Gets the array of referencing property instances.- getRow()Gets the row container.- intGets the row index of this field in the table.- getRows()Gets the rows container.- getTable()Gets the table.- getValue- (LocaleInfo localeInfo, Value.Type type, boolean doTranslate, GProp<?> trigger) Gets a value in the requested type with translation flag and no trigger property.- getValue- (Value.Type type) Gets a value in the requested type with translation using the field actors with translation and no trigger property.- getValue- (Value.Type type, boolean doTranslate) Gets a value in the requested type with translation flag and no trigger property.- getValue- (Value.Type type, boolean doTranslate, GProp<?> trigger) Gets a value in the requested type with translation flag and no trigger property.Gets the value type.Gets the value type string.- boolean- isNull()Checks if the value is currently null.- booleanSets null value allowed.- booleanReturns if this field is a table cell, i.e.- void- onEventSelf- (GEvent event) Checks for state change events and fires it to listeners.- protected void- onListenerChanged- (IVSFieldListener listener) Called when a listener is added or removed.- void- onParentStateChanged- (IVSComponent parent, IVSComponentState.State state, boolean stateValue) Invokes the parent state notification function for the component.- protected String- paramValue- (Object value) Formats the value as a string to add to- paramString.- boolean- removeListener- (IVSFieldListener listener) Removes a listener from the VS field.- boolean- set_BigDecimal- (BigDecimal value) - boolean- set_BigDecimal- (BigDecimal value, boolean doTranslate) - boolean- set_BigDecimal- (BigDecimal value, boolean doTranslate, GProp<?> trigger) - boolean- set_BigDecimal- (BigDecimal value, GProp<?> trigger) - boolean- set_BigInteger- (BigInteger value) - boolean- set_BigInteger- (BigInteger value, boolean doTranslate) - boolean- set_BigInteger- (BigInteger value, boolean doTranslate, GProp<?> trigger) - boolean- set_BigInteger- (BigInteger value, GProp<?> trigger) - boolean- set_Binary- (byte[] value) - boolean- set_Binary- (byte[] value, boolean doTranslate) - boolean- set_Binary- (byte[] value, boolean doTranslate, GProp<?> trigger) - boolean- set_Binary- (byte[] value, GProp<?> trigger) - boolean- set_Boolean- (Boolean value) - boolean- set_Boolean- (Boolean value, boolean doTranslate) - boolean- set_Boolean- (Boolean value, boolean doTranslate, GProp<?> trigger) - boolean- set_Boolean- (Boolean value, GProp<?> trigger) - boolean- boolean- boolean- boolean- boolean- set_Double- (Double value) - boolean- set_Double- (Double value, boolean doTranslate) - boolean- set_Double- (Double value, boolean doTranslate, GProp<?> trigger) - boolean- set_Double- (Double value, GProp<?> trigger) - boolean- set_Duration- (Duration value) - boolean- set_Duration- (Duration value, boolean doTranslate) - boolean- set_Duration- (Duration value, boolean doTranslate, GProp<?> trigger) - boolean- set_Duration- (Duration value, GProp<?> trigger) - boolean- boolean- boolean- boolean- boolean- set_Integer- (Integer value) - boolean- set_Integer- (Integer value, boolean doTranslate) - boolean- set_Integer- (Integer value, boolean doTranslate, GProp<?> trigger) - boolean- set_Integer- (Integer value, GProp<?> trigger) - boolean- set_KString- (KString value) - boolean- set_KString- (KString value, boolean doTranslate) - boolean- set_KString- (KString value, boolean doTranslate, GProp<?> trigger) - boolean- set_KString- (KString value, GProp<?> trigger) - boolean- set_LocalDate- (LocalDate value) - boolean- set_LocalDate- (LocalDate value, boolean doTranslate) - boolean- set_LocalDate- (LocalDate value, boolean doTranslate, GProp<?> trigger) - boolean- set_LocalDate- (LocalDate value, GProp<?> trigger) - boolean- set_LocalDateTime- (LocalDateTime value) - boolean- set_LocalDateTime- (LocalDateTime value, boolean doTranslate) - boolean- set_LocalDateTime- (LocalDateTime value, boolean doTranslate, GProp<?> trigger) - boolean- set_LocalDateTime- (LocalDateTime value, GProp<?> trigger) - boolean- set_LocalTime- (LocalTime value) - boolean- set_LocalTime- (LocalTime value, boolean doTranslate) - boolean- set_LocalTime- (LocalTime value, boolean doTranslate, GProp<?> trigger) - boolean- set_LocalTime- (LocalTime value, GProp<?> trigger) - boolean- boolean- boolean- boolean- boolean- set_MonthDay- (MonthDay value) - boolean- set_MonthDay- (MonthDay value, boolean doTranslate) - boolean- set_MonthDay- (MonthDay value, boolean doTranslate, GProp<?> trigger) - boolean- set_MonthDay- (MonthDay value, GProp<?> trigger) - boolean- set_OffsetDateTime- (OffsetDateTime value) - boolean- set_OffsetDateTime- (OffsetDateTime value, boolean doTranslate) - boolean- set_OffsetDateTime- (OffsetDateTime value, boolean doTranslate, GProp<?> trigger) - boolean- set_OffsetDateTime- (OffsetDateTime value, GProp<?> trigger) - boolean- set_OffsetTime- (OffsetTime value) - boolean- set_OffsetTime- (OffsetTime value, boolean doTranslate) - boolean- set_OffsetTime- (OffsetTime value, boolean doTranslate, GProp<?> trigger) - boolean- set_OffsetTime- (OffsetTime value, GProp<?> trigger) - boolean- set_Period- (Period value) - boolean- set_Period- (Period value, boolean doTranslate) - boolean- set_Period- (Period value, boolean doTranslate, GProp<?> trigger) - boolean- set_Period- (Period value, GProp<?> trigger) - boolean- boolean- boolean- boolean- boolean- set_String- (String value) - boolean- set_String- (String value, boolean doTranslate) - boolean- set_String- (String value, boolean doTranslate, GProp<?> trigger) - boolean- set_String- (String value, GProp<?> trigger) - boolean- set_XMLDuration- (Duration value) - boolean- set_XMLDuration- (Duration value, boolean doTranslate) - boolean- set_XMLDuration- (Duration value, boolean doTranslate, GProp<?> trigger) - boolean- set_XMLDuration- (Duration value, GProp<?> trigger) - boolean- boolean- boolean- boolean- boolean- set_YearMonth- (YearMonth value) - boolean- set_YearMonth- (YearMonth value, boolean doTranslate) - boolean- set_YearMonth- (YearMonth value, boolean doTranslate, GProp<?> trigger) - boolean- set_YearMonth- (YearMonth value, GProp<?> trigger) - boolean- set_ZonedDateTime- (ZonedDateTime value) - boolean- set_ZonedDateTime- (ZonedDateTime value, boolean doTranslate) - boolean- set_ZonedDateTime- (ZonedDateTime value, boolean doTranslate, GProp<?> trigger) - boolean- set_ZonedDateTime- (ZonedDateTime value, GProp<?> trigger) - boolean- setNullAllowed- (boolean on) Sets null value allowed.- boolean- setNullAllowed- (boolean on, IComplexOperation op) Sets null value allowed.- boolean- setPattern- (PlainKString pattern) Sets the pattern used by the value formatter.- boolean- setPattern- (PlainKString pattern, IComplexOperation op) Sets the pattern used by the value formatter.- boolean- setRawValue- (Value value, GProp<?> trigger) Sets the raw value of the field.- boolean- setRawValue- (Value value, IComplexOperation op) Sets the raw value of the field with undo/redo support.- boolean- setValue- (LocaleInfo localeInfo, Object value, boolean doTranslate, GProp<?> trigger) Sets a value in generic type with possible translation and optional trigger property.- booleanSets a value in generic type with possible translation and no trigger property.- booleanSets a value in generic type with possible translation and optional trigger property.- booleanSets the value as a string with error message processing.- booleanChecks if this referencing Property Container has single or multiple referencing properties at maximum.- Methods inherited from class com.iizix.prop.vs.VSComponent- addListener, areFree, areFree, canRequestFocus, convertLoadedProp, couldRequestFocusIfVirtualized, forbiddenGetCustomDataMap, getClientSessionGyro, getComponentListeners, getDescription, getNonVirtualized, getVirtualSpace, initPropCnr, invokeOnVSCreateTree, isFree, isFree, onFocusGained, onFocusLost, onListenerChanged, onPrepare, onPropDispose, onRemoteEvent, onVirtualContainerCreated, paramString, removeListener, virtualize- Methods inherited from class com.iizix.prop.PropCnr- __transferChildProps, addProp, addProp, addProp2, addProp2, appendPropValue, canRequestFocus, completeVirtualize, containsProp, containsProp, 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, 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, insertProp, insertProp2, isChild, isExtendsOverriden, isExtendsPropertyValid, isExtendsRoot, isPropAddRemoveAllowed, isPropCommunicating, isPropExtended, isSibling, list, list, logPropNotFound, maybeAddProp, onInsertProp, onPropRemoved, onPropTreeInitialized, onReferenceEvent, onVirtualizationCompleted, 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, verify, verifyInternalUseOnly, verifyTree- 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, 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, list, list, list, mapAliasToReference, mapAliasToReference, mapReferenceToAlias, mapReferenceToAlias, mapReferenceToProjectRelative, modifyPropValue, moveProp, moveProp, moveProp, onEvent, onPropInvalidateCache, onPropParentChanged, onPropValueSet, paramString, 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.ICustomDataProvider- forbiddenGetCustomDataMap, getCustomData, putCustomData, putCustomDataIfAbsent- Methods inherited from interface com.iizix.gyro.IFocusComp- onFocusGained, onFocusLost, requestFocus, requestFocus, requestFocusEx, requestFocusEx- 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, 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, verify, warning, warning, warning- Methods inherited from interface com.iizix.gyro.IMessageBox- messageBox, messageBox- 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, isSibling, 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- Methods inherited from interface com.iizix.prop.vs.IVSComponent- getAction, getAction2, getActionNull, getActionNull2, getDescription, getField, getField2, getFieldNull, getFieldNull2, getGroup, getGroup2, getGroupNull, getGroupNull2, getNonVirtualized, getTable, getTable2, getTableNull, getTableNull2, getVirtualizedVirtualSpace, getVirtualSpace, getVSComponent, getVSComponent2, getVSComponentNull, getVSComponentNull2, getVSRef, isEnabled, isEnabledInParent, isReadOnly, isReadOnlyInParent, isSelected, isVisible, isVisibleInParent, messageBox, setEnabled, setEnabled, setIgnoreFocusFromUI, setReadOnly, setReadOnly, setSelected, setSelected, setVirtualizeSupportFocus, setVirtualizeSupportFocus, setVisible, setVisible, shouldIgnoreFocusFromUI- Methods inherited from interface com.iizix.prop.vs.IVSMessageComponent- clearMessage, getMessage, getMessageCategory, getMessageString, isValid, setErrorMessage, setMessage, setMessage
- Field Details- EMPTY_LISTENERSEmpty listeners array.
 
- Constructor Details- VSFieldpublic VSField()Creates a VirtualSpace Field property with the specified name with a null value.
- VSFieldCreates a VirtualSpace Field property with the specified name with a null value.- Parameters:
- propertyAtom- the property atom.
 
 
- Method Details- cloneClones this VSField.- Overrides:
- clonein class- VSComponent
 
- getValueTypeGets the value type.- Specified by:
- getValueTypein interface- IPatternOwner
- Returns:
- The field type, or null for none.
 
- getValueTypeStringGets the value type string.- Returns:
- The field type as Value.T_* or "<undefined>" for none.
 
- getComponentIsHiddenGets the focus message for "Component is hidden" but for the component in question.- Specified by:
- getComponentIsHiddenin class- VSComponent
 
- getComponentIsDisabledGets the focus message for "Component is disabled" but for the component in question.- Specified by:
- getComponentIsDisabledin class- VSComponent
 
- getReferenceTypeGets the reference Type.- Specified by:
- getReferenceTypein interface- IReferencingPropCnr
- Returns:
- IPropReference.RefType.VSField.
 
- usesMultipleReferencingpublic boolean usesMultipleReferencing()Checks if this referencing Property Container has single or multiple referencing properties at maximum.- Specified by:
- usesMultipleReferencingin interface- IReferencingPropCnr
- Returns:
- Always falseas only a single referencing property is supported. Use the methodgetReferencingProp()to retrieve it.
 
- getReferencingPropGets the single potential instance of a referencing property instance.- Specified by:
- getReferencingPropin interface- IReferencingPropCnr
- Returns:
- The single referencing property, or nullif none is found.
 
- getReferencingPropsGets the array of referencing property instances.- Specified by:
- getReferencingPropsin interface- IReferencingPropCnr
- Returns:
- Always nullas there is only support for a single referencing property. Use the methodgetReferencingProp()to retrieve it.
 
- isTableCellpublic boolean isTableCell()Returns if this field is a table cell, i.e. inside a table or a normal field in the VirtualSpace.
- getTableGets the table.- Returns:
- The table instance, or null if this field is not added to a table, i.e. directly in the VirtualSpace or a VirtualSpace group.
 
- getColumnIndexpublic int getColumnIndex()Gets the column index of this field in the table.- Returns:
- The column index, or -1if the field is not inside a table.
 
- getRowIndexpublic int getRowIndex()Gets the row index of this field in the table.- Returns:
- The row index, or -1if the field is not inside a table, or-2if this field in a header field.
 
- getColumnGets the column instance of this field when it is in a table.- Returns:
- The column instance or null if not inside table or column is not found.
 
- getRowsGets the rows container.- Returns:
- The rows instance, or null if field is not inside a table.
 
- getRowGets the row container.- Returns:
- The row instance, or null if field is not inside a table.
 
- onEventSelfChecks for state change events and fires it to listeners.- Specified by:
- onEventSelfin interface- IGProp<GProp<?>[]>
- Overrides:
- onEventSelfin class- VSComponent
- Parameters:
- event- The property event.
 
- onParentStateChangedpublic void onParentStateChanged- (IVSComponent parent, IVSComponentState.State state, boolean stateValue) Invokes the parent state notification function for the component.- Specified by:
- onParentStateChangedin interface- IVSComponentListener
- Parameters:
- parent- The parent who's state was changed.
- state- The state that changed.
- stateValue- The new state value.
 
- createFieldActorsCreates a new instance of the field actors, overridden for the Editor.
- getActorsGets the field actors container.- Returns:
- The field actors for this field if the field is located in the VirtualSpace or in a VirtualSpace group, otherwise the table column field actors if inside a table.
 
- addPredefinedPropsAdds the predefined properties for this container. This method is called once just after construction of the property container and sometimes population of it.- The method should add properties to create or get reference to using the - maybeAddPropmethod. When the PropCnr instance is cloned, the method- getPredefinedProps()is called in order for the subclass to be able to retrieve the new instances to these properties, if stored in instance variables.- Overrides:
- addPredefinedPropsin class- PropCnr
- Throws:
- PropException- for property exceptions.
 
- getPredefinedPropsprotected void getPredefinedProps()Gets potential references to predefined properties for this container. This method is called once just after cloning of the property container.- The method should get reference to using the - getProp(...)methods. This allows the subclass to be able to retrieve the new instances to the properties created during- addPredefinedProps()if stored in instance variables.- Overrides:
- getPredefinedPropsin class- PropCnr
 
- addListenerAdds a new listener to the VS field.- Parameters:
- listener- The listener for VS field events.
- Returns:
- true for success, false if the listener already is added.
 
- removeListenerRemoves a listener from the VS field.- Parameters:
- listener- The existing listener for VS field events.
- Returns:
- true for success, false if the listener has not been added.
 
- onListenerChangedCalled when a listener is added or removed. This method is overridden by the Designer to update connections.
- getFieldListenersGets the listeners of the VS field events.- Returns:
- A cached array of listeners for the value, retrieved without synchronization if possible.
 
- setNullAllowedpublic boolean setNullAllowed- (boolean on) Sets null value allowed. If null is not allowed and the value is null when this method is called, nothing happens, a validation must be done first.- Parameters:
- on- The null allowed state.
- Returns:
- true for change, false for no change.
 
- setNullAllowedSets null value allowed. If null is not allowed and the value is null when this method is called, nothing happens, a validation must be done first.- This method supports undo/redo. - Parameters:
- on- The null allowed state.
- Returns:
- true for change, false for no change.
 
- isNullAllowedpublic boolean isNullAllowed()Sets null value allowed. If null is not allowed and the value is null when this method is called, nothing happens, a validation must be done first.- Default is true. - Returns:
- true if null value is allowed, false otherwise.
 
- setRawValueSets the raw value of the field. If the Raw Value property cannot be set, a warning is logged.- If the value is a - Valueinstance but- Value.isNull()returns- truebut the null is not allowed, a warning is logged and nothing is done.- Parameters:
- value- The raw value.
- trigger- The trigger property, i.e. the "requestor of this method", can be null for none. This value gives extra information for the VSFieldEvent and is not processed in the framework.
- Returns:
- true If the value changed, false otherwise.
- Throws:
- NullPointerException- If value is null.
 
- setRawValueSets the raw value of the field with undo/redo support. If the Raw Value property cannot be set, a warning is logged.- If the value is a - Valueinstance but- Value.isNull()returns- truebut the null is not allowed, a warning is logged and nothing is done.- Parameters:
- value- The raw value.
- Returns:
- true If the value changed, false otherwise.
- Throws:
- NullPointerException- If value is null.
 
- getRawValueGets the raw value of the field.- Returns:
- null If not set yet.
 
- getRawValueTypeGets the raw value type of the field.- Returns:
- The Value type, or null if not set.
 
- isNullpublic boolean isNull()Checks if the value is currently null.- Returns:
- true if value is null, false otherwise.
 
- assignAcceptableValuepublic boolean assignAcceptableValue()Assigns an acceptable value to the field in order to be able to use it properly. This method is intended to be used when conversion failures, etc, are found when e.g. populating a table.- This method does nothing if the current value is acceptable, i.e. has been set or is null and this is allowed. - If the raw field type is not set, String is assumed. - Returns:
- true for changed, false for no change.
 
- setPatternSets the pattern used by the value formatter.- Parameters:
- pattern- The pattern to set, null to remove.
- Returns:
- true if this property changed, false otherwise.
 
- setPatternSets the pattern used by the value formatter.- Parameters:
- pattern- The pattern to set, null to remove.
- op- The complex operation for undo/redo.
- Returns:
- true if this property changed, false otherwise.
 
- getPatternPropGets the pattern property.- Note: if the field is in a table, the pattern property for the field is not used, rather the pattern property of the corresponding table column. - Specified by:
- getPatternPropin interface- IPatternOwner
- Returns:
- The pattern property, or null for none. If the field is in a table, the corresponding table column pattern property is returned instead.
 
- getPatternGets the pattern used by the value formatter. This method will resolve the pattern if the pattern- PlainKStringcontains tags.- Note: if the field is in a table, the pattern property for the field is not used, rather the pattern property of the corresponding table column. - Returns:
- The pattern, null for none. If the field is in a table, the corresponding table column pattern is returned instead.
 
- getPatternPlainKStringGets the pattern used by the value formatter.- Note: if the field is in a table, the pattern property for the field is not used, rather the pattern property of the corresponding table column. - Returns:
- The pattern, null for none. If the field is in a table, the corresponding table column pattern is returned instead.
 
- setValueSets the value as a string with error message processing. This method is intended to be used by the framework and should normally not be called. Use- set_String(String)- Parameters:
- string- The new value, potentially null for a null value.
- Returns:
- true for changes to the field, false for no change.
 
- get_StringRawGets the value of this field as a String using the native Value object- toString()method, i.e. without translators, pattern and localization.- Returns:
- The String value, or nullif theValue.isNull()returnstrue.
 
- get_StringGets the value of this field as a String with translation and no trigger property using the field actors.- Conversion of the value is done as required using the session Locale settings and Pattern. - The - ValueConversionExceptionthat may be thrown by other field "get_String" routines is caught by this method and logged as a warning.- Returns:
- The String value, or nullif theValue.isNull()returnstrue.
 
- get_StringGets the value of this field as a String with translation and no trigger property using the field actors depending on the- doTranslateflag.- Conversion of the value is done as required using the session Locale settings and Pattern. - The - get_String()- get_String()routines does not throw a- ValueConversionException.- Parameters:
- doTranslate- Translate the value using the field actors.
- Returns:
- The String value, or nullif theValue.isNull()returnstrue.
- Throws:
- ValueConversionException- If a field actor throws the exception, or the value cannot be converted.
 
- get_StringGets the value of this field as a String with translation using the field actors. Conversion of the value is done as required using the session Locale settings and Pattern.- The - get_String()- get_String()methods does not throw a- ValueConversionException.- Parameters:
- localeInfo- The LocaleInfo to use.
- Returns:
- The String value, or nullif theValue.isNull()returnstrue.
- Throws:
- ValueConversionException- If a field actor throws the exception, or the value cannot be converted.
 
- get_StringGets the value of this field as a String with translation and optional trigger property using the field actors.- Conversion of the value is done as required using the session Locale settings and Pattern. - The - get_String()- get_String()methods does not throw a- ValueConversionException.- Parameters:
- trigger- The trigger property, i.e. the "requestor of this method", can be null for none. This value gives extra information for the VSFieldEvent and is not processed in the framework.
- Returns:
- The String value, or nullif theValue.isNull()returnstrue.
- Throws:
- ValueConversionException- If a field actor throws the exception, or the value cannot be converted.
 
- get_StringGets the value of this field as a String with translation and optional trigger property using the field actors depending on the- doTranslateflag.- Conversion of the value is done as required using the session Locale settings and Pattern. - The - get_String()- get_String()methods does not throw a- ValueConversionException.- Parameters:
- doTranslate- Translate the value using the field actors.
- trigger- The trigger property, i.e. the "requestor of this method", can be null for none. This value gives extra information for the VSFieldEvent and is not processed in the framework.
- Returns:
- The String value, or nullif theValue.isNull()returnstrue.
- Throws:
- ValueConversionException- If a field actor throws the exception, or the value cannot be converted.
 
- get_StringGets the value of this field as a String with translation and optional trigger property using the field actors. Conversion of the value is done as required using the session Locale settings and Pattern.- The - get_String()- get_String()methods does not throw a- ValueConversionException.- Parameters:
- localeInfo- The LocaleInfo to use.
- trigger- The trigger property, i.e. the "requestor of this method", can be null for none. This value gives extra information for the VSFieldEvent and is not processed in the framework.
- Returns:
- The String value, or nullif theValue.isNull()returnstrue.
- Throws:
- ValueConversionException- If a field actor throws the exception, or the value cannot be converted.
 
- get_Stringpublic String get_String- (LocaleInfo localeInfo, boolean doTranslate) throws ValueConversionException Gets the value of this field as a String with translation using the field actors depending on the- doTranslateflag.- Conversion of the value is done as required using the session Locale settings and Pattern. - The - get_String()- get_String()methods does not throw a- ValueConversionException.- Parameters:
- localeInfo- The LocaleInfo to use.
- doTranslate- Translate the value using the field actors.
- Returns:
- The String value, or nullif theValue.isNull()returnstrue.
- Throws:
- ValueConversionException- If a field actor throws the exception, or the value cannot be converted.
 
- get_Stringpublic String get_String- (LocaleInfo localeInfo, boolean doTranslate, GProp<?> trigger) throws ValueConversionException Gets the value of this field as a String with translation and optional trigger property using the field actors depending on the- doTranslateflag.- Conversion of the value is done as required using the session Locale settings and Pattern. - The - get_String()- get_String()methods does not throw a- ValueConversionException.- Parameters:
- localeInfo- The LocaleInfo to use.
- doTranslate- Translate the value using the field actors.
- trigger- The trigger property, i.e. the "requestor of this method", can be null for none. This value gives extra information for the VSFieldEvent and is not processed in the framework.
- Returns:
- The String value, or nullif theValue.isNull()returnstrue.
- Throws:
- ValueConversionException- If a field actor throws the exception, or the value cannot be converted.
 
- getLocaleInfoGets the cached locale information for the session, or if not available caches the one from the environment.- Returns:
- The locale information, never null.
 
- getLocaleInfoUses the localeInfo parameter as the locale information if non-null, otherwise gets the cached locale information for the session, or if not available caches the one from the environment.- Returns:
- The locale information, never null.
 
- get_KStringGets the value of this field as a KString with translation and no trigger property using the field actors.- Conversion of the value is done as required using the session Locale settings and Pattern. - The - ValueConversionExceptionthat may be thrown by other field "get_KString" routines is caught by this method and logged as a warning.- Returns:
- The KString value, or nullif theValue.isNull()returnstrue.
 
- get_KStringGets the value of this field as a KString with translation and no trigger property using the field actors depending on the- doTranslateflag.- Conversion of the value is done as required using the session Locale settings and Pattern. - The - get_KString()- get_KString()methods does not throw a- ValueConversionException.- Parameters:
- doTranslate- Translate the value using the field actors.
- Returns:
- The KString value, or nullif theValue.isNull()returnstrue.
- Throws:
- ValueConversionException- If a field actor throws the exception, or the value cannot be converted.
 
- get_KStringGets the value of this field as a KString with translation using the field actors. Conversion of the value is done as required using the session Locale settings and Pattern.- The - get_KString()- get_KString()methods does not throw a- ValueConversionException.- Parameters:
- localeInfo- The LocaleInfo to use.
- Returns:
- The KString value, or nullif theValue.isNull()returnstrue.
- Throws:
- ValueConversionException- If a field actor throws the exception, or the value cannot be converted.
 
- get_KStringGets the value of this field as a KString with translation and optional trigger property using the field actors.- Conversion of the value is done as required using the session Locale settings and Pattern. - The - get_KString()- get_KString()methods does not throw a- ValueConversionException.- Parameters:
- trigger- The trigger property, i.e. the "requestor of this method", can be null for none. This value gives extra information for the VSFieldEvent and is not processed in the framework.
- Returns:
- The KString value, or nullif theValue.isNull()returnstrue.
- Throws:
- ValueConversionException- If a field actor throws the exception, or the value cannot be converted.
 
- get_KStringGets the value of this field as a KString with translation and optional trigger property using the field actors depending on the- doTranslateflag.- Conversion of the value is done as required using the session Locale settings and Pattern. - The - get_KString()- get_KString()methods does not throw a- ValueConversionException.- Parameters:
- doTranslate- Translate the value using the field actors.
- trigger- The trigger property, i.e. the "requestor of this method", can be null for none. This value gives extra information for the VSFieldEvent and is not processed in the framework.
- Returns:
- The KString value, or nullif theValue.isNull()returnstrue.
- Throws:
- ValueConversionException- If a field actor throws the exception, or the value cannot be converted.
 
- get_KStringGets the value of this field as a KString with translation and optional trigger property using the field actors. Conversion of the value is done as required using the session Locale settings and Pattern.- The - get_KString()- get_KString()methods does not throw a- ValueConversionException.- Parameters:
- localeInfo- The LocaleInfo to use.
- trigger- The trigger property, i.e. the "requestor of this method", can be null for none. This value gives extra information for the VSFieldEvent and is not processed in the framework.
- Returns:
- The KString value, or nullif theValue.isNull()returnstrue.
- Throws:
- ValueConversionException- If a field actor throws the exception, or the value cannot be converted.
 
- get_KStringpublic KString get_KString- (LocaleInfo localeInfo, boolean doTranslate) throws ValueConversionException Gets the value of this field as a KString with translation using the field actors depending on the- doTranslateflag.- Conversion of the value is done as required using the session Locale settings and Pattern. - The - get_KString()- get_KString()methods does not throw a- ValueConversionException.- Parameters:
- localeInfo- The LocaleInfo to use.
- doTranslate- Translate the value using the field actors.
- Returns:
- The KString value, or nullif theValue.isNull()returnstrue.
- Throws:
- ValueConversionException- If a field actor throws the exception, or the value cannot be converted.
 
- get_KStringpublic KString get_KString- (LocaleInfo localeInfo, boolean doTranslate, GProp<?> trigger) throws ValueConversionException Gets the value of this field as a KString with translation and optional trigger property using the field actors depending on the- doTranslateflag.- Conversion of the value is done as required using the session Locale settings and Pattern. - The - get_KString()- get_KString()methods does not throw a- ValueConversionException.- Parameters:
- localeInfo- The LocaleInfo to use.
- doTranslate- Translate the value using the field actors.
- trigger- The trigger property, i.e. the "requestor of this method", can be null for none. This value gives extra information for the VSFieldEvent and is not processed in the framework.
- Returns:
- The KString value, or nullif theValue.isNull()returnstrue.
- Throws:
- ValueConversionException- If a field actor throws the exception, or the value cannot be converted.
 
- get_XMLDuration- Throws:
- ValueConversionException
 
- get_BigDecimal- Throws:
- ValueConversionException
 
- get_BigInteger- Throws:
- ValueConversionException
 
- get_Binary- Throws:
- ValueConversionException
 
- get_Boolean- Throws:
- ValueConversionException
 
- get_Byte- Throws:
- ValueConversionException
 
- get_Double- Throws:
- ValueConversionException
 
- get_Duration- Throws:
- ValueConversionException
 
- get_Float- Throws:
- ValueConversionException
 
- get_Integer- Throws:
- ValueConversionException
 
- get_LocalDateTime- Throws:
- ValueConversionException
 
- get_LocalDate- Throws:
- ValueConversionException
 
- get_LocalTime- Throws:
- ValueConversionException
 
- get_Long- Throws:
- ValueConversionException
 
- get_MonthDay- Throws:
- ValueConversionException
 
- get_OffsetDateTime- Throws:
- ValueConversionException
 
- get_OffsetTime- Throws:
- ValueConversionException
 
- get_Period- Throws:
- ValueConversionException
 
- get_Short- Throws:
- ValueConversionException
 
- get_YearMonth- Throws:
- ValueConversionException
 
- get_Year- Throws:
- ValueConversionException
 
- get_ZonedDateTime- Throws:
- ValueConversionException
 
- get_XMLDuration- Throws:
- ValueConversionException
 
- get_BigDecimal- Throws:
- ValueConversionException
 
- get_BigInteger- Throws:
- ValueConversionException
 
- get_Binary- Throws:
- ValueConversionException
 
- get_Boolean- Throws:
- ValueConversionException
 
- get_Byte- Throws:
- ValueConversionException
 
- get_Double- Throws:
- ValueConversionException
 
- get_Duration- Throws:
- ValueConversionException
 
- get_Float- Throws:
- ValueConversionException
 
- get_Integer- Throws:
- ValueConversionException
 
- get_LocalDateTime- Throws:
- ValueConversionException
 
- get_LocalDate- Throws:
- ValueConversionException
 
- get_LocalTime- Throws:
- ValueConversionException
 
- get_Long- Throws:
- ValueConversionException
 
- get_MonthDay- Throws:
- ValueConversionException
 
- get_OffsetDateTime- Throws:
- ValueConversionException
 
- get_OffsetTime- Throws:
- ValueConversionException
 
- get_Period- Throws:
- ValueConversionException
 
- get_Short- Throws:
- ValueConversionException
 
- get_YearMonth- Throws:
- ValueConversionException
 
- get_Year- Throws:
- ValueConversionException
 
- get_ZonedDateTime- Throws:
- ValueConversionException
 
- get_XMLDuration- Throws:
- ValueConversionException
 
- get_BigDecimal- Throws:
- ValueConversionException
 
- get_BigInteger- Throws:
- ValueConversionException
 
- get_Binary- Throws:
- ValueConversionException
 
- get_Boolean- Throws:
- ValueConversionException
 
- get_Byte- Throws:
- ValueConversionException
 
- get_Double- Throws:
- ValueConversionException
 
- get_Duration- Throws:
- ValueConversionException
 
- get_Float- Throws:
- ValueConversionException
 
- get_Integer- Throws:
- ValueConversionException
 
- get_LocalDateTime- Throws:
- ValueConversionException
 
- get_LocalDate- Throws:
- ValueConversionException
 
- get_LocalTime- Throws:
- ValueConversionException
 
- get_Long- Throws:
- ValueConversionException
 
- get_MonthDay- Throws:
- ValueConversionException
 
- get_OffsetDateTime- Throws:
- ValueConversionException
 
- get_OffsetTime- Throws:
- ValueConversionException
 
- get_Period- Throws:
- ValueConversionException
 
- get_Short- Throws:
- ValueConversionException
 
- get_YearMonth- Throws:
- ValueConversionException
 
- get_Year- Throws:
- ValueConversionException
 
- get_ZonedDateTime- Throws:
- ValueConversionException
 
- get_XMLDurationpublic Duration get_XMLDuration- (boolean doTranslate, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- get_BigDecimalpublic BigDecimal get_BigDecimal- (boolean doTranslate, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- get_BigIntegerpublic BigInteger get_BigInteger- (boolean doTranslate, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- get_Binary- Throws:
- ValueConversionException
 
- get_Boolean- Throws:
- ValueConversionException
 
- get_Byte- Throws:
- ValueConversionException
 
- get_Double- Throws:
- ValueConversionException
 
- get_Duration- Throws:
- ValueConversionException
 
- get_Float- Throws:
- ValueConversionException
 
- get_Integer- Throws:
- ValueConversionException
 
- get_LocalDateTimepublic LocalDateTime get_LocalDateTime- (boolean doTranslate, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- get_LocalDatepublic LocalDate get_LocalDate- (boolean doTranslate, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- get_LocalTimepublic LocalTime get_LocalTime- (boolean doTranslate, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- get_Long- Throws:
- ValueConversionException
 
- get_MonthDay- Throws:
- ValueConversionException
 
- get_OffsetDateTimepublic OffsetDateTime get_OffsetDateTime- (boolean doTranslate, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- get_OffsetTimepublic OffsetTime get_OffsetTime- (boolean doTranslate, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- get_Period- Throws:
- ValueConversionException
 
- get_Short- Throws:
- ValueConversionException
 
- get_YearMonthpublic YearMonth get_YearMonth- (boolean doTranslate, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- get_Year- Throws:
- ValueConversionException
 
- get_ZonedDateTimepublic ZonedDateTime get_ZonedDateTime- (boolean doTranslate, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- getValueGets a value in the requested type with translation using the field actors with translation and no trigger property. The user sessions Locale is used.- Parameters:
- type- Any of the Value types.
- Returns:
- The value according to the type class, or nullif the value is null (i.e. hasValue.isNull()).
- Throws:
- ValueConversionException- If a field actor throws the exception, or the value cannot be converted.
 
- getValueGets a value in the requested type with translation flag and no trigger property. The user sessions Locale is used.- Parameters:
- type- Any of the Value types.
- doTranslate- Translate the value using the field actors.
- Returns:
- The value according to the type class, or nullif the value is null (i.e. hasValue.isNull()).
- Throws:
- ValueConversionException- If a field actor throws the exception, or the value cannot be converted.
 
- getValuepublic Object getValue- (Value.Type type, boolean doTranslate, GProp<?> trigger) throws ValueConversionException Gets a value in the requested type with translation flag and no trigger property. The user sessions Locale is used.- Parameters:
- type- Any of the Value types.
- doTranslate- Translate the value using the field actors.
- trigger- The trigger property, i.e. the "requestor of this method", can be null for none. This value gives extra information for the VSFieldEvent and is not processed in the framework.
- Returns:
- The value according to the type class, or nullif the value is null (i.e. hasValue.isNull()).
- Throws:
- ValueConversionException- If a field actor throws the exception, or the value cannot be converted.
 
- getValuepublic Object getValue- (LocaleInfo localeInfo, Value.Type type, boolean doTranslate, GProp<?> trigger) throws ValueConversionException Gets a value in the requested type with translation flag and no trigger property. The user sessions Locale is used.- Parameters:
- localeInfo- The locale info or null for default.
- type- Any of the Value types.
- doTranslate- Translate the value using the field actors.
- trigger- The trigger property, i.e. the "requestor of this method", can be null for none. This value gives extra information for the VSFieldEvent and is not processed in the framework.
- Returns:
- The value according to the type class, or nullif the value is null (i.e. hasValue.isNull()).
- Throws:
- ValueConversionException- If a field actor throws the exception, or the value cannot be converted.
 
- set_XMLDuration- Throws:
- ValueConversionException
 
- set_BigDecimal- Throws:
- ValueConversionException
 
- set_BigInteger- Throws:
- ValueConversionException
 
- set_Binary- Throws:
- ValueConversionException
 
- set_Boolean- Throws:
- ValueConversionException
 
- set_Byte- Throws:
- ValueConversionException
 
- set_Double- Throws:
- ValueConversionException
 
- set_Duration- Throws:
- ValueConversionException
 
- set_Float- Throws:
- ValueConversionException
 
- set_Integer- Throws:
- ValueConversionException
 
- set_KString- Throws:
- ValueConversionException
 
- set_LocalDateTime- Throws:
- ValueConversionException
 
- set_LocalDate- Throws:
- ValueConversionException
 
- set_LocalTime- Throws:
- ValueConversionException
 
- set_Long- Throws:
- ValueConversionException
 
- set_MonthDay- Throws:
- ValueConversionException
 
- set_OffsetDateTime- Throws:
- ValueConversionException
 
- set_OffsetTime- Throws:
- ValueConversionException
 
- set_Period- Throws:
- ValueConversionException
 
- set_Short- Throws:
- ValueConversionException
 
- set_String- Throws:
- ValueConversionException
 
- set_YearMonth- Throws:
- ValueConversionException
 
- set_Year- Throws:
- ValueConversionException
 
- set_ZonedDateTime- Throws:
- ValueConversionException
 
- set_XMLDuration- Throws:
- ValueConversionException
 
- set_BigDecimalpublic boolean set_BigDecimal- (BigDecimal value, boolean doTranslate) throws ValueConversionException - Throws:
- ValueConversionException
 
- set_BigIntegerpublic boolean set_BigInteger- (BigInteger value, boolean doTranslate) throws ValueConversionException - Throws:
- ValueConversionException
 
- set_Binary- Throws:
- ValueConversionException
 
- set_Boolean- Throws:
- ValueConversionException
 
- set_Byte- Throws:
- ValueConversionException
 
- set_Double- Throws:
- ValueConversionException
 
- set_Duration- Throws:
- ValueConversionException
 
- set_Float- Throws:
- ValueConversionException
 
- set_Integer- Throws:
- ValueConversionException
 
- set_KString- Throws:
- ValueConversionException
 
- set_LocalDateTimepublic boolean set_LocalDateTime- (LocalDateTime value, boolean doTranslate) throws ValueConversionException - Throws:
- ValueConversionException
 
- set_LocalDate- Throws:
- ValueConversionException
 
- set_LocalTime- Throws:
- ValueConversionException
 
- set_Long- Throws:
- ValueConversionException
 
- set_MonthDay- Throws:
- ValueConversionException
 
- set_OffsetDateTimepublic boolean set_OffsetDateTime- (OffsetDateTime value, boolean doTranslate) throws ValueConversionException - Throws:
- ValueConversionException
 
- set_OffsetTimepublic boolean set_OffsetTime- (OffsetTime value, boolean doTranslate) throws ValueConversionException - Throws:
- ValueConversionException
 
- set_Period- Throws:
- ValueConversionException
 
- set_Short- Throws:
- ValueConversionException
 
- set_String- Throws:
- ValueConversionException
 
- set_YearMonth- Throws:
- ValueConversionException
 
- set_Year- Throws:
- ValueConversionException
 
- set_ZonedDateTimepublic boolean set_ZonedDateTime- (ZonedDateTime value, boolean doTranslate) throws ValueConversionException - Throws:
- ValueConversionException
 
- set_XMLDuration- Throws:
- ValueConversionException
 
- set_BigDecimal- Throws:
- ValueConversionException
 
- set_BigInteger- Throws:
- ValueConversionException
 
- set_Binary- Throws:
- ValueConversionException
 
- set_Boolean- Throws:
- ValueConversionException
 
- set_Byte- Throws:
- ValueConversionException
 
- set_Double- Throws:
- ValueConversionException
 
- set_Duration- Throws:
- ValueConversionException
 
- set_Float- Throws:
- ValueConversionException
 
- set_Integer- Throws:
- ValueConversionException
 
- set_KString- Throws:
- ValueConversionException
 
- set_LocalDateTimepublic boolean set_LocalDateTime- (LocalDateTime value, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- set_LocalDate- Throws:
- ValueConversionException
 
- set_LocalTime- Throws:
- ValueConversionException
 
- set_Long- Throws:
- ValueConversionException
 
- set_MonthDay- Throws:
- ValueConversionException
 
- set_OffsetDateTimepublic boolean set_OffsetDateTime- (OffsetDateTime value, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- set_OffsetTime- Throws:
- ValueConversionException
 
- set_Period- Throws:
- ValueConversionException
 
- set_Short- Throws:
- ValueConversionException
 
- set_String- Throws:
- ValueConversionException
 
- set_YearMonth- Throws:
- ValueConversionException
 
- set_Year- Throws:
- ValueConversionException
 
- set_ZonedDateTimepublic boolean set_ZonedDateTime- (ZonedDateTime value, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- set_XMLDurationpublic boolean set_XMLDuration- (Duration value, boolean doTranslate, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- set_BigDecimalpublic boolean set_BigDecimal- (BigDecimal value, boolean doTranslate, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- set_BigIntegerpublic boolean set_BigInteger- (BigInteger value, boolean doTranslate, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- set_Binarypublic boolean set_Binary- (byte[] value, boolean doTranslate, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- set_Booleanpublic boolean set_Boolean- (Boolean value, boolean doTranslate, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- set_Bytepublic boolean set_Byte- (Byte value, boolean doTranslate, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- set_Doublepublic boolean set_Double- (Double value, boolean doTranslate, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- set_Durationpublic boolean set_Duration- (Duration value, boolean doTranslate, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- set_Floatpublic boolean set_Float- (Float value, boolean doTranslate, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- set_Integerpublic boolean set_Integer- (Integer value, boolean doTranslate, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- set_KStringpublic boolean set_KString- (KString value, boolean doTranslate, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- set_LocalDateTimepublic boolean set_LocalDateTime- (LocalDateTime value, boolean doTranslate, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- set_LocalDatepublic boolean set_LocalDate- (LocalDate value, boolean doTranslate, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- set_LocalTimepublic boolean set_LocalTime- (LocalTime value, boolean doTranslate, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- set_Longpublic boolean set_Long- (Long value, boolean doTranslate, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- set_MonthDaypublic boolean set_MonthDay- (MonthDay value, boolean doTranslate, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- set_OffsetDateTimepublic boolean set_OffsetDateTime- (OffsetDateTime value, boolean doTranslate, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- set_OffsetTimepublic boolean set_OffsetTime- (OffsetTime value, boolean doTranslate, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- set_Periodpublic boolean set_Period- (Period value, boolean doTranslate, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- set_Shortpublic boolean set_Short- (Short value, boolean doTranslate, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- set_Stringpublic boolean set_String- (String value, boolean doTranslate, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- set_YearMonthpublic boolean set_YearMonth- (YearMonth value, boolean doTranslate, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- set_Yearpublic boolean set_Year- (Year value, boolean doTranslate, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- set_ZonedDateTimepublic boolean set_ZonedDateTime- (ZonedDateTime value, boolean doTranslate, GProp<?> trigger) throws ValueConversionException - Throws:
- ValueConversionException
 
- setValueSets a value in generic type with possible translation and no trigger property.- Parameters:
- value- The value in any of the Value type value classes.
- doTranslate- Translate the value using the field actors.
- Returns:
- true if the value is set, false for no change.
- Throws:
- IllegalArgumentException- If the value is not of correct class.
- ValueConversionException- If a field actor throws the exception, or the value cannot be converted.
 
- setValuepublic boolean setValue- (Object value, boolean doTranslate, GProp<?> trigger) throws ValueConversionException Sets a value in generic type with possible translation and optional trigger property.- Parameters:
- value- The value in any of the Value type value classes.
- doTranslate- Translate the value using the field actors.
- trigger- The trigger property, i.e. the "requestor of this method", can be null for none. This value gives extra information for the VSFieldEvent and is not processed in the framework.
- Returns:
- true if the value is set, false for no change.
- Throws:
- IllegalArgumentException- If the value is not of correct class.
- ValueConversionException- If a field actor throws the exception, or the value cannot be converted.
 
- setValuepublic boolean setValue- (LocaleInfo localeInfo, Object value, boolean doTranslate, GProp<?> trigger) throws ValueConversionException Sets a value in generic type with possible translation and optional trigger property.- Parameters:
- localeInfo- The locale info or null for default.
- value- The value in any of the Value type value classes.
- doTranslate- Translate the value using the field actors.
- trigger- The trigger property, i.e. the "requestor of this method", can be null for none. This value gives extra information for the VSFieldEvent and is not processed in the framework.
- Returns:
- true if the value is set, false for no change.
- Throws:
- IllegalArgumentException- If the value is not of correct class.
- ValueConversionException- If a field actor throws the exception, or the value cannot be converted.
 
- adjustValuepublic Value adjustValue- (TemporalAdjuster temporalAdjuster, GProp<?> trigger) throws ValueConversionException Adjusts the current temporal value with a temporal adjuster.- The current value type must be of one of the supported types: - LocalTime,
- OffsetTime,
- LocalDate,
- MonthDay,
- Year,
- YearMonth,
- LocalDateTime,
- OffsetDateTime or
- ZonedDateTime,
 - ValueConversionExceptionis thrown.- This method makes it possible to update e.g. a LocalDateTime with a LocalTime, returning a new LocalDateTime Value with the same LocalDate, but with the new LocalTime. - Parameters:
- temporalAdjuster- The temporal used to adjust with.
- trigger- The triggering component (e.g. UIDateTime), or null for none.
- Returns:
- The new Value set.
- Throws:
- ValueConversionException- If value conversion problems occurs, such as numeric overflow, invalid adjustment, etc, or if the value type is not of correct type.
 
- adjustValueAdjusts the current ZonedDateTime value with a new Zone ID. The new ZonedDateTime is created with the same Local Date and Time but with another Zone ID (and not at the same Instant).- Note: the value type MUST be - ZonedDateTime, otherwise ValueConversionException is thrown!- Parameters:
- zoneID- The zone ID to adjust with.
- trigger- The triggering component (e.g. UIDateTime), or null for none.
- Returns:
- The new Value set.
- Throws:
- ValueConversionException- If value conversion problems occurs, such as current value is null, numeric overflow, etc, or if the value type is not of correct type.
 
- convertEqualsValueVerifies if a value could potentially be equal to the value in the field using conversion. This method is typically used for components matching a state. The values are compared by converting the value in this field to the requested value type (if required). The comparison of the values is then done.- Parameters:
- trigger- The trigger property, i.e. the "requestor of this method", can be null for none. This value gives extra information for the VSFieldEvent and is not processed in the framework.
- values- The value to compare with.
- Returns:
- true The index of the value matching, -1 for none. Logging is done if conversion fails.
 
- paramValueFormats the value as a string to add to- paramString.- Overrides:
- paramValuein class- GProp<GProp<?>[]>
- Parameters:
- value- The property value.
- Returns:
- A string containing all children properties listed.