org.vaadin.miki.superfields.dates

Class SuperDatePicker

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<com.vaadin.flow.component.datepicker.DatePicker,LocalDate>

com.vaadin.flow.component.datepicker.DatePicker

org.vaadin.miki.superfields.dates.SuperDatePicker

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<com.vaadin.flow.component.datepicker.DatePicker>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<com.vaadin.flow.component.datepicker.DatePicker>, com.vaadin.flow.component.FocusNotifier<com.vaadin.flow.component.datepicker.DatePicker>, 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.HasValidation, com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.datepicker.DatePicker,LocalDate>,LocalDate>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.datepicker.DatePicker,LocalDate>,LocalDate>, com.vaadin.flow.component.shared.HasClientValidation, com.vaadin.flow.data.binder.HasValidator<LocalDate>, Serializable, TextSelectionNotifier<SuperDatePicker>, CanReceiveSelectionEventsFromClient, CanSelectText, HasDatePattern, HasHelperPositionable, HasId, HasLabelPositionable, HasLocale, HasPlaceholder, HasRequired, HasTooltip, WithDatePatternMixin<SuperDatePicker>, WithHelperMixin<SuperDatePicker>, WithHelperPositionableMixin<SuperDatePicker>, WithIdMixin<SuperDatePicker>, WithLabelMixin<SuperDatePicker>, WithLabelPositionableMixin<SuperDatePicker>, WithLocaleMixin<SuperDatePicker>, WithPlaceholderMixin<SuperDatePicker>, WithReceivingSelectionEventsFromClientMixin<SuperDatePicker>, WithRequiredMixin<SuperDatePicker>, WithTooltipMixin<SuperDatePicker>, WithValueMixin<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.datepicker.DatePicker,LocalDate>,LocalDate,SuperDatePicker>

@JsModule(value="./super-date-picker.js")
 @Tag(value="super-date-picker")
 @CssImport(value="./styles/label-positions.css",
           themeFor="vaadin-date-picker-text-field")
public class SuperDatePicker
extends com.vaadin.flow.component.datepicker.DatePicker
implements CanSelectText, CanReceiveSelectionEventsFromClient, WithReceivingSelectionEventsFromClientMixin<SuperDatePicker>, TextSelectionNotifier<SuperDatePicker>, WithLabelPositionableMixin<SuperDatePicker>, WithLocaleMixin<SuperDatePicker>, WithLabelMixin<SuperDatePicker>, WithPlaceholderMixin<SuperDatePicker>, WithDatePatternMixin<SuperDatePicker>, WithValueMixin<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.datepicker.DatePicker,LocalDate>,LocalDate,SuperDatePicker>, WithIdMixin<SuperDatePicker>, WithHelperMixin<SuperDatePicker>, WithHelperPositionableMixin<SuperDatePicker>, WithRequiredMixin<SuperDatePicker>, WithTooltipMixin<SuperDatePicker>

An extension of DatePicker that handles I18N also on the client side.

Since:

2020-04-09

Author:

miki

See Also:

Serialized Form

Nested Class Summary

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

com.vaadin.flow.component.datepicker.DatePicker.DatePickerI18n

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

com.vaadin.flow.component.datepicker.GeneratedVaadinDatePicker.ChangeEvent<R extends com.vaadin.flow.component.datepicker.GeneratedVaadinDatePicker<R,?>>, com.vaadin.flow.component.datepicker.GeneratedVaadinDatePicker.InvalidChangeEvent<R extends com.vaadin.flow.component.datepicker.GeneratedVaadinDatePicker<R,?>>, com.vaadin.flow.component.datepicker.GeneratedVaadinDatePicker.OpenedChangeEvent<R extends com.vaadin.flow.component.datepicker.GeneratedVaadinDatePicker<R,?>>

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>

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

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

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

com.vaadin.flow.component.shared.HasClientValidation.ClientValidatedEvent

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>

Field Summary

Fields inherited from interface org.vaadin.miki.markers.HasLabelPositionable

LABEL_POSITION_ATTRIBUTE, LABEL_POSITION_DETAILS_ATTRIBUTE

Fields inherited from interface org.vaadin.miki.markers.HasHelperPositionable

HELPER_ABOVE_THEME_VARIANT

Constructor Summary

Constructors

Constructor and Description
SuperDatePicker()
SuperDatePicker(com.vaadin.flow.component.HasValue.ValueChangeListener<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.datepicker.DatePicker,LocalDate>> listener)
SuperDatePicker(LocalDate initialDate)
SuperDatePicker(LocalDate initialDate, com.vaadin.flow.component.HasValue.ValueChangeListener<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.datepicker.DatePicker,LocalDate>> listener)
SuperDatePicker(LocalDate initialDate, Locale locale)
SuperDatePicker(Locale locale)
SuperDatePicker(String label)
SuperDatePicker(String label, com.vaadin.flow.component.HasValue.ValueChangeListener<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.datepicker.DatePicker,LocalDate>> listener)
SuperDatePicker(String label, LocalDate initialDate)
SuperDatePicker(String label, LocalDate initialDate, com.vaadin.flow.component.HasValue.ValueChangeListener<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.datepicker.DatePicker,LocalDate>> listener)

