Package software.xdev.vaadin.daterange_picker.ui

Class DateRangePicker<D extends DateRange>

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.Composite<com.vaadin.flow.component.orderedlayout.VerticalLayout>

software.xdev.vaadin.daterange_picker.ui.DateRangePicker<D>

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasComponents, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasOrderedComponents, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasValue<DateRangeValueChangeEvent<D>,DateRangeModel<D>>, com.vaadin.flow.component.orderedlayout.FlexComponent, com.vaadin.flow.data.binder.HasItems<D>, Serializable, DateRangeActions<D,DateRangePicker<D>>

@CssImport("./styles/dateRangePicker.css")
public class DateRangePicker<D extends DateRange>
extends com.vaadin.flow.component.Composite<com.vaadin.flow.component.orderedlayout.VerticalLayout>
implements com.vaadin.flow.component.orderedlayout.FlexComponent, com.vaadin.flow.data.binder.HasItems<D>, DateRangeActions<D,DateRangePicker<D>>, com.vaadin.flow.component.HasValue<DateRangeValueChangeEvent<D>,DateRangeModel<D>>

Represents a Date-Range-Picker

See Also:

• Serialized Form

Nested Class Summary

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

com.vaadin.flow.component.orderedlayout.FlexComponent.Alignment, com.vaadin.flow.component.orderedlayout.FlexComponent.JustifyContentMode

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<?>>

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	allowRangeLimitExceeding
protected final com.vaadin.flow.component.button.Button	btnOverview
protected boolean	closeOnOutsideClick
protected Optional<com.vaadin.flow.component.datepicker.DatePicker.DatePickerI18n>	datePickerI18n
protected com.vaadin.flow.component.ItemLabelGenerator<D>	dateRangeLocalizerFunction
static final Locale	DEFAULT_LOCALE
protected boolean	expanded
protected Optional<Locale>	formatLocale
protected DateRangeModel<D>	model
protected static AtomicInteger	nextID
protected final DateRangePickerOverlay<D>	overlay
protected final com.vaadin.flow.component.html.Div	overlayContainer
protected boolean	useClientSideLocale

Constructor Summary

Constructors

Constructor	Description
DateRangePicker(Supplier<DateRangeModel<D>> initialModelSupplier)
DateRangePicker(Supplier<DateRangeModel<D>> initialModelSupplier, D[] items)
DateRangePicker(Supplier<DateRangeModel<D>> initialModelSupplier, Collection<D> items)
DateRangePicker(DateRangeModel<D> initialModel)
DateRangePicker(DateRangeModel<D> initialModel, D[] items)
DateRangePicker(DateRangeModel<D> initialModel, Collection<D> items)

Method Summary

