Class SingleDaySelectionModel
- All Implemented Interfaces:
DateSelectionModel
Temporary quick invalid input: '&' dirty class to explore requirements as needed by a DatePicker. Need to define the states more exactly. Currently
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.jdesktop.swingx.calendar.DateSelectionModel
DateSelectionModel.SelectionMode
-
Field Summary
FieldsModifier and TypeFieldDescriptionFields inherited from class org.jdesktop.swingx.calendar.AbstractDateSelectionModel
adjusting, calendar, EMPTY_DATES, listenerMap, locale, lowerBound, upperBound
-
Constructor Summary
ConstructorsConstructorDescriptionInstantiates a SingleDaySelectionModel with default locale.SingleDaySelectionModel
(Locale locale) Instantiates a SingleSelectionModel with the given locale. -
Method Summary
Modifier and TypeMethodDescriptionprivate boolean
aboveUpperBound
(Date date) void
addSelectionInterval
(Date startDate, Date endDate) Adds the specified selection interval to the selection model.private boolean
belowLowerBound
(Date date) void
Clears any selection from the selection model.Returns the earliest date in the selection or null if the selection is empty.Returns the latest date in the selection or null if the selection is empty.getNormalizedDate
(Date date) Returns a normalized Date as used by the implementation, if any.Returns the current selection.Get the selection mode.Returns aSortedSet
ofDates that are unselectable.
private boolean
inUnselectables
(Date date) boolean
isSelectable
(Date date) Returns a boolean indicating whether the given date is selectable.boolean
isSelected
(Date date) Returns true if the date specified is selected, false otherwise.private boolean
isSelectedStrict
(Date date) Checks and returns whether the given date is contained in the selection.boolean
Returns true if the selection is empty, false otherwise.protected boolean
isSelectionInInterval
(Date startDate, Date endDate) Checks and returns whether the selected date is contained in the interval given by startDate/endDate.boolean
isUnselectableDate
(Date date) Returns true is the specified date is unselectable.private boolean
outOfBounds
(Date date) Returns a boolean indication whether the given date is below the lower or above the upper bound.void
removeSelectionInterval
(Date startDate, Date endDate) Removes the specifed selection interval from the selection model.protected void
setSelection
(Date date) Selects the given date if it is selectable and not yet selected.void
setSelectionInterval
(Date startDate, Date endDate) Sest the specified selection interval to the selection model.void
setSelectionMode
(DateSelectionModel.SelectionMode selectionMode) Set the selection mode.void
setUnselectableDates
(SortedSet<Date> unselectables) Sets a collection of dates which are not selectable.Methods inherited from class org.jdesktop.swingx.calendar.AbstractDateSelectionModel
addDateSelectionListener, adjustDatesToTimeZone, endOfDay, fireValueChanged, getCalendar, getDateSelectionListeners, getFirstDayOfWeek, getLocale, getLowerBound, getMinimalDaysInFirstWeek, getTimeZone, getUpperBound, isAdjusting, isSameDay, removeDateSelectionListener, setAdjusting, setFirstDayOfWeek, setLocale, setLowerBound, setMinimalDaysInFirstWeek, setTimeZone, setUpperBound, startOfDay
-
Field Details
-
selectedDates
-
unselectableDates
-
-
Constructor Details
-
SingleDaySelectionModel
public SingleDaySelectionModel()Instantiates a SingleDaySelectionModel with default locale. -
SingleDaySelectionModel
Instantiates a SingleSelectionModel with the given locale. If the locale is null, the Locale's default is used. PENDING JW: fall back to JComponent.getDefaultLocale instead? We use this with components anyway?- Parameters:
locale
- the Locale to use with this model, defaults to Locale.default() if null.
-
-
Method Details
-
getSelectionMode
Get the selection mode.- Returns:
- return the current selection mode
-
setSelectionMode
Set the selection mode.Implemented to do nothing.
- Parameters:
selectionMode
- new selection mode
-
addSelectionInterval
Adds the specified selection interval to the selection model.Implemented to call setSelectionInterval with startDate for both parameters.
- Parameters:
startDate
- interval start date, must not be nullendDate
- interval end date >= start date, must not be null
-
setSelectionInterval
Sest the specified selection interval to the selection model.PENDING JW: define what happens if we have a selection but the interval isn't selectable.
- Parameters:
startDate
- interval start date, must not be nullendDate
- interval end date >= start date, must not be null
-
removeSelectionInterval
Removes the specifed selection interval from the selection model. If the selection is changed by this method, it fires a DateSelectionEvent of type DATES_REMOVED.- Parameters:
startDate
- interval start date, must not be nullendDate
- interval end date >= start date, must not be null
-
isSelectionInInterval
Checks and returns whether the selected date is contained in the interval given by startDate/endDate. The selection must not be empty when calling this method.This implementation interprets the interval between the start of the day of startDay to the end of the day of endDate.
- Parameters:
startDate
- the start of the interval, must not be nullendDate
- the end of the interval, must not be null- Returns:
- true if the selected date is contained in the interval
-
setSelection
Selects the given date if it is selectable and not yet selected. Does nothing otherwise. If this operation changes the current selection, it will fire a DateSelectionEvent of type DATES_SET.- Parameters:
date
- the Date to select, must not be null.
-
isSelectedStrict
Checks and returns whether the given date is contained in the selection. This differs from isSelected in that it tests for the exact (normalized) Date instead of for the same day.- Parameters:
date
- the Date to test.- Returns:
- true if the given date is contained in the selection, false otherwise
-
getFirstSelectionDate
Returns the earliest date in the selection or null if the selection is empty.- Returns:
- the earliest date in the selection, or null if isSelectionEmpty.
- See Also:
-
getLastSelectionDate
Returns the latest date in the selection or null if the selection is empty.- Returns:
- the lastest date in the selection, or null if isSelectionEmpty.
- See Also:
-
isSelectable
Returns a boolean indicating whether the given date is selectable.- Parameters:
date
- the date to check for selectable, must not be null.- Returns:
- true if the given date is selectable, false if not.
-
inUnselectables
- Parameters:
date
-- Returns:
-
outOfBounds
Returns a boolean indication whether the given date is below the lower or above the upper bound.- Parameters:
date
-- Returns:
-
aboveUpperBound
- Parameters:
date
-- Returns:
-
belowLowerBound
- Parameters:
date
-- Returns:
-
clearSelection
public void clearSelection()Clears any selection from the selection model. Fires an Event of type SELECTION_CLEARED if there had been a selection, does nothing otherwise. -
getSelection
Returns the current selection.- Returns:
- sorted set of selected dates, guaranteed to be never null.
-
isSelected
Returns true if the date specified is selected, false otherwise.Note: it is up to implementations to define the exact notion of selected. It does not imply the exact date as given is contained the set returned from getSelection().
- Parameters:
date
- date to check for selection, must not be null- Returns:
- true if the date is selected, false otherwise
-
getNormalizedDate
Returns a normalized Date as used by the implementation, if any. F.i. DaySelectionModel returns the start of the day in the model's calendar. If no normalization is applied, a clone of the Date itself is returned. The given Date is never changed.The overall contract:
if ((date != null) && isSelectable(date)) { setSelectionInterval(date, date); assertEquals(getNormalized(date), getFirstSelectionDate(); }
Implemented to return the date itself.
- Returns:
- the date as it would be normalized before used in the model, must not be null.
-
isSelectionEmpty
public boolean isSelectionEmpty()Returns true if the selection is empty, false otherwise.- Returns:
- true if the selection is empty, false otherwise
-
getUnselectableDates
Returns aSortedSet
ofDates that are unselectable.
- Returns:
- sorted set of dates
-
setUnselectableDates
Sets a collection of dates which are not selectable.Note: it is up to implementations to define the exact notion of unselectableDate. It does not imply the only the exact date as given is unselectable, it might have a period like "all dates on the same day". PENDING JW: any collection would do - why insist on a SortedSet?
- Parameters:
unselectables
- dates that are unselectable, must not be null and must not contain null dates.
-
isUnselectableDate
Returns true is the specified date is unselectable.- Parameters:
date
- the date to check for unselectability, must not be null.- Returns:
- true is the date is unselectable, false otherwise
-