Method Summary

Modifier and Type	Method and Description
com.vaadin.flow.shared.Registration	addTextSelectionListener(TextSelectionListener<SuperDatePicker> listener) Adds the listener.
DatePattern	getDatePattern() Returns current date pattern.
String	getFormattedValue() Returns the current value formatted with current locale or pattern.
SuperDatePickerI18n	getSuperDatePickerI18n() Returns the current instance of the SuperDatePickerI18n associated with this object.
String	getTooltipText()
boolean	isReceivingSelectionEventsFromClient() Check if client will inform server on selection change.
protected void	onAttach(com.vaadin.flow.component.AttachEvent attachEvent)
protected void	onDetach(com.vaadin.flow.component.DetachEvent detachEvent)
void	select(int from, int to) Selects text starting from index from (inclusive) and ending at index to (exclusive).
void	selectAll() Selects entire text in the component.
void	selectNone() Removes the current selection and selects no text.
void	setDatePattern(DatePattern datePattern) Sets new date pattern to use when displaying and parsing dates.
void	setI18n(com.vaadin.flow.component.datepicker.DatePicker.DatePickerI18n i18n)
void	setLabelPosition(LabelPosition position) Sets the label position to a new one.
void	setLocale(Locale locale) Sets new locale for this object.
void	setReceivingSelectionEventsFromClient(boolean receivingSelectionEventsFromClient) Configures sending events by the client-side component.
void	setTooltipText(String title)

Methods inherited from class com.vaadin.flow.component.datepicker.DatePicker

addInvalidChangeListener, addOpenedChangeListener, addValidationStatusChangeListener, close, getDefaultValidator, getErrorMessage, getI18n, getInitialPosition, getLabel, getLocale, getMax, getMin, getName, getPlaceholder, isAutoOpen, isClearButtonVisible, isEnforcedFieldValidationEnabled, isInvalid, isOpened, isRequired, isWeekNumbersVisible, open, setAutoOpen, setClearButtonVisible, setErrorMessage, setInitialPosition, setInvalid, setLabel, setMax, setMin, setName, setOpened, setPlaceholder, setRequired, setRequiredIndicatorVisible, setValue, setWeekNumbersVisible, validate

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, 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, 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 org.vaadin.miki.markers.WithReceivingSelectionEventsFromClientMixin

withoutReceivingSelectionEventsFromClient, withReceivingSelectionEventsFromClient, withReceivingSelectionEventsFromClient

Methods inherited from interface org.vaadin.miki.markers.WithLabelPositionableMixin

withLabelPosition

Methods inherited from interface org.vaadin.miki.markers.HasLabelPositionable

getLabelPosition

Methods inherited from interface org.vaadin.miki.markers.WithLocaleMixin

withLocale

Methods inherited from interface org.vaadin.miki.markers.HasLocale

getLocale

Methods inherited from interface org.vaadin.miki.markers.WithLabelMixin

withLabel

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

getLabel, setLabel

Methods inherited from interface org.vaadin.miki.markers.WithPlaceholderMixin

withPlaceholder

Methods inherited from interface org.vaadin.miki.markers.HasPlaceholder

getPlaceholder, setPlaceholder

Methods inherited from interface org.vaadin.miki.markers.WithDatePatternMixin

withDatePattern

Methods inherited from interface org.vaadin.miki.markers.WithValueMixin

withValue

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

addValueChangeListener, clear, getEmptyValue, getOptionalValue, getValue, isEmpty, isReadOnly, isRequiredIndicatorVisible, setReadOnly, setRequiredIndicatorVisible, setValue

Methods inherited from interface org.vaadin.miki.markers.WithIdMixin

withId

Methods inherited from interface org.vaadin.miki.markers.HasId

getId, setId

Methods inherited from interface org.vaadin.miki.markers.WithHelperMixin

withHelperComponent, withHelperText

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

getHelperComponent, getHelperText, setHelperComponent, setHelperText

Methods inherited from interface org.vaadin.miki.markers.WithHelperPositionableMixin

withHelperAbove, withHelperAbove, withHelperBelow

Methods inherited from interface org.vaadin.miki.markers.HasHelperPositionable

isHelperAbove, setHelperAbove, setHelperAbove, setHelperBelow

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

getElement

Methods inherited from interface org.vaadin.miki.markers.WithRequiredMixin

withoutRequired, withRequired, withRequired

Methods inherited from interface org.vaadin.miki.markers.HasRequired

isRequired, setRequired