Modifier and Type	Method	Description
protected void	addClickOutsideListener()
com.vaadin.flow.shared.Registration	addValueChangeListener(com.vaadin.flow.component.HasValue.ValueChangeListener<? super DateRangeValueChangeEvent<D>> listener)
void	clear()	Do not use this method, as it throws a UnsupportedOperationException The calling of clear is not supported because DateRangePicker always has a value Use setValue(DateRangeModel) instead.
protected void	clickOutsideOccurred()
com.vaadin.flow.component.button.Button	getBtnOverview()
Optional<com.vaadin.flow.component.datepicker.DatePicker.DatePickerI18n>	getDatePickerI18n()
D	getDateRange()
com.vaadin.flow.component.ItemLabelGenerator<D>	getDateRangeLocalizerFunction()
DateRangeModel<D>	getEmptyValue()	DateRangePicker always has a value However for compatibility reasons (with Vaadin) this returns null
LocalDate	getEnd()
Locale	getFormatLocale()
DateRangePickerOverlay<D>	getOverlay()
com.vaadin.flow.component.html.Div	getOverlayContainer()
LocalDate	getStart()
DateRangeModel<D>	getValue()
protected void	initUI()
boolean	isAllowRangeLimitExceeding()
boolean	isCloseOnOutsideClick()
boolean	isEmpty()	DateRangePicker always has a value Therefore this always returns false
boolean	isExpanded()
boolean	isReadOnly()
boolean	isRequiredIndicatorVisible()	The required indicator is not implemented This will always return false
protected void	onAttach(com.vaadin.flow.component.AttachEvent attachEvent)
protected void	registerListeners()
void	setAllowRangeLimitExceeding(boolean allowRangeLimitExceeding)	Allows the maximum start and end date to be greater or less than the configured end or start date.
DateRangePicker<D>	setDateRange(D dateRange)
void	setDateRangeForToday(D range)	Uses the given DateRange and calculates with the current Date the DateRangeModel, which is then set by setValue(DateRangeModel)
void	setDateRangeOptionsLabel(String label)	Sets the label for the overlay DateRange-ComboBox
DateRangePicker<D>	setEnd(LocalDate end)
void	setEndLabel(String label)	Sets the label for the overlay End-DatePicker
protected void	setExpanded(boolean expanded)
void	setItems(Collection<D> items)
protected void	setLocaleFromClient()
void	setReadOnly(boolean readOnly)
void	setRequiredIndicatorVisible(boolean requiredIndicatorVisible)	The required indicator is not implemented This method doesn't have any functionallity
DateRangePicker<D>	setStart(LocalDate start)
void	setStartLabel(String label)	Sets the label for the overlay Start-DatePicker
void	setValue(DateRangeModel<D> value)
protected void	toggle()
protected void	tryFixInvalidModel()
protected void	updateFromModel(boolean updateOverlay)
DateRangePicker<D>	withAllowRangeLimitExceeding(boolean allowRangeLimitExceeding)	Shortcut for setAllowRangeLimitExceeding(boolean)
DateRangePicker<D>	withCloseOnOutsideClick(boolean closeOnOutsideClick)
DateRangePicker<D>	withDatePickerI18n(com.vaadin.flow.component.datepicker.DatePicker.DatePickerI18n datePickerI18n)
DateRangePicker<D>	withDateRangeLocalizerFunction(com.vaadin.flow.component.ItemLabelGenerator<D> dateRangeLocalizerFunction)
DateRangePicker<D>	withDateRangeOptionsLabel(String label)	Shortcut for setDateRangeOptionsLabel(String)
DateRangePicker<D>	withEndLabel(String label)	Shortcut for setEndLabel(String)
DateRangePicker<D>	withFormatLocale(Locale locale)	Sets the locale used for formatting the "expand" button.
DateRangePicker<D>	withStartLabel(String label)	Shortcut for setStartLabel(String)

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

getChildren, getContent, getElement, initContent

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

addListener, findAncestor, fireEvent, from, get, getEventBus, getId, getListeners, getLocale, 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.DetachNotifier

addDetachListener

Methods inherited from interface com.vaadin.flow.component.orderedlayout.FlexComponent

expand, getAlignItems, getAlignSelf, getFlexGrow, getFlexShrink, getJustifyContentMode, replace, setAlignItems, setAlignSelf, setFlexGrow, setFlexShrink, setJustifyContentMode

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

add, add, add, addComponentAsFirst, addComponentAtIndex, remove, remove, removeAll

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.data.binder.HasItems

setItems, setItems

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

getChildren, getComponentAt, getComponentCount, indexOf

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

getOptionalValue

Field Details

DEFAULT_LOCALE

public static final Locale DEFAULT_LOCALE

nextID

protected static AtomicInteger nextID

expanded

protected boolean expanded

model

protected DateRangeModel<D extends DateRange> model

useClientSideLocale

protected boolean useClientSideLocale

formatLocale

protected Optional<Locale> formatLocale

dateRangeLocalizerFunction

protected com.vaadin.flow.component.ItemLabelGenerator<D extends DateRange> dateRangeLocalizerFunction

datePickerI18n

protected Optional<com.vaadin.flow.component.datepicker.DatePicker.DatePickerI18n> datePickerI18n

closeOnOutsideClick

protected boolean closeOnOutsideClick

allowRangeLimitExceeding

protected boolean allowRangeLimitExceeding

btnOverview

protected final com.vaadin.flow.component.button.Button btnOverview

overlayContainer

protected final com.vaadin.flow.component.html.Div overlayContainer

overlay

protected final DateRangePickerOverlay<D extends DateRange> overlay

Constructor Details

DateRangePicker

public DateRangePicker(DateRangeModel<D> initialModel)

DateRangePicker

public DateRangePicker(DateRangeModel<D> initialModel,
 D[] items)

DateRangePicker

public DateRangePicker(DateRangeModel<D> initialModel,
 Collection<D> items)

DateRangePicker

public DateRangePicker(Supplier<DateRangeModel<D>> initialModelSupplier)

DateRangePicker

public DateRangePicker(Supplier<DateRangeModel<D>> initialModelSupplier,
 D[] items)

DateRangePicker

public DateRangePicker(Supplier<DateRangeModel<D>> initialModelSupplier,
 Collection<D> items)

Method Details

withCloseOnOutsideClick

public DateRangePicker<D> withCloseOnOutsideClick(boolean closeOnOutsideClick)

isCloseOnOutsideClick

public boolean isCloseOnOutsideClick()

withDatePickerI18n

public DateRangePicker<D> withDatePickerI18n(com.vaadin.flow.component.datepicker.DatePicker.DatePickerI18n datePickerI18n)

getDatePickerI18n

public Optional<com.vaadin.flow.component.datepicker.DatePicker.DatePickerI18n> getDatePickerI18n()

withFormatLocale

public DateRangePicker<D> withFormatLocale(Locale locale)

Sets the locale used for formatting the "expand" button.

If the locale is null (default) the clientside locale will be used or Locale.US if none could be detected.

getFormatLocale

public Locale getFormatLocale()

withDateRangeLocalizerFunction

public DateRangePicker<D> withDateRangeLocalizerFunction(com.vaadin.flow.component.ItemLabelGenerator<D> dateRangeLocalizerFunction)

getDateRangeLocalizerFunction

public com.vaadin.flow.component.ItemLabelGenerator<D> getDateRangeLocalizerFunction()

withStartLabel

public DateRangePicker<D> withStartLabel(String label)

Shortcut for setStartLabel(String)

withEndLabel

public DateRangePicker<D> withEndLabel(String label)

Shortcut for setEndLabel(String)

withDateRangeOptionsLabel

public DateRangePicker<D> withDateRangeOptionsLabel(String label)

Shortcut for setDateRangeOptionsLabel(String)

withAllowRangeLimitExceeding

public DateRangePicker<D> withAllowRangeLimitExceeding(boolean allowRangeLimitExceeding)

Shortcut for setAllowRangeLimitExceeding(boolean)

initUI

protected void initUI()

registerListeners

protected void registerListeners()

onAttach

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

Overrides:

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

setLocaleFromClient

protected void setLocaleFromClient()

addClickOutsideListener

protected void addClickOutsideListener()

clickOutsideOccurred

@ClientCallable
protected void clickOutsideOccurred()

updateFromModel

protected void updateFromModel(boolean updateOverlay)

tryFixInvalidModel

protected void tryFixInvalidModel()

toggle

protected void toggle()

setExpanded

protected void setExpanded(boolean expanded)

isExpanded

public boolean isExpanded()

getOverlay

public DateRangePickerOverlay<D> getOverlay()

getBtnOverview

public com.vaadin.flow.component.button.Button getBtnOverview()

getOverlayContainer

public com.vaadin.flow.component.html.Div getOverlayContainer()

setStartLabel

public void setStartLabel(String label)

Sets the label for the overlay Start-DatePicker

setEndLabel

public void setEndLabel(String label)

Sets the label for the overlay End-DatePicker

setDateRangeOptionsLabel

public void setDateRangeOptionsLabel(String label)

Sets the label for the overlay DateRange-ComboBox

setAllowRangeLimitExceeding

public void setAllowRangeLimitExceeding(boolean allowRangeLimitExceeding)

Allows the maximum start and end date to be greater or less than the configured end or start date.

This is only the case when DateRange.isCalcable() is true. Otherwise incorrect values (e.g. start before end) could be set.

isAllowRangeLimitExceeding

public boolean isAllowRangeLimitExceeding()

setDateRangeForToday

public void setDateRangeForToday(D range)

Uses the given DateRange and calculates with the current Date the DateRangeModel, which is then set by setValue(DateRangeModel)

setItems

public void setItems(Collection<D> items)

Specified by:

