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<R,T>

com.vaadin.flow.component.datepicker.GeneratedVaadinDatePicker<DatePicker,LocalDate>

com.vaadin.flow.component.datepicker.DatePicker

All Implemented Interfaces:

AttachNotifier, BlurNotifier<DatePicker>, DetachNotifier, Focusable<DatePicker>, FocusNotifier<DatePicker>, HasElement, HasEnabled, HasHelper, HasLabel, HasSize, HasStyle, HasValidation, HasValue<AbstractField.ComponentValueChangeEvent<DatePicker,LocalDate>,LocalDate>, HasValueAndElement<AbstractField.ComponentValueChangeEvent<DatePicker,LocalDate>,LocalDate>, Serializable

@JsModule(value="./date-picker-datefns.js") @JsModule(value="./datepickerConnector.js")
 @JavaScript(value="frontend://date-picker-datefns.js") @JavaScript(value="frontend://datepickerConnector.js")
public class DatePicker
extends GeneratedVaadinDatePicker<DatePicker,LocalDate>
implements HasSize, HasValidation, HasHelper, HasLabel

Server-side component that encapsulates the functionality of the vaadin-date-picker webcomponent.

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DatePicker.DatePickerI18n The internationalization properties for DatePicker.

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

GeneratedVaadinDatePicker.ChangeEvent<R extends GeneratedVaadinDatePicker<R,?>>, GeneratedVaadinDatePicker.InvalidChangeEvent<R extends GeneratedVaadinDatePicker<R,?>>, GeneratedVaadinDatePicker.OpenedChangeEvent<R extends GeneratedVaadinDatePicker<R,?>>

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

AbstractField.ComponentValueChangeEvent<C extends Component,V>

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

BlurNotifier.BlurEvent<C extends Component>

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

FocusNotifier.FocusEvent<C extends Component>

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

HasValue.ValueChangeEvent<V>, HasValue.ValueChangeListener<E extends HasValue.ValueChangeEvent<?>>

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Registration	addInvalidChangeListener(ComponentEventListener<GeneratedVaadinDatePicker.InvalidChangeEvent<DatePicker>> listener) Adds a listener for invalid-changed events fired by the webcomponent.
Registration	addOpenedChangeListener(ComponentEventListener<GeneratedVaadinDatePicker.OpenedChangeEvent<DatePicker>> listener) Adds a listener for opened-changed events fired by the webcomponent.
protected void	close() Closes the datepicker overlay.
String	getErrorMessage() Gets the current error message from the datepicker.
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() Gets the placeholder of the datepicker.
boolean	isAutoOpen() When auto open is enabled, the dropdown will open when the field is clicked.
boolean	isClearButtonVisible() Gets whether this datepicker displays a clear button when it has value.
boolean	isInvalid() Gets the validity of the datepicker output.
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(AttachEvent attachEvent) Called when the component is attached to a UI.
void	open() Opens the datepicker overlay.
void	setAutoOpen(boolean autoOpen) When auto open is enabled, the dropdown will open when the field is clicked.
void	setClearButtonVisible(boolean clearButtonVisible) Sets displaying a clear button in the datepicker when it has value.
void	setErrorMessage(String errorMessage) Description copied from corresponding location in WebComponent:
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	setInvalid(boolean invalid) Description copied from corresponding location in WebComponent:
void	setLabel(String label) Sets the label for the datepicker.
void	setLocale(Locale locale) Set the Locale for the Date Picker.
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) Description copied from corresponding location in WebComponent:
void	setOpened(boolean opened) Sets the opened property of the datepicker to open or close its overlay.
void	setPlaceholder(String placeholder) Description copied from corresponding location in WebComponent:
void	setRequired(boolean required) Description copied from corresponding location in WebComponent:
void	setRequiredIndicatorVisible(boolean required) Sets the required indicator visible or not.
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.datepicker.GeneratedVaadinDatePicker

addChangeListener, addToPrefix, checkValidity, getErrorMessageString, getI18nJsonObject, getInitialPositionString, getLabelString, getMaxAsStringString, getMinAsStringString, getNameString, getPlaceholderString, isAutofocusBoolean, isClearButtonVisibleBoolean, isDisabledBoolean, isInvalidBoolean, isOpenedBoolean, isReadonlyBoolean, isRequiredBoolean, isShowWeekNumbersBoolean, remove, removeAll, setAutofocus, setDisabled, setI18n, setInitialPosition, setMaxAsString, setMinAsString, setReadonly, setShowWeekNumbers, validate

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, setValue, valueEquals

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

addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onDetach, onEnabledStateChanged, 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.HasSize

getCssSize, 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.HasHelper

getHelperComponent, getHelperText, setHelperComponent, setHelperText

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

getElement

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

addFocusShortcut, blur, focus, getTabIndex, setTabIndex

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

addBlurListener

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

addFocusListener

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

isEnabled, setEnabled

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

isReadOnly, isRequiredIndicatorVisible, setReadOnly

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

clear, getOptionalValue

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

addAttachListener

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

addDetachListener

Constructor Detail

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(HasValue.ValueChangeListener<AbstractField.ComponentValueChangeEvent<DatePicker,LocalDate>> listener)

Convenience constructor to create a date picker with a ValueChangeListener.

Parameters:

listener - the listener to receive value change events

See Also:

AbstractField.addValueChangeListener(HasValue.ValueChangeListener)

DatePicker

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

Convenience constructor to create a date picker with a 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,
                  HasValue.ValueChangeListener<AbstractField.ComponentValueChangeEvent<DatePicker,LocalDate>> listener)

Convenience constructor to create a date picker with a pre-selected date in current UI locale format and a 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,
                  HasValue.ValueChangeListener<AbstractField.ComponentValueChangeEvent<DatePicker,LocalDate>> listener)

Convenience constructor to create a date picker with a pre-selected date in current UI locale format, a 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 Detail

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 Component

Returns:

the locale used for this picker

onAttach

protected void onAttach(AttachEvent attachEvent)

Description copied from class: Component

Called when the component is attached to a UI.

The default implementation does nothing.

This method is invoked before the AttachEvent is fired for the component.

Overrides:

onAttach in class Component

Parameters:

attachEvent - the attach event

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

setErrorMessage

public void setErrorMessage(String errorMessage)

Description copied from class: GeneratedVaadinDatePicker

Description copied from corresponding location in WebComponent:

The error message to display when the input is invalid.

Specified by:

setErrorMessage in interface HasValidation

Overrides:

setErrorMessage in class GeneratedVaadinDatePicker<DatePicker,LocalDate>

Parameters:

errorMessage - the String value to set

getErrorMessage

public String getErrorMessage()

Gets the current error message from the datepicker.

Specified by:

getErrorMessage in interface HasValidation

Returns:

the current error message

setInvalid

public void setInvalid(boolean invalid)

Description copied from class: GeneratedVaadinDatePicker

Description copied from corresponding location in WebComponent:

This property is set to true when the control value invalid.

Specified by:

setInvalid in interface HasValidation

Overrides:

setInvalid in class GeneratedVaadinDatePicker<DatePicker,LocalDate>

Parameters:

invalid - the boolean value to set

isInvalid

public boolean isInvalid()

Gets the validity of the datepicker output.

return true, if the value is invalid.

Specified by:

isInvalid in interface HasValidation

Returns:

the validity property from the datepicker

setClearButtonVisible

public void setClearButtonVisible(boolean clearButtonVisible)

Sets displaying a clear button in the datepicker when it has value.

The clear button is an icon, which can be clicked to set the datepicker value to null.

Overrides:

setClearButtonVisible in class GeneratedVaadinDatePicker<DatePicker,LocalDate>

Parameters:

clearButtonVisible - true to display the clear button, false to hide it

isClearButtonVisible

public boolean isClearButtonVisible()

Gets whether this datepicker displays a clear button when it has value.

Returns:

true if this datepicker displays a clear button, false otherwise

See Also:

setClearButtonVisible(boolean)

setLabel

public void setLabel(String label)

Sets the label for the datepicker.

Specified by:

setLabel in interface HasLabel

Overrides:

setLabel in class GeneratedVaadinDatePicker<DatePicker,LocalDate>

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 HasLabel

Returns:

the label property of the datePicker

setPlaceholder

public void setPlaceholder(String placeholder)

Description copied from class: GeneratedVaadinDatePicker

Description copied from corresponding location in WebComponent:

A placeholder string in addition to the label. If this is set, the label will always float.

Overrides:

setPlaceholder in class GeneratedVaadinDatePicker<DatePicker,LocalDate>

Parameters:

placeholder - the String value to set

getPlaceholder

public String getPlaceholder()

Gets the placeholder 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 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)

Description copied from class: GeneratedVaadinDatePicker

Description copied from corresponding location in WebComponent:

Set to true to mark the input as required.

Overrides:

setRequired in class GeneratedVaadinDatePicker<DatePicker,LocalDate>

Parameters:

required - the boolean value to set

setRequiredIndicatorVisible

public void setRequiredIndicatorVisible(boolean required)

Description copied from interface: HasValue

Sets the required indicator visible or not.

If set visible, it is visually indicated in the user interface.

The method is intended to be used with Binder which does server-side validation. In case HTML element has its own (client-side) validation it should be disabled when setRequiredIndicatorVisible(true) is called and re-enabled back on setRequiredIndicatorVisible(false). It's responsibility of each component implementation to follow the contract so that the method call doesn't do anything else than show/hide the "required" indication. Usually components provide their own setRequired method which should be called in case the client-side validation is required.

Specified by:

setRequiredIndicatorVisible in interface HasValue<AbstractField.ComponentValueChangeEvent<DatePicker,LocalDate>,LocalDate>

Specified by:

setRequiredIndicatorVisible in interface HasValueAndElement<AbstractField.ComponentValueChangeEvent<DatePicker,LocalDate>,LocalDate>

Parameters:

required - true to make the required indicator visible, false if not

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.

Overrides:

setOpened in class GeneratedVaadinDatePicker<DatePicker,LocalDate>

Parameters:

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

open

public void open()

Opens the datepicker overlay.

Overrides:

open in class GeneratedVaadinDatePicker<DatePicker,LocalDate>

close

protected void close()

Closes the datepicker overlay.

Overrides:

close in class GeneratedVaadinDatePicker<DatePicker,LocalDate>

isOpened

public boolean isOpened()

Gets the states of the drop-down for the datepicker

Returns:

true if the drop-down is opened, false otherwise

setName

public void setName(String name)

Description copied from class: GeneratedVaadinDatePicker

Description copied from corresponding location in WebComponent:

The name of this element.

Overrides:

setName in class GeneratedVaadinDatePicker<DatePicker,LocalDate>

Parameters:

name - the String value to set

getName

public String getName()

Gets the name of the DatePicker.

Returns:

the name property from the DatePicker

setAutoOpen

public void setAutoOpen(boolean autoOpen)

When auto open is enabled, the dropdown will open when the field is clicked.

Parameters:

autoOpen - Value for the auto open property,

isAutoOpen

public boolean isAutoOpen()

When auto open is enabled, the dropdown will open when the field is clicked.

Returns:

true if auto open is enabled. false otherwise. Default is true

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 Registration addOpenedChangeListener(ComponentEventListener<GeneratedVaadinDatePicker.OpenedChangeEvent<DatePicker>> listener)

Description copied from class: GeneratedVaadinDatePicker

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

Overrides:

addOpenedChangeListener in class GeneratedVaadinDatePicker<DatePicker,LocalDate>

Parameters:

listener - the listener

Returns:

a Registration for removing the event listener

addInvalidChangeListener

public Registration addInvalidChangeListener(ComponentEventListener<GeneratedVaadinDatePicker.InvalidChangeEvent<DatePicker>> listener)

Description copied from class: GeneratedVaadinDatePicker

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

Overrides:

addInvalidChangeListener in class GeneratedVaadinDatePicker<DatePicker,LocalDate>

Parameters:

listener - the listener

Returns:

a Registration for removing the event listener