Package com.vaadin.flow.component.datepicker

Class DatePicker

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.AbstractField<C,T>

com.vaadin.flow.component.AbstractSinglePropertyField<DatePicker,LocalDate>

com.vaadin.flow.component.datepicker.DatePicker

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<DatePicker>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<DatePicker>, com.vaadin.flow.component.FocusNotifier<DatePicker>, com.vaadin.flow.component.HasAriaLabel, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasHelper, com.vaadin.flow.component.HasLabel, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.HasValidation, com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<DatePicker,LocalDate>,LocalDate>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<DatePicker,LocalDate>,LocalDate>, HasAllowedCharPattern, HasAutoOpen, HasClearButton, HasClientValidation, HasOverlayClassName, HasPrefix, HasThemeVariant<DatePickerVariant>, HasTooltip, HasValidationProperties, InputField<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<DatePicker,LocalDate>,LocalDate>, com.vaadin.flow.data.binder.HasValidator<LocalDate>, Serializable

@Tag("vaadin-date-picker")
@NpmPackage(value="@vaadin/polymer-legacy-adapter",version="24.2.0") @NpmPackage(value="@vaadin/date-picker",version="24.2.0") @NpmPackage(value="date-fns",version="2.29.3")
@JsModule("@vaadin/polymer-legacy-adapter/style-modules.js") @JsModule("@vaadin/date-picker/src/vaadin-date-picker.js") @JsModule("./datepickerConnector.js")
public class DatePicker
extends com.vaadin.flow.component.AbstractSinglePropertyField<DatePicker,LocalDate>
implements com.vaadin.flow.component.Focusable<DatePicker>, HasAllowedCharPattern, com.vaadin.flow.component.HasAriaLabel, HasAutoOpen, HasClearButton, HasClientValidation, com.vaadin.flow.component.HasHelper, InputField<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<DatePicker,LocalDate>,LocalDate>, HasOverlayClassName, HasPrefix, HasThemeVariant<DatePickerVariant>, HasValidationProperties, com.vaadin.flow.data.binder.HasValidator<LocalDate>

Date Picker is an input field that allows the user to enter a date by typing or by selecting from a calendar overlay.

DatePicker allows setting and getting LocalDate objects, setting minimum and maximum date ranges and has internationalization support by using the DatePicker.DatePickerI18n object.

This component allows the date to be entered directly using the keyboard in the format of the current locale or through the date picker overlay. The overlay opens when the field is clicked and/or any input is entered when the field is focused.

Author:

Vaadin Ltd

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DatePicker.DatePickerI18n	The internationalization properties for DatePicker.
static class	DatePicker.InvalidChangeEvent	invalid-changed event is sent when the invalid state changes.
static class	DatePicker.OpenedChangeEvent	opened-changed event is sent when the overlay opened state changes.

Nested classes/interfaces inherited from class com.vaadin.flow.component.AbstractField

com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<C extends com.vaadin.flow.component.Component,V extends Object>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.BlurNotifier

com.vaadin.flow.component.BlurNotifier.BlurEvent<C extends com.vaadin.flow.component.Component>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.FocusNotifier

com.vaadin.flow.component.FocusNotifier.FocusEvent<C extends com.vaadin.flow.component.Component>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.shared.HasClientValidation

HasClientValidation.ClientValidatedEvent

Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasValue

com.vaadin.flow.component.HasValue.ValueChangeEvent<V extends Object>, com.vaadin.flow.component.HasValue.ValueChangeListener<E extends com.vaadin.flow.component.HasValue.ValueChangeEvent<?>>

Constructor Summary

Constructors