setItems in interface com.vaadin.flow.data.binder.HasItems<D extends DateRange>

getStart

public LocalDate getStart()

Specified by:

getStart in interface DateRangeActions<D extends DateRange,DateRangePicker<D extends DateRange>>

setStart

public DateRangePicker<D> setStart(LocalDate start)

Specified by:

setStart in interface DateRangeActions<D extends DateRange,DateRangePicker<D extends DateRange>>

getEnd

public LocalDate getEnd()

Specified by:

getEnd in interface DateRangeActions<D extends DateRange,DateRangePicker<D extends DateRange>>

setEnd

public DateRangePicker<D> setEnd(LocalDate end)

Specified by:

setEnd in interface DateRangeActions<D extends DateRange,DateRangePicker<D extends DateRange>>

getDateRange

public D getDateRange()

Specified by:

getDateRange in interface DateRangeActions<D extends DateRange,DateRangePicker<D extends DateRange>>

setDateRange

public DateRangePicker<D> setDateRange(D dateRange)

Specified by:

setDateRange in interface DateRangeActions<D extends DateRange,DateRangePicker<D extends DateRange>>

setValue

public void setValue(DateRangeModel<D> value)

Specified by:

setValue in interface com.vaadin.flow.component.HasValue<DateRangeValueChangeEvent<D extends DateRange>,DateRangeModel<D extends DateRange>>

getValue

public DateRangeModel<D> getValue()

Specified by:

getValue in interface com.vaadin.flow.component.HasValue<DateRangeValueChangeEvent<D extends DateRange>,DateRangeModel<D extends DateRange>>

addValueChangeListener

public com.vaadin.flow.shared.Registration addValueChangeListener(com.vaadin.flow.component.HasValue.ValueChangeListener<? super DateRangeValueChangeEvent<D>> listener)

Specified by:

addValueChangeListener in interface com.vaadin.flow.component.HasValue<DateRangeValueChangeEvent<D extends DateRange>,DateRangeModel<D extends DateRange>>

getEmptyValue

public DateRangeModel<D> getEmptyValue()

DateRangePicker always has a value
However for compatibility reasons (with Vaadin) this returns null

Specified by:

getEmptyValue in interface com.vaadin.flow.component.HasValue<DateRangeValueChangeEvent<D extends DateRange>,DateRangeModel<D extends DateRange>>

Returns:

null

isEmpty

public boolean isEmpty()

DateRangePicker always has a value
Therefore this always returns false

Specified by:

isEmpty in interface com.vaadin.flow.component.HasValue<DateRangeValueChangeEvent<D extends DateRange>,DateRangeModel<D extends DateRange>>

Returns:

false

clear

public void clear()

Do not use this method, as it throws a UnsupportedOperationException
The calling of clear is not supported because DateRangePicker always has a value
Use setValue(DateRangeModel) instead.

Specified by:

clear in interface com.vaadin.flow.component.HasValue<DateRangeValueChangeEvent<D extends DateRange>,DateRangeModel<D extends DateRange>>

Throws:

UnsupportedOperationException - DateRangePicker always has a value

setReadOnly

public void setReadOnly(boolean readOnly)

Specified by:

setReadOnly in interface com.vaadin.flow.component.HasValue<DateRangeValueChangeEvent<D extends DateRange>,DateRangeModel<D extends DateRange>>

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface com.vaadin.flow.component.HasValue<DateRangeValueChangeEvent<D extends DateRange>,DateRangeModel<D extends DateRange>>

setRequiredIndicatorVisible

public void setRequiredIndicatorVisible(boolean requiredIndicatorVisible)

The required indicator is not implemented

This method doesn't have any functionallity

Specified by:

setRequiredIndicatorVisible in interface com.vaadin.flow.component.HasValue<DateRangeValueChangeEvent<D extends DateRange>,DateRangeModel<D extends DateRange>>

isRequiredIndicatorVisible

public boolean isRequiredIndicatorVisible()

The required indicator is not implemented
This will always return false

Specified by:

isRequiredIndicatorVisible in interface com.vaadin.flow.component.HasValue<DateRangeValueChangeEvent<D extends DateRange>,DateRangeModel<D extends DateRange>>

Returns:

false