io.jmix.ui.component.impl

Class TimeFieldImpl<V>

java.lang.Object

io.jmix.ui.component.impl.AbstractComponent<T>

io.jmix.ui.component.impl.AbstractValueComponent<T,P,V>

io.jmix.ui.component.impl.AbstractField<JmixTimeFieldWrapper,java.time.LocalTime,V>

io.jmix.ui.component.impl.TimeFieldImpl<V>

All Implemented Interfaces:

AttachNotifier, Buffered, Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, HasValueSource<V>, Field<V>, HasContextHelp, HasDatatype<V>, HasDebugId, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasValidator<V>, HasValue<V>, Requirable, TimeField<V>, Validatable, org.springframework.beans.factory.InitializingBean

public class TimeFieldImpl<V>
extends AbstractField<JmixTimeFieldWrapper,java.time.LocalTime,V>
implements TimeField<V>, org.springframework.beans.factory.InitializingBean

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.ui.component.TimeField

TimeField.Resolution, TimeField.TimeMode

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasValue

HasValue.ValueChangeEvent<V>

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

Modifier and Type	Field and Description
protected DataAwareComponentsTools	dataAwareComponentsTools
protected io.jmix.core.metamodel.datatype.Datatype<V>	datatype
protected io.jmix.core.DateTimeTransformations	dateTimeTransformations

Fields inherited from class io.jmix.ui.component.impl.AbstractField

editable, parentEditableChangeListener, validators, VALIDATORS_LIST_INITIAL_CAPACITY

Fields inherited from class io.jmix.ui.component.impl.AbstractValueComponent

internalValue, uiTestIdsSupport, valueBinding

Fields inherited from class io.jmix.ui.component.impl.AbstractComponent

alignment, applicationContext, component, contextHelpIconClickHandler, contextHelpIconClickListener, descriptionAsHtml, element, frame, htmlSanitizerEnabled, icon, ICON_STYLE, id, parent

Fields inherited from interface io.jmix.ui.component.TimeField

NAME, TYPE_DEFAULT, TYPE_LOCALTIME, TYPE_OFFSETTIME, TYPE_TIME

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Constructor Summary

Constructors

Constructor and Description
TimeFieldImpl()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	commit() Updates all changes since the previous commit to the data source.
protected void	componentValueChanged(com.vaadin.data.HasValue.ValueChangeEvent<java.time.LocalTime> e)
protected V	constructModelValue()
protected java.lang.Object	convertFromLocalTime(java.time.LocalTime localTime, java.lang.Class javaType)
protected java.time.LocalTime	convertToPresentation(V modelValue)
protected JmixTimeFieldWrapper	createComponent()
void	discard() Discards all changes since last commit.
void	focus() Sets focus to this component
io.jmix.core.metamodel.datatype.Datatype<V>	getDatatype()
java.lang.String	getFormat() Returns the time format of the TimeField.
TimeField.Resolution	getResolution() Returns the resolution of the TimeField.
int	getTabIndex() Gets the tabulator index of the HasTabIndex component.
TimeField.TimeMode	getTimeMode()
boolean	isBuffered()
boolean	isModified() Tests if the value stored in the object has been modified since it was last updated from the data source.
void	setBuffered(boolean buffered) Sets the buffered mode.
void	setDataAwareComponentsTools(DataAwareComponentsTools dataAwareComponentsTools)
void	setDatatype(io.jmix.core.metamodel.datatype.Datatype<V> datatype) Sets the given datatype to the component.
void	setFormat(java.lang.String format) Sets the time format of the TimeField.
void	setResolution(TimeField.Resolution resolution) Sets the resolution of the TimeField.
void	setTabIndex(int tabIndex) Sets the tabulator index of the Focusable component.
void	setTimeMode(TimeField.TimeMode timeMode) Sets time mode to use (12h AM/PM or 24h).

Methods inherited from class io.jmix.ui.component.impl.AbstractField

addValidator, attachValueChangeListener, getDatatypeConversionErrorMsg, getErrorMessage, getRequiredMessage, getValidators, isEditable, isRequired, isValid, removeValidator, setEditable, setEditableToComponent, setParent, setRequired, setRequiredMessage, setupComponentErrorProvider, triggerValidators, validate

Methods inherited from class io.jmix.ui.component.impl.AbstractValueComponent

addValueChangeListener, componentValueChanged, convertToModel, fieldValueEquals, getValue, getValueSource, setUiTestId, setUiTestIdsSupport, setValue, setValueSource, setValueToPresentation, valueBindingActivated, valueBindingConnected

Methods inherited from class io.jmix.ui.component.impl.AbstractComponent

addAttachListener, addDetachListener, addStyleName, assignDebugId, attached, detached, getAlignment, getCaption, getComponent, getComposition, getContextHelpIconClickHandler, getContextHelpText, getDebugId, getDescription, getEventHub, getFrame, getHeight, getHeightSizeUnit, getHtmlSanitizer, getIcon, getIconName, getIconResource, getId, getParent, getStyleName, getUiComponentProperties, getUiProperties, getWidth, getWidthSizeUnit, getXmlDescriptor, hasSubscriptions, hasValidationError, isAttached, isCaptionAsHtml, isContextHelpTextHtmlEnabled, isDescriptionAsHtml, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, onContextHelpIconClick, publish, removeStyleName, sanitize, setAlignment, setApplicationContext, setCaption, setCaptionAsHtml, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled, setDebugId, setDescription, setDescriptionAsHtml, setEnabled, setFrame, setHeight, setHtmlSanitizerEnabled, setIcon, setIconFromSet, setId, setResponsive, setStyleName, setValidationError, setVisible, setWidth, setXmlDescriptor, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.jmix.ui.component.data.HasValueSource

getValueSource, setValueSource

Methods inherited from interface io.jmix.ui.component.HasValue

addValueChangeListener, clear, getEmptyValue, getValue, isEmpty, setValue

Methods inherited from interface io.jmix.ui.component.Component.Editable

isEditable, isEditableWithParent, setEditable

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface io.jmix.ui.component.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.Validatable

isValid, isValidateOnCommit, validate

Methods inherited from interface io.jmix.ui.component.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface io.jmix.ui.component.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface io.jmix.ui.component.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface io.jmix.ui.component.Component.HasCaption

getCaption, setCaption

Methods inherited from interface io.jmix.ui.component.Component.HasDescription

getDescription, setDescription

Methods inherited from interface io.jmix.ui.component.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface io.jmix.ui.component.HasHtmlSanitizer

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Methods inherited from interface io.jmix.ui.component.HasValidator

addValidator, addValidators, getValidators, removeValidator

Methods inherited from interface io.jmix.ui.component.Requirable

getRequiredMessage, isRequired, setRequired, setRequiredMessage

Methods inherited from interface io.jmix.ui.component.Component.Focusable

isFocusable, setFocusable

Field Detail

dateTimeTransformations

@Autowired
protected io.jmix.core.DateTimeTransformations dateTimeTransformations

dataAwareComponentsTools

protected DataAwareComponentsTools dataAwareComponentsTools

datatype

protected io.jmix.core.metamodel.datatype.Datatype<V> datatype

Constructor Detail

TimeFieldImpl

public TimeFieldImpl()

Method Detail

setDataAwareComponentsTools

@Autowired
public void setDataAwareComponentsTools(DataAwareComponentsTools dataAwareComponentsTools)

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

setFormat

public void setFormat(java.lang.String format)

Description copied from interface: TimeField

Sets the time format of the TimeField. It can be either a format string, or a key in message group.

Specified by:

setFormat in interface TimeField<V>

Parameters:

format - time format

getFormat

public java.lang.String getFormat()

Description copied from interface: TimeField

Returns the time format of the TimeField.

Specified by:

getFormat in interface TimeField<V>

Returns:

time format

getResolution

public TimeField.Resolution getResolution()

Description copied from interface: TimeField

Returns the resolution of the TimeField.

Specified by:

getResolution in interface TimeField<V>

Returns:

Resolution

setResolution

public void setResolution(TimeField.Resolution resolution)

Description copied from interface: TimeField

Sets the resolution of the TimeField.

Specified by:

setResolution in interface TimeField<V>

Parameters:

resolution - resolution

getDatatype

@Nullable
public io.jmix.core.metamodel.datatype.Datatype<V> getDatatype()

Specified by:

getDatatype in interface HasDatatype<V>

Returns:

a datatype that is used by this component

setDatatype

public void setDatatype(io.jmix.core.metamodel.datatype.Datatype<V> datatype)

Description copied from interface: HasDatatype

Sets the given datatype to the component. Its value will be formatted according to this datatype.

Specified by:

setDatatype in interface HasDatatype<V>

Parameters:

datatype - Datatype instance

focus

public void focus()

Description copied from interface: Component.Focusable

Sets focus to this component

Specified by:

focus in interface Component.Focusable

getTabIndex

public int getTabIndex()

Description copied from interface: Component.Focusable

Gets the tabulator index of the HasTabIndex component.

Specified by:

getTabIndex in interface Component.Focusable

Returns:

tab index set for the HasTabIndex component

setTabIndex

public void setTabIndex(int tabIndex)

Description copied from interface: Component.Focusable

Sets the tabulator index of the Focusable component. The tab index property is used to specify the order in which the fields are focused when the user presses the Tab key. Components with a defined tab index are focused sequentially first, and then the components with no tab index.

Specified by:

setTabIndex in interface Component.Focusable

Parameters:

tabIndex - tab index

setTimeMode

public void setTimeMode(TimeField.TimeMode timeMode)

Description copied from interface: TimeField

Sets time mode to use (12h AM/PM or 24h).

By default the 24h mode is used.

Specified by:

setTimeMode in interface TimeField<V>

Parameters:

timeMode - time mode

getTimeMode

public TimeField.TimeMode getTimeMode()

Specified by:

getTimeMode in interface TimeField<V>

Returns:

TimeField.TimeMode that is used by component

commit

public void commit()

Description copied from interface: Buffered

Updates all changes since the previous commit to the data source.

Specified by:

commit in interface Buffered

Overrides:

commit in class AbstractValueComponent<JmixTimeFieldWrapper,java.time.LocalTime,V>

discard

public void discard()

Description copied from interface: Buffered

Discards all changes since last commit. The object updates its value from the data source.

Specified by:

discard in interface Buffered

Overrides:

discard in class AbstractValueComponent<JmixTimeFieldWrapper,java.time.LocalTime,V>

isBuffered

public boolean isBuffered()

Specified by:

isBuffered in interface Buffered

Overrides:

isBuffered in class AbstractValueComponent<JmixTimeFieldWrapper,java.time.LocalTime,V>

Returns:

true if buffered mode is on, false otherwise

setBuffered

public void setBuffered(boolean buffered)

Description copied from interface: Buffered

Sets the buffered mode.

When in buffered mode, an internal buffer will be used to store changes until Buffered.commit() is called. Calling Buffered.discard() will revert the internal buffer to the value of the data source.

When in non-buffered mode both read and write operations will be done directly on the data source. In this mode the Buffered.commit() and Buffered.discard() methods serve no purpose.

Specified by:

setBuffered in interface Buffered

Overrides:

setBuffered in class AbstractValueComponent<JmixTimeFieldWrapper,java.time.LocalTime,V>

Parameters:

buffered - true if buffered mode should be turned on, false otherwise

isModified

public boolean isModified()

Description copied from interface: Buffered

Tests if the value stored in the object has been modified since it was last updated from the data source.

Specified by:

isModified in interface Buffered

Overrides:

isModified in class AbstractValueComponent<JmixTimeFieldWrapper,java.time.LocalTime,V>

Returns:

true if the value in the object has been modified since the last data source update, false if not.

convertToPresentation

@Nullable
protected java.time.LocalTime convertToPresentation(@Nullable
                                                              V modelValue)
                                                       throws ConversionException

Overrides:

convertToPresentation in class AbstractValueComponent<JmixTimeFieldWrapper,java.time.LocalTime,V>

Throws:

ConversionException

createComponent

protected JmixTimeFieldWrapper createComponent()

componentValueChanged

protected void componentValueChanged(com.vaadin.data.HasValue.ValueChangeEvent<java.time.LocalTime> e)

constructModelValue

@Nullable
protected V constructModelValue()

convertFromLocalTime

protected java.lang.Object convertFromLocalTime(java.time.LocalTime localTime,
                                                java.lang.Class javaType)