Constructor	Description
DatePicker()	Default constructor.
DatePicker(com.vaadin.flow.component.HasValue.ValueChangeListener<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<DatePicker,LocalDate>> listener)	Convenience constructor to create a date picker with a HasValue.ValueChangeListener.
DatePicker(String label)	Convenience constructor to create a date picker with a label.
DatePicker(String label, com.vaadin.flow.component.HasValue.ValueChangeListener<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<DatePicker,LocalDate>> listener)	Convenience constructor to create a date picker with a HasValue.ValueChangeListener and a label.
DatePicker(String label, LocalDate initialDate)	Convenience constructor to create a date picker with a pre-selected date in current UI locale format and a label.
DatePicker(String label, LocalDate initialDate, com.vaadin.flow.component.HasValue.ValueChangeListener<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<DatePicker,LocalDate>> listener)	Convenience constructor to create a date picker with a pre-selected date in current UI locale format, a HasValue.ValueChangeListener and a label.
DatePicker(LocalDate initialDate)	Convenience constructor to create a date picker with a pre-selected date in current UI locale format.
DatePicker(LocalDate initialDate, com.vaadin.flow.component.HasValue.ValueChangeListener<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<DatePicker,LocalDate>> listener)	Convenience constructor to create a date picker with a pre-selected date in current UI locale format and a HasValue.ValueChangeListener.
DatePicker(LocalDate initialDate, Locale locale)	Convenience Constructor to create a date picker with pre-selected date and locale setup.

Method Summary

Modifier and Type	Method	Description
com.vaadin.flow.shared.Registration	addInvalidChangeListener(com.vaadin.flow.component.ComponentEventListener<DatePicker.InvalidChangeEvent> listener)	Adds a listener for invalid-changed events fired by the webcomponent.
com.vaadin.flow.shared.Registration	addOpenedChangeListener(com.vaadin.flow.component.ComponentEventListener<DatePicker.OpenedChangeEvent> listener)	Adds a listener for opened-changed events fired by the webcomponent.
com.vaadin.flow.shared.Registration	addValidationStatusChangeListener(com.vaadin.flow.data.binder.ValidationStatusChangeListener<LocalDate> listener)
protected void	close()	Closes the datepicker overlay.
Optional<String>	getAriaLabel()
Optional<String>	getAriaLabelledBy()
com.vaadin.flow.data.binder.Validator<LocalDate>	getDefaultValidator()
DatePicker.DatePickerI18n	getI18n()	Gets the internationalization object previously set for this component.
LocalDate	getInitialPosition()	Get the visible date when there is no value selected.
String	getLabel()	Gets the label of the datepicker.
Locale	getLocale()	Gets the Locale for this date picker
LocalDate	getMax()	Gets the maximum date in the date picker.
LocalDate	getMin()	Gets the minimum date in the date picker.
String	getName()	Gets the name of the DatePicker.
String	getPlaceholder()	The placeholder text that should be displayed in the input element, when the user has not entered a value.
protected boolean	isInputValuePresent()	Returns whether the input element has a value or not.
boolean	isOpened()	Gets the states of the drop-down for the datepicker
boolean	isRequired()	Determines whether the datepicker is marked as input required.
boolean	isWeekNumbersVisible()	Get the state of showWeekNumbers property of the datepicker
protected void	onAttach(com.vaadin.flow.component.AttachEvent attachEvent)
void	open()	Opens the datepicker overlay.
void	setAriaLabel(String ariaLabel)
void	setAriaLabelledBy(String labelledBy)
void	setI18n(DatePicker.DatePickerI18n i18n)	Sets the internationalization properties for this component.
void	setInitialPosition(LocalDate initialPosition)	Date which should be visible when there is no value selected.
void	setLabel(String label)	Sets the label for the datepicker.
void	setLocale(Locale locale)	Set the Locale for the Date Picker.
void	setManualValidation(boolean enabled)
void	setMax(LocalDate max)	Sets the maximum date in the date picker.
void	setMin(LocalDate min)	Sets the minimum date in the date picker.
void	setName(String name)	Sets the name of the DatePicker.
void	setOpened(boolean opened)	Sets the opened property of the datepicker to open or close its overlay.
void	setPlaceholder(String placeholder)	Sets the placeholder text that should be displayed in the input element, when the user has not entered a value.
void	setRequired(boolean required)	Sets whether the date picker is marked as input required.
void	setRequiredIndicatorVisible(boolean required)
void	setValue(LocalDate value)
void	setWeekNumbersVisible(boolean weekNumbersVisible)	Set the week number visible in the DatePicker.
protected void	validate()	Performs server-side validation of the current value.

Methods inherited from class com.vaadin.flow.component.AbstractSinglePropertyField

getSynchronizationRegistration, hasValidValue, setPresentationValue, setSynchronizedEvent

Methods inherited from class com.vaadin.flow.component.AbstractField

addValueChangeListener, getEmptyValue, getValue, isEmpty, setModelValue, valueEquals

Methods inherited from class com.vaadin.flow.component.Component

addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.BlurNotifier

addBlurListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.vaadin.flow.component.Focusable

addFocusShortcut, blur, focus, getTabIndex, setTabIndex

Methods inherited from interface com.vaadin.flow.component.FocusNotifier

addFocusListener

Methods inherited from interface com.vaadin.flow.component.shared.HasAllowedCharPattern

getAllowedCharPattern, setAllowedCharPattern

Methods inherited from interface com.vaadin.flow.component.shared.HasAutoOpen

isAutoOpen, setAutoOpen

Methods inherited from interface com.vaadin.flow.component.shared.HasClearButton

isClearButtonVisible, setClearButtonVisible

Methods inherited from interface com.vaadin.flow.component.shared.HasClientValidation

addClientValidatedEventListener

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.HasEnabled

isEnabled, setEnabled

Methods inherited from interface com.vaadin.flow.component.HasHelper

getHelperComponent, getHelperText, setHelperComponent, setHelperText

Methods inherited from interface com.vaadin.flow.component.shared.HasOverlayClassName

getOverlayClassName, setOverlayClassName

Methods inherited from interface com.vaadin.flow.component.shared.HasPrefix

getPrefixComponent, setPrefixComponent

Methods inherited from interface com.vaadin.flow.component.HasSize

getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Methods inherited from interface com.vaadin.flow.component.HasTheme

addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

Methods inherited from interface com.vaadin.flow.component.shared.HasThemeVariant

addThemeVariants, removeThemeVariants

Methods inherited from interface com.vaadin.flow.component.shared.HasTooltip

getTooltip, setTooltipText

Methods inherited from interface com.vaadin.flow.component.shared.HasValidationProperties

getErrorMessage, isInvalid, setErrorMessage, setInvalid

Methods inherited from interface com.vaadin.flow.component.HasValue

addValueChangeListener, clear, getEmptyValue, getOptionalValue, getValue, isEmpty

Methods inherited from interface com.vaadin.flow.component.HasValueAndElement

isReadOnly, isRequiredIndicatorVisible, setReadOnly

Constructor Details

DatePicker

public DatePicker()

Default constructor.

DatePicker

public DatePicker(LocalDate initialDate)

Convenience constructor to create a date picker with a pre-selected date in current UI locale format.

Parameters:

initialDate - the pre-selected date in the picker

See Also:

• AbstractField.setValue(Object)

DatePicker

public DatePicker(String label)

Convenience constructor to create a date picker with a label.

Parameters:

label - the label describing the date picker

See Also:

• setLabel(String)

DatePicker

public DatePicker(String label,
 LocalDate initialDate)

Convenience constructor to create a date picker with a pre-selected date in current UI locale format and a label.

Parameters:

label - the label describing the date picker

initialDate - the pre-selected date in the picker

See Also:

• AbstractField.setValue(Object)
• setLabel(String)

DatePicker

public DatePicker(com.vaadin.flow.component.HasValue.ValueChangeListener<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<DatePicker,LocalDate>> listener)

Convenience constructor to create a date picker with a HasValue.ValueChangeListener.

Parameters:

listener - the listener to receive value change events

See Also:

• AbstractField.addValueChangeListener(HasValue.ValueChangeListener)

DatePicker

public DatePicker(String label,
 com.vaadin.flow.component.HasValue.ValueChangeListener<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<DatePicker,LocalDate>> listener)

Convenience constructor to create a date picker with a HasValue.ValueChangeListener and a label.

Parameters:

label - the label describing the date picker

listener - the listener to receive value change events

See Also:

• setLabel(String)
• AbstractField.addValueChangeListener(HasValue.ValueChangeListener)

DatePicker

public DatePicker(LocalDate initialDate,
 com.vaadin.flow.component.HasValue.ValueChangeListener<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<DatePicker,LocalDate>> listener)

Convenience constructor to create a date picker with a pre-selected date in current UI locale format and a HasValue.ValueChangeListener.

Parameters:

initialDate - the pre-selected date in the picker

listener - the listener to receive value change events

See Also:

• AbstractField.setValue(Object)
• AbstractField.addValueChangeListener(HasValue.ValueChangeListener)

DatePicker

public DatePicker(String label,
 LocalDate initialDate,
 com.vaadin.flow.component.HasValue.ValueChangeListener<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<DatePicker,LocalDate>> listener)

