CalendarFXView 11.12.7 · com.calendarfx.view.CalendarView

Modifier and Type	Class and Description
public static enum	CalendarView.Page An enumerator listing the available pages that can be shown by the calendar view.

Modifier and Type	Field and Description
private final ObservableList<CalendarView.Page>	availablePages
private final String	CALENDAR_VIEW_CATEGORY
private DayPage	dayPage
private static final String	DEFAULT_STYLE_CLASS
private DeveloperConsole	developerConsole
private final ObjectProperty<Node>	footer
private final ObjectProperty<Node>	header
private MonthPage	monthPage
private PrintView	printView
private final CustomTextField	searchField
private final SearchResultView	searchResultView
private static final String	SELECTED_PAGE
private final ReadOnlyObjectWrapper<CalendarView.Page>	selectedPage
private final BooleanProperty	showAddCalendarButton
private final BooleanProperty	showDevoloperConsole
private final BooleanProperty	showPageSwitcher
private final BooleanProperty	showPageToolBarControls
private final BooleanProperty	showPrintButton
private final BooleanProperty	showSearchField
private final BooleanProperty	showSearchResultsTray
private final BooleanProperty	showSourceTray
private final BooleanProperty	showSourceTrayButton
private final BooleanProperty	showToolBar
private final SourceView	sourceView
private final BooleanProperty	traysAnimated
private WeekPage	weekPage
private final YearMonthView	yearMonthView
private YearPage	yearPage

Access	Constructor and Description
public	CalendarView()
public	CalendarView(CalendarView.Page... availablePages) Constructs a new calendar view.

Method Summary