Methods inherited from interface org.vaadin.miki.markers.WithTooltipMixin

withTooltipText

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.shared.HasClientValidation

addClientValidatedEventListener

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

addAttachListener

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

addDetachListener

Constructor Detail

SuperDatePicker

public SuperDatePicker()

SuperDatePicker

public SuperDatePicker(Locale locale)

SuperDatePicker

public SuperDatePicker(LocalDate initialDate)

SuperDatePicker

public SuperDatePicker(String label)

SuperDatePicker

public SuperDatePicker(String label,
                       LocalDate initialDate)

SuperDatePicker

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

SuperDatePicker

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

SuperDatePicker

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

SuperDatePicker

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

SuperDatePicker

public SuperDatePicker(LocalDate initialDate,
                       Locale locale)

Method Detail

setLocale

public final void setLocale(Locale locale)

Description copied from interface: HasLocale

Sets new locale for this object.

Specified by:

setLocale in interface HasLocale

Overrides:

setLocale in class com.vaadin.flow.component.datepicker.DatePicker

Parameters:

locale - Locale to use. Should not be null.

setDatePattern

public void setDatePattern(DatePattern datePattern)

Description copied from interface: HasDatePattern

Sets new date pattern to use when displaying and parsing dates. It may reset the value currently displayed in the component.

Specified by:

setDatePattern in interface HasDatePattern

Parameters:

datePattern - A pattern to use. Can be null, which will reset the pattern to whatever is supported by default.

getDatePattern

public DatePattern getDatePattern()

Description copied from interface: HasDatePattern

Returns current date pattern.

Specified by:

getDatePattern in interface HasDatePattern

Returns:

A DatePattern. May be null.

onAttach

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

Overrides:

onAttach in class com.vaadin.flow.component.datepicker.DatePicker

onDetach

protected void onDetach(com.vaadin.flow.component.DetachEvent detachEvent)

Overrides:

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

isReceivingSelectionEventsFromClient

public boolean isReceivingSelectionEventsFromClient()

Description copied from interface: CanReceiveSelectionEventsFromClient

Check if client will inform server on selection change. Note: this feature is by default turned off.

Specified by:

isReceivingSelectionEventsFromClient in interface CanReceiveSelectionEventsFromClient

Returns:

When true, each selection change in the client-side component will result in this component broadcasting a TextSelectionEvent.

setReceivingSelectionEventsFromClient

public void setReceivingSelectionEventsFromClient(boolean receivingSelectionEventsFromClient)

Description copied from interface: CanReceiveSelectionEventsFromClient

Configures sending events by the client-side component. Note: this feature is by default turned off.

Specified by:

setReceivingSelectionEventsFromClient in interface CanReceiveSelectionEventsFromClient

Parameters:

receivingSelectionEventsFromClient - When false, selecting text in client-side component will not send an event to server-side component. When true, it will.

getFormattedValue

public String getFormattedValue()

Returns the current value formatted with current locale or pattern.

Returns:

Current date, formatted. Will return null if the current date is null.

selectAll

public void selectAll()

Description copied from interface: CanSelectText

Selects entire text in the component.

Specified by:

selectAll in interface CanSelectText

selectNone

public void selectNone()

Description copied from interface: CanSelectText

Removes the current selection and selects no text.

Specified by:

selectNone in interface CanSelectText

select

public void select(int from,
                   int to)

Description copied from interface: CanSelectText

Selects text starting from index from (inclusive) and ending at index to (exclusive).

Specified by:

select in interface CanSelectText

Parameters:

from - Starting index (inclusive).

to - Ending index (exclusive).

addTextSelectionListener

public com.vaadin.flow.shared.Registration addTextSelectionListener(TextSelectionListener<SuperDatePicker> listener)

Description copied from interface: TextSelectionNotifier

Adds the listener.

Specified by:

addTextSelectionListener in interface TextSelectionNotifier<SuperDatePicker>

Parameters:

listener - A listener to add.

Returns:

A Registration that can be used to stop listening to the event.

getSuperDatePickerI18n

public SuperDatePickerI18n getSuperDatePickerI18n()

Returns the current instance of the SuperDatePickerI18n associated with this object.

Returns:

A non-null instance.

setI18n

public void setI18n(com.vaadin.flow.component.datepicker.DatePicker.DatePickerI18n i18n)

Overrides:

setI18n in class com.vaadin.flow.component.datepicker.DatePicker

setTooltipText

public void setTooltipText(String title)

Specified by:

setTooltipText in interface HasTooltip

getTooltipText

public String getTooltipText()

Specified by:

getTooltipText in interface HasTooltip

setLabelPosition

public void setLabelPosition(LabelPosition position)

Description copied from interface: HasLabelPositionable

Sets the label position to a new one.

Specified by:

setLabelPosition in interface HasLabelPositionable

Parameters:

position - A position to use. Setting null will reset it to the default setting.