Top Description Fields Constructors Methods
com.calendarfx.view.page

public abstract Class PageBase

extends DateControl
Class Inheritance
Known Direct Subclasses
com.calendarfx.view.page.WeekPage, com.calendarfx.view.page.YearPage, com.calendarfx.view.page.DayPage, com.calendarfx.view.page.MonthPage
Imports
com.calendarfx.view.CalendarView, .DateControl, com.calendarfx.view.print.ViewType, javafx.beans.property.BooleanProperty, .ObjectProperty, .SimpleBooleanProperty, .SimpleObjectProperty, javafx.beans.value.ObservableValue, javafx.collections.ObservableList, javafx.scene.Node, org.controlsfx.control.PropertySheet.Item, java.time.format.DateTimeFormatter, java.util.Optional
The common superclass for all page views. It adds a chrome to the pages so that the user can see the current date in the upper right corner. Navigation controls can be found in the upper left corner.

Field Summary

Modifier and TypeField and Description
private final ObjectProperty<DateTimeFormatter>
dateTimeFormatter

private final String
PAGE_BASE_CATEGORY

private final BooleanProperty
showDate

private final BooleanProperty
showNavigation

Inherited from com.calendarfx.view.DateControl:
usagePolicy

Constructor Summary

AccessConstructor and Description
protected
PageBase()

Constructs a new page.

Method Summary

Modifier and TypeMethod and Description
public final ObjectProperty<DateTimeFormatter>

Returns:

the date formatter
dateTimeFormatterProperty()

A formatter for the date shown in the upper right corner.

public final DateTimeFormatter

Returns:

the date and time formatter
getDateTimeFormatter()

Returns the value of dateTimeFormatterProperty().

public abstract ViewType

Returns:

The print view type.
getPrintViewType()

Returns the type of view used when printing this page.

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 Node

Returns:

extra toolbar controls
getToolBarControls()

Returns one or more controls that can be added to the toolbar by the surrounding container, e.g. the CalendarView.

public final boolean

Returns:

true if the date will be shown
isShowDate()

Returns the value of showDateProperty().

public final boolean

Returns:

true if the navigation controls will be shown
isShowNavigation()

Returns the value of showNavigationProperty().

public final void
setDateTimeFormatter(DateTimeFormatter
the date and time formatter
formatter)

Sets the value of dateTimeFormatterProperty().

public final void
setShowDate(boolean
if true the date willl be shown
show)

Sets the value of showDateProperty().

public final void
setShowNavigation(boolean
if true the navigation controls will be shown
show)

Sets the value of showNavigationProperty().

public final BooleanProperty

Returns:

true if the date will be shown
showDateProperty()

Determines whether the date will be shown by the page in the upper right corner.

public final BooleanProperty

Returns:

true if the navigation controls will be shown
showNavigationProperty()

Determines if the navigation controls for going back and forward in time will be shown in the upper right corner.

Inherited from com.calendarfx.view.DateControl:
availabilityCalendarPropertyavailabilityFillPropertyavailabilityGridPropertybindcalendarSourceFactoryPropertycalendarsPropertyclearSelectioncontextMenuCallbackPropertycreateCalendarSourcecreateEntryAtcreateEntryAtcreateEntryAtcreateEntryClickCountPropertydateDetailsCallbackPropertydatePropertydefaultCalendarProviderPropertydeselectdraggedEntryPropertyeditAvailabilityPropertyeditEntryeditEntryenableHyperlinksPropertyenableTimeZoneSupportPropertyendTimePropertyentryContextMenuCallbackPropertyentryDetailsCallbackPropertyentryDetailsPopOverContentCallbackPropertyentryEditPolicyPropertyentryFactoryPropertyfindEntryViewgetAvailabilityCalendargetAvailabilityFillgetAvailabilityGridgetAvailableZoneIdsgetBoundDateControlsgetCalendarAtgetCalendarsgetCalendarSourceFactorygetCalendarSourcesgetCalendarVisibilityMapgetCalendarVisibilityPropertygetContextMenuCallbackgetCreateEntryClickCountgetDategetDateDetailsCallbackgetDefaultCalendarProvidergetDraggedEntrygetEndTimegetEntryContextMenuCallbackgetEntryDetailsCallbackgetEntryDetailsPopOverContentCallbackgetEntryEditPolicygetEntryFactorygetFirstDayOfWeekgetLayoutgetRequestedTimegetSelectionModegetSelectionsgetStartTimegetTimegetTodaygetUsagePolicygetVirtualGridgetWeekendDaysgetWeekFieldsgetZonedDateTimegetZoneIdgoBackgoForwardgoTodayisCalendarVisibleisEditAvailabilityisEnableHyperlinksisEnableTimeZoneSupportisShowDetailsUponEntryCreationisShowNoonMarkerisShowTodayisSuspendUpdateslayoutPropertyrefreshDatarequestedTimePropertyselectselectionModePropertysetAvailabilityCalendarsetAvailabilityFillsetAvailabilityGridsetCalendarSourceFactorysetCalendarVisibilitysetContextMenuCallbacksetCreateEntryClickCountsetDatesetDateDetailsCallbacksetDefaultCalendarProvidersetDraggedEntrysetEditAvailabilitysetEnableHyperlinkssetEnableTimeZoneSupportsetEndTimesetEntryContextMenuCallbacksetEntryDetailsCallbacksetEntryDetailsPopOverContentCallbacksetEntryEditPolicysetEntryFactorysetLayoutsetRequestedTimesetSelectionModesetShowDetailsUponEntryCreationsetShowNoonMarkersetShowTodaysetStartTimesetSuspendUpdatessetTimesetTodaysetUsagePolicysetVirtualGridsetWeekFieldssetZoneIdshowDateDetailsshowDetailsUponEntryCreationPropertyshowEntryshowNoonMarkerPropertyshowTodayPropertystartTimePropertysuspendUpdatesPropertytimePropertytodayPropertyunbindunbindAllusagePolicyPropertyvirtualGridPropertyvisibleLayersPropertyweekFieldsPropertyzoneIdProperty