Modifier and Type	Method and Description
protected Skin<?>	createDefaultSkin() Overrides javafx.scene.control.Control.createDefaultSkin. Create a new instance of the default skin for this control.
public final ObjectProperty<Node>	Returns: a node added as a footer to the view (e.g. a status bar) footerProperty() Property used to reference a node that can be used as a footer for the calendar view.
public final ObservableList<CalendarView.Page>	Returns: the available pages getAvailablePages() Returns the list of pages that will be available within the calendar view (day, week, month, year).
public final DayPage	Returns: the day page getDayPage() Returns the day page.
public final DeveloperConsole	Returns: the developer console or null if the system property "calendarfx.developer" is not set to true getDeveloperConsole() Returns the developer console that can be made visible via a META-D keystroke when the system property "calendarfx.developer" is set to true.
public final Node	Returns: the header node shown below the actual calendar getFooter() Returns the value of `footerProperty()`.
public final Node	Returns: the node that will be shown above the actual calendar getHeader() Returns the value of `headerProperty()`.
public final MonthPage	Returns: the month page getMonthPage() Returns the month page.
public PageBase	getPageView(CalendarView.Page page)
public final PrintView	Returns: the print view getPrintView() Returns the print view associated with this view.
public ObservableList<PropertySheet.Item>	getPropertySheetItems() Overrides com.calendarfx.view.DateControl.getPropertySheetItems. Returns a list of property items that can be shown by the `PropertySheet` of ControlsFX.
public final CustomTextField	Returns: the search field getSearchField() Returns the search text field.
public final SearchResultView	Returns: the search result view getSearchResultView() Returns the search result view child control.
public final CalendarView.Page	Returns: the selected page view getSelectedPage() The value of `selectedPageProperty()`.
public final PageBase	Returns: the selected page view getSelectedPageView() Returns the view for the currently selected `Page`.
public final SourceView	Returns: the source view getSourceView() Returns the source view child control.
public final WeekPage	Returns: the week page getWeekPage() Returns the week page.
public final YearMonthView	Returns: the year month view getYearMonthView() Returns the year month view child control.
public final YearPage	Returns: the year page getYearPage() Returns the year page.
public final ObjectProperty<Node>	Returns: a node added as a header to the view (e.g. a tool bar) headerProperty() Property used to reference a node that can be used as a header for the calendar view.
public final boolean	Returns: true if the "add calendar" button will be accessible by the user isShowAddCalendarButton() Returns the value of `showAddCalendarButtonProperty()`.
public final boolean	Returns: true if the developer console gets shown to the user isShowDeveloperConsole() Returns the value of `showSourceTrayProperty()`.
public final boolean	Returns: true if the page switcher will be visible isShowPageSwitcher() Returns the value of `showPageSwitcherProperty()`.
public final boolean	Returns: true if the "page-specific" toolbar controls will be accessible by the user isShowPageToolBarControls() Returns the value of `showPageToolBarControlsProperty()`.
public final boolean	Returns: true if the "print" button will be accessible by the user isShowPrintButton() Returns the value of `showPrintButtonProperty()`.
public final boolean	Returns: true if the search field will be accessible by the user isShowSearchField() Returns the value of `showSearchFieldProperty()`.
public final boolean	Returns: true if the search result tray is visible isShowSearchResultsTray() Returns the value of `showSearchResultsTrayProperty()`.
public final boolean	Returns: true if the calendar source tray gets shown to the user isShowSourceTray() Returns the value of `showSourceTrayProperty()`.
public final boolean	Returns: true if the source tray button will be accessible by the user isShowSourceTrayButton() Returns the value of `showSourceTrayButtonProperty()`.
public final boolean	Returns: true if the toolbar will be visible isShowToolBar() Returns the value of `showToolBarProperty()`.
public final boolean	Returns: true if tray animations are enabled isTraysAnimated() Returns the value of `traysAnimatedProperty()`.
public final ReadOnlyObjectProperty<CalendarView.Page>	Returns: the selected page view selectedPageProperty() A read-only property used for storing the currently selected page.
public final void	setFooter(Node a node that will be shown below the actual calendar node) Sets the value of `footerProperty()`.
public final void	setHeader(Node a node that will be shown above the actual calendar node) Sets the value of `headerProperty()`.
public final void	setShowAddCalendarButton(boolean if true the "add calendar" button will be accessible by the user show) Sets the value of `showAddCalendarButtonProperty()`.
public final void	setShowDeveloperConsole(boolean if true will show the developer console show) Sets the value of `showDeveloperConsoleProperty()`.
public final void	setShowPageSwitcher(boolean true if the page switcher will be visible show) Sets the value of `showPageSwitcherProperty()`.
public final void	setShowPageToolBarControls(boolean if true the "page-specific" toolbar controls will be accessible by the user show) Sets the value of `showPageToolBarControlsProperty()`.
public final void	setShowPrintButton(boolean if true the "print" button will be accessible by the user show) Sets the value of `showPrintButtonProperty()`.
public final void	setShowSearchField(boolean if true the search field will be accessible by the user show) Sets the value of `showSearchFieldProperty()`.
public final void	setShowSearchResultsTray(boolean if true the search result tray will be shown to the user show) Sets the value of `showSearchResultsTrayProperty()`.
public final void	setShowSourceTray(boolean if true will show the tray show) Sets the value of `showSourceTrayProperty()`.
public final void	setShowSourceTrayButton(boolean if true the source tray button will be accessible by the user show) Sets the value of `showSourceTrayButtonProperty()`.
public final void	setShowToolBar(boolean true if the toolbar will be visible show) Sets the value of `showToolBarProperty()`.
public final void	setTraysAnimated(boolean if true tray animations will be used when opening / closing the source tray or the search result tray animated) Sets the value of `traysAnimatedProperty()`.
public final BooleanProperty	Returns: true if the "add calendar" button will be accessible by the user showAddCalendarButtonProperty() Controls whether the "add calendar" button in the upper left corner of the control will be shown to the user or not.
public final void	showDate(LocalDate the date to show in the view date) Sends the request to the calendar view to display the given date.
public final void	showDateTime(LocalDateTime the date and time to show in the view dateTime) Sends the request to the calendar view to display the given date and time.
public final void	showDayPage() Switches the view to the `DayPage`.
public final BooleanProperty	Returns: true if the developer console will be shown to the user showDeveloperConsoleProperty() Controls the visibility of the developer console.
public final void	showMonthPage() Switches the view to the `MonthPage`.
public final BooleanProperty	Returns: true if the toolbar will be shown to the user showPageSwitcherProperty() Controls whether the page switcher (day, week, month, year) will be shown to the user or not.
public final BooleanProperty	Returns: true if the "page-specific" toolbar controls will be accessible by the user showPageToolBarControlsProperty() Controls whether the "page-specific" toolbar controls (e.g. DayPage: agenda view, day view, combined view) in the upper left corner of the control will be shown to the user or not.
public final BooleanProperty	Returns: true if the "print" button will be accessible by the user showPrintButtonProperty() Controls whether the "print" button in the upper left corner of the control will be shown to the user or not.
public final BooleanProperty	Returns: true if the search field will be accessible by the user showSearchFieldProperty() Controls whether the search field (text field) in the upper right corner of the control will be shown to the user or not.
public final BooleanProperty	Returns: the search result tray visibility showSearchResultsTrayProperty() Controls the visibility of the search results tray.
public final BooleanProperty	Returns: true if the source tray button will be accessible by the user showSourceTrayButtonProperty() Controls whether the source tray button in the upper left corner of the control will be shown to the user or not.
public final BooleanProperty	Returns: true if the source tray will be shown to the user showSourceTrayProperty() Controls the visibility of the source tray.
public final BooleanProperty	Returns: true if the toolbar will be shown to the user showToolBarProperty() Controls whether the toolbar will be shown to the user or not.
public final void	showWeek(Year the date to show in the view year, int the week to show in the view weekOfYear) Sends the request to the calendar view to display the given week.
public final void	showWeekPage() Switches the view to the `WeekPage`.
public final void	showYear(Year the year to show in the view year) Sends the request to the calendar view to display the given year.
public final void	showYearMonth(YearMonth the year and month to show in the view yearMonth) Sends the request to the calendar view to display the given year and month.
public final void	showYearPage() Switches the view to the `YearPage`.
public final BooleanProperty	Returns: true if animations (eye candy) are enabled traysAnimatedProperty() A property used to control whether closing or opening the trays (source view, search result view) will be animated.

