Package com.gluonhq.charm.glisten.control

Class DatePicker

java.lang.Object

com.gluonhq.charm.glisten.control.Dialog<java.time.LocalDate>

com.gluonhq.charm.glisten.control.DatePicker

public class DatePicker
extends Dialog<java.time.LocalDate>

DatePicker is a dialog that displays a custom control that allows the selection of a LocalDate based on the selection of a given day and month in the initial monthly view, and a given year in a yearly view.

Based on Material Design guidelines, views can be switched by clicking in the labels that define the year, the day and month. Inside each view, months can be navigated by swipe gestures from left to right or right to left, as well as by dragging them to the left or to the right. Years can be navigated by scrolling vertically

The final selected local date will be available in the Dialog result property. Dialog.showAndWait() method will return an Optional instance with this result.

Here is a typical implementation:

 
 DatePicker datePicker = new DatePicker();
 datePicker.showAndWait().ifPresent(System.out::println);
 

Selected local date can be also accessed through the dateProperty() .

Since:

2.0.0

See Also:

TimePicker, Dialog

Property Summary

Properties

Type	Property	Description
javafx.beans.property.ObjectProperty<java.time.LocalDate>	date	The ObjectProperty with the selected LocalDate

Properties inherited from class com.gluonhq.charm.glisten.control.Dialog

autoHide, content, contentText, graphic, id, onCloseRequest, onHidden, onHiding, onShowing, onShown, showing, title, titleText

Field Summary

Fields inherited from class com.gluonhq.charm.glisten.control.Dialog

rootNode

Constructor Summary

Constructors

Constructor	Description
DatePicker()	Creates a new dialog, where the initial selected local date is the current one from the system clock in the default time-zone
DatePicker(java.time.LocalDate date)	Creates a new dialog using given local date

Method Summary

Modifier and Type	Method	Description
javafx.beans.property.ObjectProperty<java.time.LocalDate>	dateProperty()	The ObjectProperty with the selected LocalDate
java.time.LocalDate	getDate()	Returns the selected LocalDate
void	setDate(java.time.LocalDate value)	Sets the LocalDate

Methods inherited from class com.gluonhq.charm.glisten.control.Dialog

autoHideProperty, buildEventDispatchChain, contentProperty, contentTextProperty, getButtons, getContent, getContentText, getGraphic, getId, getOnCloseRequest, getOnHidden, getOnHiding, getOnShowing, getOnShown, getTitle, getTitleText, graphicProperty, hide, idProperty, isAutoHide, isFullscreen, isShowing, onCloseRequestProperty, onHiddenProperty, onHidingProperty, onShowingProperty, onShownProperty, setAutoHide, setContent, setContentText, setGraphic, setId, setOnCloseRequest, setOnHidden, setOnHiding, setOnShowing, setOnShown, setResult, setTitle, setTitleText, showAndWait, showingProperty, titleProperty, titleTextProperty

Methods inherited from class java.lang.Object

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

Property Detail

date

public final javafx.beans.property.ObjectProperty<java.time.LocalDate> dateProperty

The ObjectProperty with the selected LocalDate

See Also:

getDate(), setDate(LocalDate)

Constructor Detail

DatePicker

public DatePicker()

Creates a new dialog, where the initial selected local date is the current one from the system clock in the default time-zone

DatePicker

public DatePicker(java.time.LocalDate date)

Creates a new dialog using given local date

Parameters:

date - the initial local date

Method Detail

dateProperty

public final javafx.beans.property.ObjectProperty<java.time.LocalDate> dateProperty()

The ObjectProperty with the selected LocalDate

See Also:

getDate(), setDate(LocalDate)

getDate

public final java.time.LocalDate getDate()

Returns the selected LocalDate

Returns:

The selected LocalDate

setDate

public final void setDate(java.time.LocalDate value)

Sets the LocalDate

Parameters:

value - The LocalDate to be set as selected date