Class CalendarView.SelectionModel

java.lang.Object

com.dlsc.gemsfx.CalendarView.SelectionModel

Enclosing class:

CalendarView

public static class CalendarView.SelectionModel
extends Object

Tracks selected dates for a CalendarView.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CalendarView.SelectionModel.SelectionMode	Defines how many dates can be selected.

Property Summary

Properties

Type	Property	Description
final javafx.beans.property.ObjectProperty<LocalDate>	selectedDate	The primary selected date.
final javafx.beans.property.ListProperty<LocalDate>	selectedDates	The selected dates used by multiple-date selection.
final javafx.beans.property.ObjectProperty<LocalDate>	selectedEndDate	The selected end date used by range selection.
final javafx.beans.property.ObjectProperty<CalendarView.SelectionModel.SelectionMode>	selectionMode	The current selection mode.

Constructor Summary

Constructors

Constructor	Description
SelectionModel()	Creates a new selection model.

Method Summary

Modifier and Type	Method	Description
void	clearAndSelect(LocalDate date)	Clears the current selection and selects the given date.
final void	clearSelection()	Clears all selected dates.
void	clearSelection(LocalDate date)	Clears or removes the given date according to the current selection mode.
final LocalDate	getSelectedDate()	Gets the value of the selectedDate property.
final javafx.collections.ObservableList<LocalDate>	getSelectedDates()	Gets the value of the selectedDates property.
final LocalDate	getSelectedEndDate()	Gets the value of the selectedEndDate property.
final CalendarView.SelectionModel.SelectionMode	getSelectionMode()	Gets the value of the selectionMode property.
boolean	isSelected(LocalDate date)	Checks whether the given date is selected.
void	select(LocalDate date)	Selects the given date according to the current selection mode.
final javafx.beans.property.ObjectProperty<LocalDate>	selectedDateProperty()	The primary selected date.
final javafx.beans.property.ListProperty<LocalDate>	selectedDatesProperty()	The selected dates used by multiple-date selection.
final javafx.beans.property.ObjectProperty<LocalDate>	selectedEndDateProperty()	The selected end date used by range selection.
final javafx.beans.property.ObjectProperty<CalendarView.SelectionModel.SelectionMode>	selectionModeProperty()	The current selection mode.
final void	setSelectedDate(LocalDate selectedDate)	Sets the value of the selectedDate property.
final void	setSelectedDates(javafx.collections.ObservableList<LocalDate> selectedDates)	Sets the value of the selectedDates property.
final void	setSelectedEndDate(LocalDate selectedEndDate)	Sets the value of the selectedEndDate property.
final void	setSelectionMode(CalendarView.SelectionModel.SelectionMode selectionMode)	Sets the value of the selectionMode property.

Methods inherited from class Object

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

Property Details

selectionMode

public final javafx.beans.property.ObjectProperty<CalendarView.SelectionModel.SelectionMode> selectionModeProperty

The current selection mode.

See Also:

• getSelectionMode()
• setSelectionMode(CalendarView.SelectionModel.SelectionMode)
• selectionModeProperty()

selectedDate

public final javafx.beans.property.ObjectProperty<LocalDate> selectedDateProperty

The primary selected date.

See Also:

• getSelectedDate()
• setSelectedDate(LocalDate)
• selectedDateProperty()

selectedEndDate

public final javafx.beans.property.ObjectProperty<LocalDate> selectedEndDateProperty

The selected end date used by range selection.

See Also:

• getSelectedEndDate()
• setSelectedEndDate(LocalDate)
• selectedEndDateProperty()

selectedDates

public final javafx.beans.property.ListProperty<LocalDate> selectedDatesProperty

The selected dates used by multiple-date selection.

See Also:

• getSelectedDates()
• setSelectedDates(ObservableList)
• selectedDatesProperty()

Constructor Details

SelectionModel

public SelectionModel()

Creates a new selection model.

Method Details

clearSelection

public final void clearSelection()

Clears all selected dates.

getSelectionMode

public final CalendarView.SelectionModel.SelectionMode getSelectionMode()

Gets the value of the selectionMode property.

Property description:

The current selection mode.

Returns:

the value of the selectionMode property

See Also:

• setSelectionMode(CalendarView.SelectionModel.SelectionMode)
• selectionModeProperty()

selectionModeProperty

public final javafx.beans.property.ObjectProperty<CalendarView.SelectionModel.SelectionMode> selectionModeProperty()

The current selection mode.

Returns:

the selection mode property

See Also:

• getSelectionMode()
• setSelectionMode(CalendarView.SelectionModel.SelectionMode)

setSelectionMode

public final void setSelectionMode(CalendarView.SelectionModel.SelectionMode selectionMode)

Sets the value of the selectionMode property.

Property description:

The current selection mode.

Parameters:

selectionMode - the value for the selectionMode property

See Also:

• getSelectionMode()
• selectionModeProperty()

clearAndSelect

public void clearAndSelect(LocalDate date)

Clears the current selection and selects the given date.

Parameters:

date - the date to select

select

public void select(LocalDate date)

Selects the given date according to the current selection mode.

Parameters:

date - the date to select

clearSelection

public void clearSelection(LocalDate date)

Clears or removes the given date according to the current selection mode.

Parameters:

date - the date to clear

isSelected

public boolean isSelected(LocalDate date)

Checks whether the given date is selected.

Parameters:

date - the date to test

Returns:

true if the date is selected

getSelectedDate

public final LocalDate getSelectedDate()

Gets the value of the selectedDate property.

Property description:

The primary selected date.

Returns:

the value of the selectedDate property

See Also:

• setSelectedDate(LocalDate)
• selectedDateProperty()

selectedDateProperty

public final javafx.beans.property.ObjectProperty<LocalDate> selectedDateProperty()

The primary selected date.

Returns:

the selected date property

See Also:

• getSelectedDate()
• setSelectedDate(LocalDate)

setSelectedDate

public final void setSelectedDate(LocalDate selectedDate)

Sets the value of the selectedDate property.

Property description:

The primary selected date.

Parameters:

selectedDate - the value for the selectedDate property

See Also:

• getSelectedDate()
• selectedDateProperty()

getSelectedEndDate

public final LocalDate getSelectedEndDate()

Gets the value of the selectedEndDate property.

Property description:

The selected end date used by range selection.

Returns:

the value of the selectedEndDate property

See Also:

• setSelectedEndDate(LocalDate)
• selectedEndDateProperty()

selectedEndDateProperty

public final javafx.beans.property.ObjectProperty<LocalDate> selectedEndDateProperty()

The selected end date used by range selection.

Returns:

the selected end date property

See Also:

• getSelectedEndDate()
• setSelectedEndDate(LocalDate)

setSelectedEndDate

public final void setSelectedEndDate(LocalDate selectedEndDate)

Sets the value of the selectedEndDate property.

Property description:

The selected end date used by range selection.

Parameters:

selectedEndDate - the value for the selectedEndDate property

See Also:

• getSelectedEndDate()
• selectedEndDateProperty()

getSelectedDates

public final javafx.collections.ObservableList<LocalDate> getSelectedDates()

Gets the value of the selectedDates property.

Property description:

The selected dates used by multiple-date selection.

Returns:

the value of the selectedDates property

See Also:

• setSelectedDates(ObservableList)
• selectedDatesProperty()

selectedDatesProperty

public final javafx.beans.property.ListProperty<LocalDate> selectedDatesProperty()

The selected dates used by multiple-date selection.

Returns:

the selected dates property

See Also:

• getSelectedDates()
• setSelectedDates(ObservableList)

setSelectedDates

public final void setSelectedDates(javafx.collections.ObservableList<LocalDate> selectedDates)

Sets the value of the selectedDates property.

Property description:

The selected dates used by multiple-date selection.

Parameters:

selectedDates - the value for the selectedDates property

See Also:

• getSelectedDates()
• selectedDatesProperty()