Inherited from com.calendarfx.view.DateControl:: availabilityCalendarProperty availabilityFillProperty availabilityGridProperty bind calendarSourceFactoryProperty calendarsProperty clearSelection contextMenuCallbackProperty createCalendarSource createEntryAt createEntryAt createEntryAt createEntryClickCountProperty dateDetailsCallbackProperty dateProperty defaultCalendarProviderProperty deselect draggedEntryProperty editAvailabilityProperty editEntry editEntry enableHyperlinksProperty enableTimeZoneSupportProperty endTimeProperty entryContextMenuCallbackProperty entryDetailsCallbackProperty entryDetailsPopOverContentCallbackProperty entryEditPolicyProperty entryFactoryProperty findEntryView getAvailabilityCalendar getAvailabilityFill getAvailabilityGrid getAvailableZoneIds getBoundDateControls getCalendarAt getCalendars getCalendarSourceFactory getCalendarSources getCalendarVisibilityMap getCalendarVisibilityProperty getContextMenuCallback getCreateEntryClickCount getDate getDateDetailsCallback getDefaultCalendarProvider getDraggedEntry getEndTime getEntryContextMenuCallback getEntryDetailsCallback getEntryDetailsPopOverContentCallback getEntryEditPolicy getEntryFactory getFirstDayOfWeek getLayout getRequestedTime getSelectionMode getSelections getStartTime getTime getToday getUsagePolicy getVirtualGrid getWeekendDays getWeekFields getZonedDateTime getZoneId goBack goForward goToday isCalendarVisible isEditAvailability isEnableHyperlinks isEnableTimeZoneSupport isShowDetailsUponEntryCreation isShowNoonMarker isShowToday isSuspendUpdates layoutProperty refreshData requestedTimeProperty select selectionModeProperty setAvailabilityCalendar setAvailabilityFill setAvailabilityGrid setCalendarSourceFactory setCalendarVisibility setContextMenuCallback setCreateEntryClickCount setDate setDateDetailsCallback setDefaultCalendarProvider setDraggedEntry setEditAvailability setEnableHyperlinks setEnableTimeZoneSupport setEndTime setEntryContextMenuCallback setEntryDetailsCallback setEntryDetailsPopOverContentCallback setEntryEditPolicy setEntryFactory setLayout setRequestedTime setSelectionMode setShowDetailsUponEntryCreation setShowNoonMarker setShowToday setStartTime setSuspendUpdates setTime setToday setUsagePolicy setVirtualGrid setWeekFields setZoneId showDateDetails showDetailsUponEntryCreationProperty showEntry showNoonMarkerProperty showTodayProperty startTimeProperty suspendUpdatesProperty timeProperty todayProperty unbind unbindAll usagePolicyProperty virtualGridProperty visibleLayersProperty weekFieldsProperty zoneIdProperty

public Class CalendarView

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary