Package com.iizix.prop.ui.value

Interface IUIDateTimeComponent

All Superinterfaces:

IComponent, ICustomDataProvider, IGProp<GProp<?>[]>, IMessageBox, IPropCnr, IUIComp, IUIValueComponent, IVSComponentListener, IVSComponentState, IVSFieldListener

All Known Subinterfaces:

IUIDateValueComponent, IUITimeValueComponent

All Known Implementing Classes:

EUICalendar, EUIDateTime, UICalendar, UIDateTime

public interface IUIDateTimeComponent
extends IUIValueComponent

Interface implemented by value supporting components with a date/time value.

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 Summary

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.ui.IUIComp

ERROR, INFORMATION, NONE, REMOTE_FOCUS_EVENT, WARNING

Method Summary

Modifier and Type	Method	Description
default DateTimeProp	createValueProp()	Component must return the value property to use with the name Atom.VALUE.
GDateTime	getDefaultValue()	Gets the default value of the component as a GDateTime.
default GDateTime	getValue()	Gets the value of the component as a GDateTime.
default GDateTime	getValueOrDefault()	Gets the value of the component as without throwing an exception as opposed to getValue() but falls back to the default value if undefined.
default boolean	isDateValueRequired()	Returns if the implementation requires a date in the value component.
boolean	isDateValueSupported()	Returns if the implementation supports date.
default boolean	isTimeValueRequired()	Returns if the implementation requires a time in the value component.
boolean	isTimeValueSupported()	Returns if the implementation supports time.
boolean	setValue(GDateTime value)	Sets the value of the component as a date/time value.

Methods inherited from interface com.iizix.IComponent

clearErrorMessage, getBadge, getKStringText, getLayoutMgr, getMessage, getMessageText, getStyles, getText, getTooltip, getTooltipText, getUIPanel, getUIParent, isEnabled, isReadOnly, isVisible, messageBox, requestFocus, requestFocus, requestFocusEx, requestFocusEx, setBadge, setBadge, setEnabled, setErrorMessage, setErrorMessage, setHTMLText, setLayoutMgr, setMessage, setMessage, setReadOnly, setText, setText, setTooltip, setTooltip, setVisible

Methods inherited from interface com.iizix.prop.ICustomDataProvider

forbiddenGetCustomDataMap, getCustomData, putCustomData, putCustomDataIfAbsent

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, getPropBaseReference, getPropError, getPropError, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getReferencePropName, getReferences, getRelativePropName, getRootParent, getTreeLock, getValueClasses, getVSReference, hasChanged, 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, onEventSelf, 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, verifyHasPropertyItem, 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, 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, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, 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.ui.IUIComp

canAcceptUIContainerFocus, disconnectVSField, getComponentID, getComponentMappings, getDeviceType, getErrorMessage, getErrorMessage, getFirstUIComponent, getFirstUIComponentNull, getFixHeight, getFixWidth, getLayout, getLayoutMgr, getPanelUIComponent, getPanelUIComponentNull, getUIRef, getValue, getValue, getVirtualSpace, getVSField, isMobile, isRTL, isVSFieldDisconnected, reconnectVSField, setComponentToVSField, setErrorMessage, setErrorMessage, setUIContainerFocus, setVSFieldMessageToComponent, setVSFieldToComponent

Methods inherited from interface com.iizix.prop.vs.IVSComponentListener

onParentStateChanged

Methods inherited from interface com.iizix.prop.vs.IVSFieldListener

getBestVSFieldValueType, onBroken, onResolved, onStateChanged, onValueChanged

Method Detail

createValueProp

default DateTimeProp createValueProp()

Component must return the value property to use with the name Atom.VALUE.

Specified by:

createValueProp in interface IUIValueComponent

Returns:

DateTimeProp for date/time support,

isDateValueSupported

boolean isDateValueSupported()

Returns if the implementation supports date.

Returns:

true if date is supported, false for only time support.

isDateValueRequired

default boolean isDateValueRequired()

Returns if the implementation requires a date in the value component.

Returns:

true if date is required, false otherwise.

isTimeValueSupported

boolean isTimeValueSupported()

Returns if the implementation supports time.

Returns:

true if time is supported, false for only date support.

isTimeValueRequired

default boolean isTimeValueRequired()

Returns if the implementation requires a time in the value component.

Returns:

true if time is required, false otherwise.

setValue

boolean setValue(GDateTime value)
          throws java.lang.IllegalArgumentException

Sets the value of the component as a date/time value.

Parameters:

value - The date/time value.

Returns:

true for value changed, false for no change.

Throws:

java.lang.IllegalArgumentException - If the value is out of range or if the date/time value does not contain the time or date parts required by the component.

getValue

default GDateTime getValue()
                    throws NotFoundException

Gets the value of the component as a GDateTime.

Returns:

The GDateTime value of the component.

Throws:

NotFoundException - If the value is undefined.

getValueOrDefault

default GDateTime getValueOrDefault()

Gets the value of the component as without throwing an exception as opposed to getValue() but falls back to the default value if undefined.

Returns:

The value of the component, or the default value if undefined.

getDefaultValue

GDateTime getDefaultValue()

Gets the default value of the component as a GDateTime.

Returns:

The default GDateTime value of the component.