Package io.jmix.ui.component.impl

Class DateFieldImpl<V extends Comparable<V>>

java.lang.Object

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

io.jmix.ui.component.impl.AbstractViewComponent<JmixCssActionsLayout,LocalDateTime,V>

io.jmix.ui.component.impl.DateFieldImpl<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>, DateField<V>, Field<V>, HasContextHelp, HasDatatype<V>, HasDebugId, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasRange<V>, HasValidator<V>, HasValue<V>, Requirable, Validatable, org.springframework.beans.factory.InitializingBean

public class DateFieldImpl<V extends Comparable<V>>
extends AbstractViewComponent<JmixCssActionsLayout,LocalDateTime,V>
implements DateField<V>, org.springframework.beans.factory.InitializingBean

Nested Class Summary

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

DateField.Resolution

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

HasContextHelp.ContextHelpIconClickEvent

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

HasValue.ValueChangeEvent<V>

Field Summary

Fields

Modifier and Type	Field	Description
protected DataAwareComponentsTools	dataAwareComponentsTools
protected Datatype<V>	datatype
protected JmixDateField	dateField
static final String	DATEFIELD_WITH_TIME_STYLENAME
protected String	dateTimeFormat
protected DateTimeTransformations	dateTimeTransformations
protected boolean	editable
protected Subscription	parentEditableChangeSubscription
protected V	rangeEnd
protected V	rangeStart
protected boolean	required
protected DateField.Resolution	resolution
protected ThemeConstants	theme
protected JmixTimeFieldWrapper	timeField
protected boolean	updatingInstance
protected List<Validator<V>>	validators
protected static final int	VALIDATORS_LIST_INITIAL_CAPACITY
protected Subscription	valueSourceStateChangeSubscription
protected ZoneId	zoneId

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

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

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

NAME, TYPE_DATE, TYPE_DATETIME, TYPE_DEFAULT, TYPE_LOCALDATE, TYPE_LOCALDATETIME, TYPE_OFFSETDATETIME

Constructor Summary

Constructors

Constructor	Description
DateFieldImpl()

Method Summary

Modifier and Type	Method	Description
void	addValidator(Validator<? super V> validator)	Adds a validator instance to the component.
void	afterPropertiesSet()
protected boolean	checkRange(V value, boolean handleError)
void	commit()	Updates all changes since the previous commit to the data source.
protected void	componentValueChanged(com.vaadin.data.HasValue.ValueChangeEvent<?> e)
protected V	constructModelValue()
protected Object	convertFromLocalDateTime(LocalDateTime localDateTime, ZoneId fromZoneId, Class javaType)
protected LocalDateTime	convertToLocalDateTime(Object date, ZoneId zoneId)
protected LocalDateTime	convertToPresentation(V modelValue)
protected JmixCssActionsLayout	createComponent()
protected JmixDateField	createDateField()
protected JmixTimeFieldWrapper	createTimeField()
void	discard()	Discards all changes since last commit.
protected int	findTimeStartPos(String dateTimeFormat)
void	focus()	Sets focus to this component
Datatype<V>	getDatatype()
String	getDateFormat()
protected com.vaadin.server.ErrorMessage	getErrorMessage()
V	getRangeEnd()	Return end of range for a certain resolution.
V	getRangeStart()	Return start of range for a certain resolution.
String	getRequiredMessage()
DateField.Resolution	getResolution()
int	getTabIndex()	Gets the tabulator index of the HasTabIndex component.
TimeField.TimeMode	getTimeMode()
TimeZone	getTimeZone()	Use DateField.getZoneId()
Collection<Validator<V>>	getValidators()
ZoneId	getZoneId()
protected void	handleDateOutOfRange(V value)
protected boolean	hasValidationError()
protected void	initDateField(JmixDateField dateField)
protected void	initTimeField(JmixTimeFieldWrapper timeField)
boolean	isAutofill()
boolean	isBuffered()
boolean	isEditable()
boolean	isModified()	Tests if the value stored in the object has been modified since it was last updated from the data source.
boolean	isRequired()
boolean	isValid()
protected void	onParentEditableChange(EditableChangeNotifier.EditableChangeEvent event)
void	removeValidator(Validator<V> validator)	Removes a validator instance from the component.
void	setAutofill(boolean autofill)	Sets whether autofill feature is enabled.
void	setBuffered(boolean buffered)	Sets the buffered mode.
void	setDataAwareComponentsTools(DataAwareComponentsTools dataAwareComponentsTools)
void	setDatatype(Datatype<V> datatype)	Sets the given datatype to the component.
void	setDateFormat(String dateFormat)
void	setDateTimeTransformations(DateTimeTransformations dateTimeTransformations)
void	setDebugId(String id)	INTERNAL.
void	setDescription(String description)	Sets the component's description.
void	setEditable(boolean editable)
protected void	setEditableToComponent(boolean editable)
void	setParent(Component parent)	INTERNAL. ComponentContainer.add(Component) is normally used for adding components to a parent and the used method will call this method implicitly.
void	setRangeEnd(V value)	Set end of range.
void	setRangeStart(V value)	Set start of range.
void	setRequired(boolean required)	Sets whether the component must contain a non-null value.
void	setRequiredMessage(String msg)	Sets a message that will be displayed to user if the field is required but has null value.
void	setResolution(DateField.Resolution resolution)
protected void	setResolutionInternal(DateField.Resolution resolution)
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).
void	setTimeZone(TimeZone timeZone)	Use DateField.setZoneId(ZoneId)
protected void	setupComponentErrorProvider(boolean required, com.vaadin.ui.AbstractComponent component)
protected void	setValidationError(String errorMessage)
protected void	setValueToPresentation(LocalDateTime value)
void	setZoneId(ZoneId zoneId)
protected void	triggerValidators(V value)
protected void	updateLayout()
void	validate()
protected void	valueBindingConnected(ValueSource<V> valueSource)

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

addValueChangeListener, fieldValueEquals, getValue, getValueSource, setUiTestId, setUiTestIdsSupport, setValue, setValueSource, valueBindingActivated

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, isAttached, isCaptionAsHtml, isContextHelpTextHtmlEnabled, isDescriptionAsHtml, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, onContextHelpIconClick, publish, removeStyleName, sanitize, setAlignment, setApplicationContext, setCaption, setCaptionAsHtml, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled, setDescriptionAsHtml, setEnabled, setFrame, setHeight, setHtmlSanitizerEnabled, setIcon, setIconFromSet, setId, setResponsive, setStyleName, 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.Component

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

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

getFrame, setFrame

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

isEditableWithParent

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

isFocusable, setFocusable

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

getCaption, setCaption

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

getDescription

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

isDescriptionAsHtml, setDescriptionAsHtml

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

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

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

addValidators

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

addValueChangeListener, clear, getEmptyValue, getValue, isEmpty, setValue

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

getValueSource, setValueSource

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

isValidateOnCommit

Field Details

DATEFIELD_WITH_TIME_STYLENAME

public static final String DATEFIELD_WITH_TIME_STYLENAME

See Also:

• Constant Field Values

VALIDATORS_LIST_INITIAL_CAPACITY

protected static final int VALIDATORS_LIST_INITIAL_CAPACITY

See Also:

• Constant Field Values

dateTimeTransformations

protected DateTimeTransformations dateTimeTransformations

validators

protected List<Validator<V extends Comparable<V>>> validators

resolution

protected DateField.Resolution resolution

zoneId

protected ZoneId zoneId

datatype

protected Datatype<V extends Comparable<V>> datatype

rangeStart

protected V extends Comparable<V> rangeStart

rangeEnd

protected V extends Comparable<V> rangeEnd

updatingInstance

protected boolean updatingInstance

dateField

protected JmixDateField dateField

timeField

protected JmixTimeFieldWrapper timeField

dateTimeFormat

protected String dateTimeFormat

editable

protected boolean editable

required

protected boolean required

theme

protected ThemeConstants theme

parentEditableChangeSubscription

protected Subscription parentEditableChangeSubscription

valueSourceStateChangeSubscription

protected Subscription valueSourceStateChangeSubscription

dataAwareComponentsTools

protected DataAwareComponentsTools dataAwareComponentsTools

Constructor Details

DateFieldImpl

public DateFieldImpl()

Method Details

createComponent

protected JmixCssActionsLayout createComponent()

createDateField

protected JmixDateField createDateField()

initDateField

protected void initDateField(JmixDateField dateField)

createTimeField

protected JmixTimeFieldWrapper createTimeField()

initTimeField

protected void initTimeField(JmixTimeFieldWrapper timeField)

setDataAwareComponentsTools

@Autowired
public void setDataAwareComponentsTools(DataAwareComponentsTools dataAwareComponentsTools)

setDateTimeTransformations

@Autowired
public void setDateTimeTransformations(DateTimeTransformations dateTimeTransformations)

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

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

componentValueChanged

protected void componentValueChanged(com.vaadin.data.HasValue.ValueChangeEvent<?> e)

getResolution

@Nullable
public DateField.Resolution getResolution()

Specified by:

getResolution in interface DateField<V extends Comparable<V>>

setResolution

public void setResolution(DateField.Resolution resolution)

Specified by:

setResolution in interface DateField<V extends Comparable<V>>

setResolutionInternal

protected void setResolutionInternal(DateField.Resolution resolution)

getDatatype

@Nullable
public Datatype<V> getDatatype()

Specified by:

getDatatype in interface HasDatatype<V extends Comparable<V>>

Returns:

a datatype that is used by this component

setDatatype

public void setDatatype(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 extends Comparable<V>>

Parameters:

datatype - Datatype instance

setRangeStart

public void setRangeStart(@Nullable
 V value)

Description copied from interface: HasRange

Set start of range. If the value is set before this date, the component will not validate.

Specified by:

setRangeStart in interface HasRange<V extends Comparable<V>>

Parameters:

value - allowed start of range

getRangeStart

@Nullable
public V getRangeStart()

Description copied from interface: HasRange

Return start of range for a certain resolution.

Specified by:

getRangeStart in interface HasRange<V extends Comparable<V>>

Returns:

start of allowed range

setRangeEnd

public void setRangeEnd(@Nullable
 V value)

Description copied from interface: HasRange

Set end of range. If the value is set after this date, the component will not validate.

Specified by:

setRangeEnd in interface HasRange<V extends Comparable<V>>

Parameters:

value - end of allowed range

getRangeEnd

@Nullable
public V getRangeEnd()

Description copied from interface: HasRange

Return end of range for a certain resolution.

Specified by:

getRangeEnd in interface HasRange<V extends Comparable<V>>

Returns:

end of allowed range

checkRange

protected boolean checkRange(@Nullable
 V value,
 boolean handleError)

handleDateOutOfRange

protected void handleDateOutOfRange(V value)

getDateFormat

@Nullable
public String getDateFormat()

Specified by:

getDateFormat in interface DateField<V extends Comparable<V>>

setDateFormat

public void setDateFormat(String dateFormat)

Specified by:

setDateFormat in interface DateField<V extends Comparable<V>>

getTimeZone

@Nullable
public TimeZone getTimeZone()

Description copied from interface: DateField

Use DateField.getZoneId()

Specified by:

getTimeZone in interface DateField<V extends Comparable<V>>

setTimeZone

public void setTimeZone(@Nullable
 TimeZone timeZone)

Description copied from interface: DateField

Use DateField.setZoneId(ZoneId)

Specified by:

setTimeZone in interface DateField<V extends Comparable<V>>

getZoneId

@Nullable
public ZoneId getZoneId()

Specified by:

getZoneId in interface DateField<V extends Comparable<V>>

setAutofill

public void setAutofill(boolean autofill)

Description copied from interface: DateField

Sets whether autofill feature is enabled.

When enabled uses current month and year.

Specified by:

setAutofill in interface DateField<V extends Comparable<V>>

Parameters:

autofill - whether autofill is enabled

isAutofill

public boolean isAutofill()

Specified by:

isAutofill in interface DateField<V extends Comparable<V>>

Returns:

whether autofill is enabled

setZoneId

public void setZoneId(@Nullable
 ZoneId zoneId)

Specified by:

setZoneId in interface DateField<V extends Comparable<V>>

updateLayout

protected void updateLayout()

findTimeStartPos

protected int findTimeStartPos(String dateTimeFormat)

setValueToPresentation

protected void setValueToPresentation(@Nullable
 LocalDateTime value)

Specified by:

setValueToPresentation in class AbstractViewComponent<JmixCssActionsLayout,LocalDateTime,V extends Comparable<V>>

constructModelValue

@Nullable
protected V constructModelValue()

convertToPresentation

@Nullable
protected LocalDateTime convertToPresentation(@Nullable
 V modelValue)
                                       throws ConversionException

Overrides:

convertToPresentation in class AbstractViewComponent<JmixCssActionsLayout,LocalDateTime,V extends Comparable<V>>

Throws:

ConversionException

convertToLocalDateTime

protected LocalDateTime convertToLocalDateTime(Object date,
 @Nullable
 ZoneId zoneId)

convertFromLocalDateTime

protected Object convertFromLocalDateTime(LocalDateTime localDateTime,
 @Nullable
 ZoneId fromZoneId,
 Class javaType)

setDescription

public void setDescription(@Nullable
 String description)

Description copied from interface: Component.HasDescription

Sets the component's description.

Specified by:

setDescription in interface Component.HasDescription

Overrides:

setDescription in class AbstractComponent<JmixCssActionsLayout>

Parameters:

description - the new description to set

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

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

isBuffered

public boolean isBuffered()

Specified by:

isBuffered in interface Buffered

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

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

Returns:

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

setDebugId

public void setDebugId(@Nullable
 String id)

Description copied from interface: HasDebugId

INTERNAL. Managed by debug Id system.

Specified by:

setDebugId in interface HasDebugId

Overrides:

setDebugId in class AbstractComponent<JmixCssActionsLayout>

valueBindingConnected

protected void valueBindingConnected(ValueSource<V> valueSource)

Overrides:

valueBindingConnected in class AbstractViewComponent<JmixCssActionsLayout,LocalDateTime,V extends Comparable<V>>

setParent

public void setParent(@Nullable
 Component parent)

Description copied from interface: Component

INTERNAL.
ComponentContainer.add(Component) is normally used for adding components to a parent and the used method will call this method implicitly.

Specified by:

setParent in interface Component

Overrides:

setParent in class AbstractComponent<JmixCssActionsLayout>

Parameters:

parent - Parent component

onParentEditableChange

protected void onParentEditableChange(EditableChangeNotifier.EditableChangeEvent event)

isEditable

public boolean isEditable()

Specified by:

isEditable in interface Component.Editable

setEditable

public void setEditable(boolean editable)

Specified by:

setEditable in interface Component.Editable

setEditableToComponent

protected void setEditableToComponent(boolean editable)

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

isRequired

public boolean isRequired()

Specified by:

isRequired in interface Requirable

Returns:

whether the component must contain a non-null value

setRequired

public void setRequired(boolean required)

Description copied from interface: Requirable

Sets whether the component must contain a non-null value.

Specified by:

setRequired in interface Requirable

Parameters:

required - required

setupComponentErrorProvider

protected void setupComponentErrorProvider(boolean required,
 com.vaadin.ui.AbstractComponent component)

getErrorMessage

@Nullable
protected com.vaadin.server.ErrorMessage getErrorMessage()

getRequiredMessage

@Nullable
public String getRequiredMessage()

Specified by:

getRequiredMessage in interface Requirable

Returns:

a message that will be displayed to user if the component is required but has null value

setRequiredMessage

public void setRequiredMessage(@Nullable
 String msg)

Description copied from interface: Requirable

Sets a message that will be displayed to user if the field is required but has null value.

Specified by:

setRequiredMessage in interface Requirable

Parameters:

msg - message

addValidator

public void addValidator(Validator<? super V> validator)

Description copied from interface: HasValidator

Adds a validator instance to the component. The ValidationException must be thrown by the validator if the value is not valid.

Specified by:

addValidator in interface HasValidator<V extends Comparable<V>>

Parameters:

validator - a validator to add

See Also:

• ValidationException

removeValidator

public void removeValidator(Validator<V> validator)

Description copied from interface: HasValidator

Removes a validator instance from the component.

Specified by:

removeValidator in interface HasValidator<V extends Comparable<V>>

Parameters:

validator - a validator to remove

getValidators

public Collection<Validator<V>> getValidators()

Specified by:

getValidators in interface HasValidator<V extends Comparable<V>>

Returns:

unmodifiable collection of component validators.

isValid

public boolean isValid()

Specified by:

isValid in interface Validatable

validate

public void validate()
              throws ValidationException

Specified by:

validate in interface Validatable

Throws:

ValidationException

triggerValidators

protected void triggerValidators(V value)
                          throws ValidationFailedException

Throws:

ValidationFailedException

hasValidationError

protected boolean hasValidationError()

Overrides:

hasValidationError in class AbstractComponent<JmixCssActionsLayout>

setValidationError

protected void setValidationError(@Nullable
 String errorMessage)

Overrides:

setValidationError in class AbstractComponent<JmixCssActionsLayout>

setTimeMode

public void setTimeMode(TimeField.TimeMode timeMode)

Description copied from interface: DateField

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

By default the 24h mode is used.

Specified by:

setTimeMode in interface DateField<V extends Comparable<V>>

Parameters:

timeMode - time mode

getTimeMode

@Nullable
public TimeField.TimeMode getTimeMode()

Specified by:

getTimeMode in interface DateField<V extends Comparable<V>>

Returns:

TimeField.TimeMode that is used by component