Convenience constructor to create a date picker with a pre-selected date in current UI locale format, a HasValue.ValueChangeListener and a label.

Parameters:

label - the label describing the date picker

initialDate - the pre-selected date in the picker

listener - the listener to receive value change events

See Also:

• setLabel(String)
• AbstractField.setValue(Object)
• AbstractField.addValueChangeListener(HasValue.ValueChangeListener)

DatePicker

public DatePicker(LocalDate initialDate,
 Locale locale)

Convenience Constructor to create a date picker with pre-selected date and locale setup.

Parameters:

initialDate - the pre-selected date in the picker

locale - the locale for the date picker

Method Details

setMin

public void setMin(LocalDate min)

Sets the minimum date in the date picker. Dates before that will be disabled in the popup.

Parameters:

min - the minimum date that is allowed to be selected, or null to remove any minimum constraints

getMin

public LocalDate getMin()

Gets the minimum date in the date picker. Dates before that will be disabled in the popup.

Returns:

the minimum date that is allowed to be selected, or null if there's no minimum

setMax

public void setMax(LocalDate max)

Sets the maximum date in the date picker. Dates after that will be disabled in the popup.

Parameters:

max - the maximum date that is allowed to be selected, or null to remove any maximum constraints

getMax

public LocalDate getMax()

Gets the maximum date in the date picker. Dates after that will be disabled in the popup.

Returns:

the maximum date that is allowed to be selected, or null if there's no maximum

setLocale

public void setLocale(Locale locale)

Set the Locale for the Date Picker. The displayed date will be matched to the format used in that locale.

NOTE:Supported formats are MM/DD/YYYY, DD/MM/YYYY and YYYY/MM/DD. Browser compatibility can be different based on the browser and mobile devices, you can check here for more details: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toLocaleDateString

When using custom date formats through setI18n(DatePickerI18n), setting a locale has no effect, and dates will always be parsed and displayed using the custom date format.

Parameters:

locale - the locale set to the date picker, cannot be null

getLocale

public Locale getLocale()

Gets the Locale for this date picker

Overrides:

getLocale in class com.vaadin.flow.component.Component

Returns:

the locale used for this picker

setAriaLabel

public void setAriaLabel(String ariaLabel)

Specified by:

setAriaLabel in interface com.vaadin.flow.component.HasAriaLabel

getAriaLabel

public Optional<String> getAriaLabel()

Specified by:

getAriaLabel in interface com.vaadin.flow.component.HasAriaLabel

setAriaLabelledBy

public void setAriaLabelledBy(String labelledBy)

Specified by:

setAriaLabelledBy in interface com.vaadin.flow.component.HasAriaLabel

getAriaLabelledBy

public Optional<String> getAriaLabelledBy()

Specified by:

getAriaLabelledBy in interface com.vaadin.flow.component.HasAriaLabel

onAttach

protected void onAttach(com.vaadin.flow.component.AttachEvent attachEvent)

Overrides:

onAttach in class com.vaadin.flow.component.Component

getI18n

public DatePicker.DatePickerI18n getI18n()

Gets the internationalization object previously set for this component.

Note: updating the object content that is gotten from this method will not update the lang on the component if not set back using setI18n(DatePickerI18n)

Returns:

the i18n object. It will be null, If the i18n properties weren't set.

setI18n

public void setI18n(DatePicker.DatePickerI18n i18n)

Sets the internationalization properties for this component.

Parameters:

i18n - the internationalized properties, not null

getDefaultValidator

public com.vaadin.flow.data.binder.Validator<LocalDate> getDefaultValidator()

Specified by:

getDefaultValidator in interface com.vaadin.flow.data.binder.HasValidator<LocalDate>

addValidationStatusChangeListener

public com.vaadin.flow.shared.Registration addValidationStatusChangeListener(com.vaadin.flow.data.binder.ValidationStatusChangeListener<LocalDate> listener)

Specified by:

addValidationStatusChangeListener in interface com.vaadin.flow.data.binder.HasValidator<LocalDate>

isInputValuePresent

@Synchronize(property="_hasInputValue",
             value="has-input-value-changed")
protected boolean isInputValuePresent()

Returns whether the input element has a value or not.

Returns:

true if the input element's value is populated, false otherwise

setValue

public void setValue(LocalDate value)

Specified by:

setValue in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<DatePicker,LocalDate>,LocalDate>

Overrides:

setValue in class com.vaadin.flow.component.AbstractField<DatePicker,LocalDate>

setLabel

public void setLabel(String label)

Sets the label for the datepicker.

Specified by:

setLabel in interface com.vaadin.flow.component.HasLabel

Parameters:

label - value for the label property in the datepicker

getLabel

public String getLabel()

Gets the label of the datepicker.

Specified by:

getLabel in interface com.vaadin.flow.component.HasLabel

Returns:

the label property of the datePicker

setPlaceholder

public void setPlaceholder(String placeholder)

Sets the placeholder text that should be displayed in the input element, when the user has not entered a value.

Parameters:

placeholder - the placeholder text

getPlaceholder

public String getPlaceholder()

The placeholder text that should be displayed in the input element, when the user has not entered a value.

Returns:

the placeholder property of the datepicker

setInitialPosition

public void setInitialPosition(LocalDate initialPosition)

Date which should be visible when there is no value selected.

The same date formats as for the value property are supported.

Parameters:

initialPosition - the LocalDate value to set

getInitialPosition

public LocalDate getInitialPosition()

Get the visible date when there is no value selected.

The same date formats as for the value property are supported.

This property is not synchronized automatically from the client side, so the returned value may not be the same as in client side.

Returns:

the initialPosition property from the datepicker

setRequired

public void setRequired(boolean required)

Sets whether the date picker is marked as input required.

Parameters:

required - the boolean value to set

setRequiredIndicatorVisible

public void setRequiredIndicatorVisible(boolean required)

Specified by:

setRequiredIndicatorVisible in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<DatePicker,LocalDate>,LocalDate>

Specified by:

setRequiredIndicatorVisible in interface com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<DatePicker,LocalDate>,LocalDate>

isRequired

public boolean isRequired()

Determines whether the datepicker is marked as input required.

This property is not synchronized automatically from the client side, so the returned value may not be the same as in client side.

Returns:

true if the input is required, false otherwise

setWeekNumbersVisible

public void setWeekNumbersVisible(boolean weekNumbersVisible)

Set the week number visible in the DatePicker.

Set true to display ISO-8601 week numbers in the calendar.

Notice that displaying week numbers is only supported when i18n.firstDayOfWeek is 1 (Monday).

Parameters:

weekNumbersVisible - the boolean value to set

isWeekNumbersVisible

public boolean isWeekNumbersVisible()

Get the state of showWeekNumbers property of the datepicker

This property is not synchronized automatically from the client side, so the returned value may not be the same as in client side.

Returns:

the showWeekNumbers property from the datepicker

setOpened

public void setOpened(boolean opened)

Sets the opened property of the datepicker to open or close its overlay.

Parameters:

opened - true to open the datepicker overlay, false to close it

open

public void open()

Opens the datepicker overlay.

close

protected void close()

Closes the datepicker overlay.

isOpened

@Synchronize(property="opened",
             value="opened-changed")
public boolean isOpened()

Gets the states of the drop-down for the datepicker

This property is synchronized automatically from client side when an opened-changed event happens.

Returns:

true if the drop-down is opened, false otherwise

setName

public void setName(String name)

Sets the name of the DatePicker.

Parameters:

name - the string value to set

getName

public String getName()

Gets the name of the DatePicker.

Returns:

the name property from the DatePicker

setManualValidation

public void setManualValidation(boolean enabled)

Specified by:

setManualValidation in interface com.vaadin.flow.component.HasValidation

validate

protected void validate()

Performs server-side validation of the current value. This is needed because it is possible to circumvent the client-side validation constraints using browser development tools.

addOpenedChangeListener

public com.vaadin.flow.shared.Registration addOpenedChangeListener(com.vaadin.flow.component.ComponentEventListener<DatePicker.OpenedChangeEvent> listener)

Adds a listener for opened-changed events fired by the webcomponent.

Parameters:

listener - the listener

Returns:

a Registration for removing the event listener

addInvalidChangeListener

public com.vaadin.flow.shared.Registration addInvalidChangeListener(com.vaadin.flow.component.ComponentEventListener<DatePicker.InvalidChangeEvent> listener)

Adds a listener for invalid-changed events fired by the webcomponent.

Parameters:

listener - the listener

Returns:

a Registration for removing the event listener