Field Detail

dateTimeFormatterback to summary
private final ObjectProperty<DateTimeFormatter> dateTimeFormatter
PAGE_BASE_CATEGORYback to summary
private final String PAGE_BASE_CATEGORY
showDateback to summary
private final BooleanProperty showDate
showNavigationback to summary
private final BooleanProperty showNavigation

Constructor Detail

PageBaseback to summary
protected PageBase()

Constructs a new page.

Method Detail

dateTimeFormatterPropertyback to summary
public final ObjectProperty<DateTimeFormatter> dateTimeFormatterProperty()

A formatter for the date shown in the upper right corner. Each page has its own formatting requirements. The DayPage displays a full date, while the YearPage only shows the current year.

Returns:ObjectProperty<DateTimeFormatter>

the date formatter

getDateTimeFormatterback to summary
public final DateTimeFormatter getDateTimeFormatter()

Returns the value of dateTimeFormatterProperty().

Returns:DateTimeFormatter

the date and time formatter

getPrintViewTypeback to summary
public abstract ViewType getPrintViewType()

Returns the type of view used when printing this page.

Returns:ViewType

The print view type.

getPropertySheetItemsback to summary
public ObservableList<PropertySheet.Item> getPropertySheetItems()

Overrides com.calendarfx.view.DateControl.getPropertySheetItems.

Doc from com.calendarfx.view.CalendarFXControl.getPropertySheetItems.

Returns a list of property items that can be shown by the PropertySheet of ControlsFX.

Returns:ObservableList<PropertySheet.Item>

the property sheet items

Annotations
@Override
getToolBarControlsback to summary
public Node getToolBarControls()

Returns one or more controls that can be added to the toolbar by the surrounding container, e.g. the CalendarView.

Returns:Node

extra toolbar controls

isShowDateback to summary
public final boolean isShowDate()

Returns the value of showDateProperty().

Returns:boolean

true if the date will be shown

isShowNavigationback to summary
public final boolean isShowNavigation()

Returns the value of showNavigationProperty().

Returns:boolean

true if the navigation controls will be shown

setDateTimeFormatterback to summary
public final void setDateTimeFormatter(DateTimeFormatter formatter)

Sets the value of dateTimeFormatterProperty().

Parameters
formatter:DateTimeFormatter

the date and time formatter

setShowDateback to summary
public final void setShowDate(boolean show)

Sets the value of showDateProperty().

Parameters
show:boolean

if true the date willl be shown

setShowNavigationback to summary
public final void setShowNavigation(boolean show)

Sets the value of showNavigationProperty().

Parameters
show:boolean

if true the navigation controls will be shown

showDatePropertyback to summary
public final BooleanProperty showDateProperty()

Determines whether the date will be shown by the page in the upper right corner.

Returns:BooleanProperty

true if the date will be shown

showNavigationPropertyback to summary
public final BooleanProperty showNavigationProperty()

Determines if the navigation controls for going back and forward in time will be shown in the upper right corner.

Returns:BooleanProperty

true if the navigation controls will be shown