CalendarFXView 11.12.7 · com.calendarfx.view.DateControl

Modifier and Type	Class and Description
public static class	DateControl.ContextMenuParameter The parameter object passed to the context menu callback.
private abstract static class	DateControl.ContextMenuParameterBase
public static class	DateControl.CreateCalendarSourceParameter The parameter object passed to the calendar source factory.
public static class	DateControl.CreateEntryParameter The parameter object passed to the entry factory.
public static class	DateControl.DateDetailsParameter The parameter object passed to the date details callback.
private abstract static class	DateControl.DetailsParameter
public static enum	DateControl.EditOperation Possible edit operations on an entry.
public static class	DateControl.EntryContextMenuParameter The parameter object passed to the context menu callback for entries.
public static class	DateControl.EntryDetailsParameter The parameter object passed to the entry details callback.
public static class	DateControl.EntryDetailsPopOverContentParameter The parameter object passed to the entry details popover content callback.
public static class	DateControl.EntryEditParameter Class used for parameter of `DateControl#entryEditPolicy` functional interface.
public static enum	DateControl.Layer
public static enum	DateControl.Layout Supported layout strategies by the `DayView`.
public static enum	DateControl.Usage

Modifier and Type	Field and Description
private final ObjectProperty<Calendar<T>>	availabilityCalendar
private final ObjectProperty<Paint>	availabilityFill
private final ObjectProperty<VirtualGrid>	availabilityGrid
private final ObservableList<ZoneId>	availableZoneIds
private final WeakList<DateControl>	boundDateControls
private final ReadOnlyListWrapper<Calendar<T>>	calendars
private final ObjectProperty<Callback<DateControl.CreateCalendarSourceParameter, CalendarSource>>	calendarSourceFactory
private final ObservableList<CalendarSource>	calendarSources
private final ObservableMap<Calendar<T>, BooleanProperty>	calendarVisibilityMap
private final ObjectProperty<Callback<DateControl.ContextMenuParameter, ContextMenu>>	contextMenuCallback
private final IntegerProperty	createEntryClickCount
private final ObjectProperty<LocalDate>	date
private static final String	DATE_CONTROL_CATEGORY
private final ObjectProperty<Callback<DateControl.DateDetailsParameter, Boolean>>	dateDetailsCallback
private final ObjectProperty<Callback<DateControl, Calendar<T>>>	defaultCalendarProvider
private final ObjectProperty<DraggedEntry>	draggedEntry
private final BooleanProperty	editAvailability
private final BooleanProperty	enableHyperlinks
private final BooleanProperty	enableTimeZoneSupport
private final ObjectProperty<LocalTime>	endTime
private final ObjectProperty<Callback<DateControl.EntryContextMenuParameter, ContextMenu>>	entryContextMenuCallback
private final ObjectProperty<Callback<DateControl.EntryDetailsParameter, Boolean>>	entryDetailsCallback
private final ObjectProperty<Callback<DateControl.EntryDetailsPopOverContentParameter, Node>>	entryDetailsPopoverContentCallback
private final ObjectProperty<Callback<DateControl.EntryEditParameter, Boolean>>	entryEditPolicy
private final ObjectProperty<Callback<DateControl.CreateEntryParameter, Entry<?>>>	entryFactory
private PopOver	entryPopOver
private final ObjectProperty<DateControl.Layout>	layout
private final ObjectProperty<LocalTime>	requestedTime
private final ObjectProperty<SelectionMode>	selectionMode
private final ObservableSet<Entry<?>>	selections
private final BooleanProperty	showDetailsUponEntryCreation
private final BooleanProperty	showNoonMarker
private final BooleanProperty	showToday
private final ObjectProperty<LocalTime>	startTime
private final BooleanProperty	suspendUpdates
private final ObjectProperty<LocalTime>	time
private final ObjectProperty<LocalDate>	today
private final ObservableList<Calendar<T>>	unmodifiableCalendars
private final InvalidationListener	updateCalendarListListener
public final ObjectProperty<Callback<Integer, DateControl.Usage>>	usagePolicy
private Boolean	usesOwnContextMenu
private final ObjectProperty<VirtualGrid>	virtualGrid
private final ObservableSet<DateControl.Layer>	visibleLayers
private final WeakInvalidationListener	weakUpdateCalendarListListener
private final ObservableSet<DayOfWeek>	weekendDays
private final ObjectProperty<WeekFields>	weekFields
private final ObjectProperty<ZoneId>	zoneId

Access	Constructor and Description
protected	DateControl() Constructs a new date control and initializes all factories and callbacks with default implementations.

Method Summary

Modifier and Type	Method and Description
public final ObjectProperty<Calendar<T>>	Returns: the background calendar used for this view availabilityCalendarProperty() A background calendar used to display "availability" of a resource.
public final ObjectProperty<Paint>	Returns: the color used for filling "unavailable" time slots availabilityFillProperty() The color used for drawing the availability background information behind the calendar entries.
public final ObjectProperty<VirtualGrid>	Returns: the availability calendar grid size availabilityGridProperty() Defines a virtual grid to be used for working with the availability calendar.
public final void	bind(DateControl the control that will be bound to this control otherControl, boolean determines if the date property will also be bound bindDate) Binds several properties of the given date control to the same properties of this control.
public final ObjectProperty<Callback<DateControl.CreateCalendarSourceParameter, CalendarSource>>	Returns: the calendar source factory calendarSourceFactoryProperty() A factory for creating a new calendar source, e.g. a new Google calendar account.
public final ReadOnlyListProperty<Calendar<T>>	Returns: the list of all calendars shown by this control calendarsProperty() A list that contains all calendars found in all calendar sources currently attached to this date control.
public final void	clearSelection() Clears the current selection of entries.
public final ObjectProperty<Callback<DateControl.ContextMenuParameter, ContextMenu>>	Returns: the context menu callback contextMenuCallbackProperty() The context menu callback that will be invoked when the user triggers the context menu by clicking in an area without an entry view.
public final void	createCalendarSource() Creates a new calendar source that will be added to the list of calendar sources of this date control.
public final Entry<?>	Returns: the new calendar entry or null if no entry could be created createEntryAt(ZonedDateTime the time point where the entry will be created (the entry start time) time) Creates a new entry at the given time.
public final Entry<?>	Returns: the new calendar entry or null if no entry could be created createEntryAt(ZonedDateTime the time point where the entry will be created (the entry start time) time, Calendar<T> the calendar to which the new entry will be added (if null the default calendar provider will be invoked) calendar) Creates a new entry at the given time.
public final Entry<?>	Returns: the new calendar entry or null if no entry could be created createEntryAt(ZonedDateTime the time point where the entry will be created (the entry start time) time, Calendar<T> the calendar to which the new entry will be added (if null the default calendar provider will be invoked) calendar, boolean entry will be invisible until the application calls `Entry#setHidden(boolean)`. initiallyHidden) Creates a new entry at the given time.
public IntegerProperty	Returns: the number of mouse clicks required for creating a new entry createEntryClickCountProperty() An integer that determines how many times the user has to perform a primary mouse button click in order to create a new entry.
public final ObjectProperty<Callback<DateControl.DateDetailsParameter, Boolean>>	Returns: the callback for showing details for a given date dateDetailsCallbackProperty() A callback used for showing the details of a given date.
public final ObjectProperty<LocalDate>	Returns: the date shown by the control dateProperty() The date that needs to be shown by the date control.
public final ObjectProperty<Callback<DateControl, Calendar<T>>>	Returns: the default calendar provider callback defaultCalendarProviderProperty() The default calendar provider is responsible for returning a calendar that can be used to add a new entry.
public final void	deselect(Entry<?> the selected entries entry) Removes the given entry from the set of currently selected entries.
private void	doBounceEntry(Entry<?> entry)
private void	doEditEntry(Entry<?> entry)
private EntryViewBase<?>	doFindEntryView(Parent parent, Entry<?> entry)
private void	doShowEntry(Entry<?> entry, boolean startEditing, boolean changeDate)
public final ObjectProperty<DraggedEntry>	Returns: the dragged entry draggedEntryProperty() Stores a `DraggedEntry` instance, which serves as a wrapper around the actual entry that is currently being edited by the user.
public BooleanProperty	Returns: true if the user can edit availability editAvailabilityProperty() A flag used to signal whether the user is allowed to modify the availability calendar.
public final void	editEntry(Entry<?> the entry to show entry) Adjusts the current view / page in such a way that the given entry becomes visible and brings up the detail editor / UI for the entry (default is a popover).
public final void	editEntry(Entry<?> the entry to show entry, boolean change the date of the control to the entry's start date changeDate) Adjusts the current view / page in such a way that the given entry becomes visible and brings up the detail editor / UI for the entry (default is a popover).
public final BooleanProperty	Returns: true if the support for hyperlinks is enabled enableHyperlinksProperty() A property used to control whether the control allows the user to click on it or an element inside it in order to "jump" to another screen with more detail.
public final BooleanProperty	Returns: true if time zone support is enabled enableTimeZoneSupportProperty() Enables or disables user options to work with different time zones.
public final ObjectProperty<LocalTime>	Returns: the end time endTimeProperty() An end time used to limit the time interval shown by the control.
public final ObjectProperty<Callback<DateControl.EntryContextMenuParameter, ContextMenu>>	Returns: the property used for storing the callback entryContextMenuCallbackProperty() A callback used for dynamically creating a context menu for a given entry view.
public final ObjectProperty<Callback<DateControl.EntryDetailsParameter, Boolean>>	Returns: the callback used for showing details for a given entry entryDetailsCallbackProperty() A callback used for showing the details of a given entry.
public final ObjectProperty<Callback<DateControl.EntryDetailsPopOverContentParameter, Node>>	Returns: the popover content callback entryDetailsPopOverContentCallbackProperty() Stores a callback for creating the content of the popover.
public final ObjectProperty<Callback<DateControl.EntryEditParameter, Boolean>>	Returns: the property entryEditPolicyProperty() A property that stores a callback used for editing entries.
public final ObjectProperty<Callback<DateControl.CreateEntryParameter, Entry<?>>>	Returns: the entry factory callback entryFactoryProperty() A factory for creating new entries when the user double clicks inside the date control or when the application calls `createEntryAt(ZonedDateTime)`.
public final EntryViewBase<?>	Returns: the view findEntryView(Entry<?> the entry entry) Finds the first view that represents the given entry.
public final Calendar<T>	getAvailabilityCalendar()
public final Paint	getAvailabilityFill()
public final VirtualGrid	getAvailabilityGrid()
public final ObservableList<ZoneId>	Returns: the list of available time zone IDs getAvailableZoneIds() A list of time zones / time zone IDs that will be available to the user in the date controls.
public final WeakList<DateControl>	Returns: the bound date controls / sub controls / children controls getBoundDateControls() Returns all data controls that are bound to this control.
public Optional<Calendar<T>>	Returns: the calendar at the given location getCalendarAt(double the x-coordinate to check x, double the y-coordinate to check y) Returns the calendar shown at the given location.
public final ObservableList<Calendar<T>>	Returns: the list of all calendars shown by this control getCalendars() Returns the value of `calendarsProperty()`.
public final Callback<DateControl.CreateCalendarSourceParameter, CalendarSource>	Returns: the calendar source factory getCalendarSourceFactory() Returns the value of `calendarSourceFactoryProperty()`.
public final ObservableList<CalendarSource>	Returns: the calendar sources getCalendarSources() The list of all calendar sources attached to this control.
public final ObservableMap<Calendar<T>, BooleanProperty>	getCalendarVisibilityMap()
public final BooleanProperty	getCalendarVisibilityProperty(Calendar<T> calendar)
public final Callback<DateControl.ContextMenuParameter, ContextMenu>	Returns: the context menu callback getContextMenuCallback() Returns the value of `contextMenuCallbackProperty()`.
public int	getCreateEntryClickCount()
public final LocalDate	Returns: the date shown by the control getDate() Returns the value of `dateProperty()`.
public final Callback<DateControl.DateDetailsParameter, Boolean>	Returns: the date details callback getDateDetailsCallback() Returns the value of `dateDetailsCallbackProperty()`.
public final Callback<DateControl, Calendar<T>>	Returns: the default calendar provider getDefaultCalendarProvider() Returns the value of `defaultCalendarProviderProperty()`.
public final DraggedEntry	Returns: the dragged entry getDraggedEntry() Returns the value of `draggedEntryProperty()`.
public final LocalTime	Returns: the end time getEndTime() Returns the value of `endTimeProperty()`.
public final Callback<DateControl.EntryContextMenuParameter, ContextMenu>	Returns: the callback for creating a context menu for a given calendar entry getEntryContextMenuCallback() Returns the value of `entryContextMenuCallbackProperty()`.
public final Callback<DateControl.EntryDetailsParameter, Boolean>	Returns: the entry details callback getEntryDetailsCallback() Returns the value of `entryDetailsCallbackProperty()`.
public final Callback<DateControl.EntryDetailsPopOverContentParameter, Node>	Returns: the entry details popover content callback getEntryDetailsPopOverContentCallback() Returns the value of `entryDetailsPopOverContentCallbackProperty()`.
public final Callback<DateControl.EntryEditParameter, Boolean>	Returns: The entry edit policy callback getEntryEditPolicy() Returns the value of `entryEditPolicy`.
public final Callback<DateControl.CreateEntryParameter, Entry<?>>	Returns: the factory used for creating a new entry getEntryFactory() Returns the value of `entryFactoryProperty()`.
public final DayOfWeek	Returns: the first day of the week getFirstDayOfWeek() A convenience method to look up the first day of the week ("Monday" in Germany, "Sunday" in the US).
public final DateControl.Layout	Returns: the layout strategy getLayout() Returns the value of `layoutProperty()`.
public ObservableList<PropertySheet.Item>	getPropertySheetItems() Overrides com.calendarfx.view.CalendarFXControl.getPropertySheetItems. Returns a list of property items that can be shown by the `PropertySheet` of ControlsFX.
public final LocalTime	Returns: the requested time getRequestedTime() Returns the value of `requestedTimeProperty()`.
public final SelectionMode	Returns: the selection mode (single, multiple) getSelectionMode() Returns the value of `selectionModeProperty()`.
public final ObservableSet<Entry<?>>	Returns: the set of currently selected entries getSelections() Stores the currently selected entries.
public final LocalTime	Returns: the start time getStartTime() Returns the value of `startTimeProperty()`.
public final LocalTime	Returns: the current time getTime() Returns the value of `timeProperty()`.
public final LocalDate	Returns: the date representing "today" getToday() Returns the value of `todayProperty()`.
public final Callback<Integer, DateControl.Usage>	Returns: the new usage policy getUsagePolicy() Returns the value of `usagePolicyProperty()`.
public final VirtualGrid	Returns: the currently active grid getVirtualGrid() Returns the value of `virtualGridProperty()`.
public ObservableSet<DayOfWeek>	Returns: the weekend days getWeekendDays() Returns the days of the week that are considered to be weekend days, for example Saturday and Sunday, or Friday and Saturday.
public final WeekFields	Returns: the week fields getWeekFields() Returns the value of `weekFieldsProperty()`.
public final ZonedDateTime	Returns: the zoned date time version of the current time property getZonedDateTime() Returns the zoned date time version of the current time.
public final ZoneId	Returns: the time zone getZoneId() Returns the value of `zoneIdProperty()`.
public void	goBack() Makes the control go forward in time by removing one or more days from the current date.
public void	goForward() Makes the control go forward in time by adding one or more days to the current date.
public void	goToday() Makes the control go to "today".
public final boolean	isCalendarVisible(Calendar<T> calendar)
public boolean	isEditAvailability()
public final boolean	Returns: true if the hyperlink support is enabled isEnableHyperlinks() Returns the value of the `enableHyperlinksProperty()`.
public final boolean	isEnableTimeZoneSupport()
public final boolean	isShowDetailsUponEntryCreation()
public final boolean	isShowNoonMarker()
public final boolean	Returns: true if today will be highlighted visually isShowToday() Returns the value of `showTodayProperty()`.
public final boolean	Returns: true if updates are suspended isSuspendUpdates() Returns the value of `suspendUpdatesProperty()`.
public final ObjectProperty<DateControl.Layout>	Returns: the layout strategy of the view layoutProperty() Stores the strategy used by the view to lay out the entries of several calendars at once.
public final void	refreshData() Requests that the date control should reload its data and recreate its entry views.
public final ObjectProperty<LocalTime>	Returns: the requested time requestedTimeProperty() Stores the time that the application wants to show in its date controls when the UI opens up.
public final void	select(Entry<?> the selected entries entry) Adds the given entry to the set of currently selected entries.
public final ObjectProperty<SelectionMode>	Returns: the selection mode selectionModeProperty() Stores the selection mode.
public final void	setAvailabilityCalendar(Calendar<T> calendar)
public final void	setAvailabilityFill(Paint availabilityFill)
public final void	setAvailabilityGrid(VirtualGrid availabilityGrid)
public final void	setCalendarSourceFactory(Callback<DateControl.CreateCalendarSourceParameter, CalendarSource> the callback used for creating a new calendar source callback) Sets the value of `calendarSourceFactoryProperty()`.
public final void	setCalendarVisibility(Calendar<T> calendar, boolean visible)
public final void	setContextMenuCallback(Callback<DateControl.ContextMenuParameter, ContextMenu> the context menu callback callback) Sets the value of `contextMenuCallbackProperty()`.
public void	setCreateEntryClickCount(int createEntryClickCount)
public final void	setDate(LocalDate the date shown by the control date) Sets the value of `dateProperty()`.
public final void	setDateDetailsCallback(Callback<DateControl.DateDetailsParameter, Boolean> the date details callback callback) Sets the value of `dateDetailsCallbackProperty()`.
public final void	setDefaultCalendarProvider(Callback<DateControl, Calendar<T>> the default calendar provider provider) Sets the value of `defaultCalendarProviderProperty()`.
public final void	setDraggedEntry(DraggedEntry the dragged entry entry) Sets the value of `draggedEntryProperty()`.
public void	setEditAvailability(boolean editAvailability)
public final void	setEnableHyperlinks(boolean if true the hyperlink support will be enabled enable) Sets the value of the `enableHyperlinksProperty()`.
public final void	setEnableTimeZoneSupport(boolean enableTimeZoneSupport)
public final void	setEndTime(LocalTime the end time time) Sets the value of `endTimeProperty()`.
public final void	setEntryContextMenuCallback(Callback<DateControl.EntryContextMenuParameter, ContextMenu> the callback used for creating a context menu for a calendar entry callback) Sets the value of `entryContextMenuCallbackProperty()`.
public final void	setEntryDetailsCallback(Callback<DateControl.EntryDetailsParameter, Boolean> the entry details callback callback) Sets the value of `entryDetailsCallbackProperty()`.
public final void	setEntryDetailsPopOverContentCallback(Callback<DateControl.EntryDetailsPopOverContentParameter, Node> the entry details popover content callback callback) Sets the value of `entryDetailsPopOverContentCallbackProperty()`.
public final void	setEntryEditPolicy(Callback<DateControl.EntryEditParameter, Boolean> the entry edit policy callback policy) Sets the value of `entryEditPolicy`.
public final void	setEntryFactory(Callback<DateControl.CreateEntryParameter, Entry<?>> the factory used for creating a new entry factory) Sets the value of `entryFactoryProperty()`.
public final void	setLayout(DateControl.Layout the layout layout) Sets the value of `layoutProperty()`.
public final void	setRequestedTime(LocalTime the requested time time) Sets the value of `requestedTimeProperty()`.
public final void	setSelectionMode(SelectionMode the selection mode (single, multiple) mode) Sets the value of `selectionModeProperty()`.
public final void	setShowDetailsUponEntryCreation(boolean showDetailsUponEntryCreation)
public final void	setShowNoonMarker(boolean showNoonMarker)
public final void	setShowToday(boolean if true today will be highlighted visually show) Sets the value of `showTodayProperty()`.
public final void	setStartTime(LocalTime the start time time) Sets the value of `startTimeProperty()`.
public final void	setSuspendUpdates(boolean if true updates are suspended suspend) Sets the value of `suspendUpdatesProperty()`.
public final void	setTime(LocalTime the current time time) Sets the value of `timeProperty()`.
public final void	setToday(LocalDate the date representing "today" date) Sets the value of `todayProperty()`.
public final void	setUsagePolicy(Callback<Integer, DateControl.Usage> the new usage policy policy) Sets the value of `usagePolicyProperty()`.
public final void	setVirtualGrid(VirtualGrid the grid grid) Sets the value of `virtualGridProperty()`.
public final void	setWeekFields(WeekFields the new week fields weekFields) Sets the value of `weekFieldsProperty()`.
public final void	setZoneId(ZoneId the time zone zoneId) Sets the value of `zoneIdProperty()`.
public void	showDateDetails(Node the owner node owner, LocalDate the date for which to display more detail date) Creates a new `DatePopOver` and shows it attached to the given owner node.
public final BooleanProperty	Returns: true if the date control shows a dialog immediately after a new entry was added by the user showDetailsUponEntryCreationProperty() Determines if the `entryDetailsCallbackProperty()` will be used to display a dialog for a newly added calendar entry.
public final void	showEntry(Entry<?> the entry to show entry) Adjusts the current view / page in such a way that the given entry becomes visible.
private void	showEntryDetails(Entry<?> entry, Node node, Node owner, double screenY)
public final BooleanProperty	Returns: true if noon will be marked in a special way showNoonMarkerProperty() A property used to indicate whether the day view should mark noon with a special marker.
public final BooleanProperty	Returns: true if today will be shown differently showTodayProperty() A flag used to indicate that the view will mark the area that represents the value of `todayProperty()`.
public final ObjectProperty<LocalTime>	Returns: the start time startTimeProperty() A start time used to limit the time interval shown by the control.
public final BooleanProperty	Returns: true if updates are suspended suspendUpdatesProperty() A property that will suspend all updates to the view based on model changes.
public final ObjectProperty<LocalTime>	Returns: the current time timeProperty() Stores a time that can be visualized, e.g. the thin line in `DayView` representing the current time.
public final ObjectProperty<LocalDate>	Returns: the date representing "today" todayProperty() Stores the date that is considered to represent "today".
public final void	unbind(DateControl the control to unbind otherControl) Unbinds the given control from this control.
public final void	unbindAll() Unbinds all bound date controls.
private void	updateCalendarList()
public final ObjectProperty<Callback<Integer, DateControl.Usage>>	Returns: the usage policy usagePolicyProperty() A property used to store a policy that will be used to determine if a given number of entries indicates a low or high usage of that day.
public final ObjectProperty<VirtualGrid>	Returns: the virtual grid virtualGridProperty() A virtual grid used for snapping to invisible grid lines while editing calendar entries.
public final ObservableSet<DateControl.Layer>	visibleLayersProperty() Collection of layers which should be visible/presented.
public final ObjectProperty<WeekFields>	Returns: the week fields weekFieldsProperty() Week fields are used to determine the first day of a week (e.g. "Monday" in Germany or "Sunday" in the US).
public final ObjectProperty<ZoneId>	Returns: the time zone used by the date control for calculating entry view layouts zoneIdProperty() The time zone used by the date control.

Inherited from com.calendarfx.view.CalendarFXControl:: getUserAgentStylesheet

public abstract Class DateControl

Binding

Current Date, Today, First Day of Week

Creating Sources, Calendars, Entries

Context Menu

Details for Entries and Dates

Selection Handling

Virtual Grid

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary