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

public Class DayPage

extends PageBase
Class Inheritance
Imports
com.calendarfx.view.AgendaView, .AllDayView, .DayView, .DetailedDayView, .Messages, .MonthView, .TimeScaleView, .YearMonthView, com.calendarfx.view.print.ViewType, impl.com.calendarfx.view.page.DayPageSkin, javafx.beans.property.BooleanProperty, .ObjectProperty, .SimpleBooleanProperty, .SimpleObjectProperty, javafx.beans.value.ObservableValue, javafx.collections.ObservableList, javafx.scene.Node, javafx.scene.control.ContentDisplay, .Skin, .ToggleButton, .Tooltip, javafx.scene.layout.HBox, org.controlsfx.control.PropertySheet, .PropertySheet.Item, .SegmentedButton, org.kordamp.ikonli.fontawesome.FontAwesome, org.kordamp.ikonli.javafx.FontIcon, java.time.format.DateTimeFormatter, java.util.Optional

A composite view focused on displaying calendar information for a single day. The view consists of the page "chrome" inherited from the superclass, a DayView, an AllDayView, a TimeScaleView, a YearMonthView for picking a new date, and an AgendaView. Day Page

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
DayPage.DayPageLayout

An enumerator used for telling the DayPage view to show more or less content.

Field Summary

Modifier and TypeField and Description
private final AgendaView
private static final String
private final ObjectProperty<DayPage.DayPageLayout>
private final DetailedDayView
private final BooleanProperty
private final BooleanProperty
private final Node
private HBox
private final YearMonthView

Constructor Summary

AccessConstructor and Description
public
DayPage()

Constructs a new day page.

Method Summary

Modifier and TypeMethod and Description
protected Skin<?>
createDefaultSkin()

Overrides javafx.scene.control.Control.createDefaultSkin.

Create a new instance of the default skin for this control.

protected Node

Returns:

the toolbar controls specific for this page
createToolBarControls
()

Creates the node used for the page-specific part of the calendar view.

public final ObjectProperty<DayPage.DayPageLayout>

Returns:

the day page layout
dayPageLayoutProperty
()

Stores the currently requested layout for the DayPage.

public final AgendaView

Returns:

the agenda view
getAgendaView
()

Returns the agenda view child control.

public final DayPage.DayPageLayout

Returns:

the layout
getDayPageLayout
()

Returns the value of dayPageLayoutProperty().

public final DetailedDayView

Returns:

the day view
getDetailedDayView
()

Returns the day view.

public final ViewType
getPrintViewType()

Implements abstract com.calendarfx.view.page.PageBase.getPrintViewType.

Returns the type of view used when printing this page.

public ObservableList<PropertySheet.Item>
getPropertySheetItems()

Overrides com.calendarfx.view.page.PageBase.getPropertySheetItems.

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

public Node
getToolBarControls()

Overrides com.calendarfx.view.page.PageBase.getToolBarControls.

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

public final YearMonthView

Returns:

the date picker view
getYearMonthView
()

Returns the date picker child control.

public final void
goBack()

Overrides com.calendarfx.view.DateControl.goBack.

Makes the control go forward in time by removing one or more days from the current date.

public final void
goForward()

Overrides com.calendarfx.view.DateControl.goForward.

Makes the control go forward in time by adding one or more days to the current date.

public final boolean

Returns:

true if the controls will be shown
isShowDayPageLayoutControls
()

Returns the value of showDayPageLayoutControlsProperty().

public final boolean

Returns:

true if the "layout" button will be accessible by the user
isShowLayoutButton
()

Returns the value of showLayoutButtonProperty().

public final void
setDayPageLayout(DayPage.DayPageLayout
the layout
layout
)

Sets the value of dayPageLayoutProperty().

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

Sets the value of showDayPageLayoutControlsProperty().

public final void
setShowLayoutButton(boolean
if true the "layout" button will be accessible by the user
show
)

Sets the value of showLayoutButtonProperty().

public final BooleanProperty

Returns:

true if the controls will be shown
showDayPageLayoutControlsProperty
()

Determines if the controls for switching between different layouts of this view will be shown to the user or not.

public final BooleanProperty

Returns:

true if the "print" button will be accessible by the user
showLayoutButtonProperty
()

Controls whether the "layout" button (to toggle between standard and swimlane layout) in the upper left corner of the control will be shown to the user or not.

private void
updateDayPageLayoutButtons(ToggleButton agendaOnlyButton, ToggleButton dayOnlyButton, ToggleButton standardButton)

private void
updateToolBarControls(SegmentedButton segmentedButton, ToggleButton layoutButton)

Inherited from com.calendarfx.view.page.PageBase:
dateTimeFormatterPropertygetDateTimeFormatterisShowDateisShowNavigationsetDateTimeFormattersetShowDatesetShowNavigationshowDatePropertyshowNavigationProperty

Field Detail

agendaViewback to summary
private final AgendaView agendaView
DAY_PAGE_CATEGORYback to summary
private static final String DAY_PAGE_CATEGORY
dayPageLayoutback to summary
private final ObjectProperty<DayPage.DayPageLayout> dayPageLayout
detailedDayViewback to summary
private final DetailedDayView detailedDayView
showDayPageLayoutControlsback to summary
private final BooleanProperty showDayPageLayoutControls
showLayoutButtonback to summary
private final BooleanProperty showLayoutButton
toolBarControlsback to summary
private final Node toolBarControls
toolbarControlsback to summary
private HBox toolbarControls
yearMonthViewback to summary
private final YearMonthView yearMonthView

Constructor Detail

DayPageback to summary
public DayPage()

Constructs a new day page.

Method Detail

createDefaultSkinback to summary
protected Skin<?> createDefaultSkin()

Overrides javafx.scene.control.Control.createDefaultSkin.

Doc from javafx.scene.control.Control.createDefaultSkin.

Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS -fx-skin or set explicitly in a sub-class with setSkin(...).

Returns:Skin<?>

new instance of default skin for this control. If null then the control will have no skin unless one is provided by css.

Annotations
@Override
createToolBarControlsback to summary
protected Node createToolBarControls()

Creates the node used for the page-specific part of the calendar view.

Returns:Node

the toolbar controls specific for this page

dayPageLayoutPropertyback to summary
public final ObjectProperty<DayPage.DayPageLayout> dayPageLayoutProperty()

Stores the currently requested layout for the DayPage. The layout determines if the page will show only the DayView or a more complext UI with the additional MonthView for picking a date, and an AgendaView with the calendar entries for the next couple of weeks.

Returns:ObjectProperty<DayPage.DayPageLayout>

the day page layout

getAgendaViewback to summary
public final AgendaView getAgendaView()

Returns the agenda view child control.

Returns:AgendaView

the agenda view

getDayPageLayoutback to summary
public final DayPage.DayPageLayout getDayPageLayout()

Returns the value of dayPageLayoutProperty().

Returns:DayPage.DayPageLayout

the layout

getDetailedDayViewback to summary
public final DetailedDayView getDetailedDayView()

Returns the day view.

Returns:DetailedDayView

the day view

getPrintViewTypeback to summary
public final ViewType getPrintViewType()

Implements abstract com.calendarfx.view.page.PageBase.getPrintViewType.

Doc from com.calendarfx.view.page.PageBase.getPrintViewType.

Returns the type of view used when printing this page.

Returns:ViewType

The print view type.

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

Overrides com.calendarfx.view.page.PageBase.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()

Overrides com.calendarfx.view.page.PageBase.getToolBarControls.

Doc from com.calendarfx.view.page.PageBase.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

Annotations
@Override
getYearMonthViewback to summary
public final YearMonthView getYearMonthView()

Returns the date picker child control.

Returns:YearMonthView

the date picker view

goBackback to summary
public final void goBack()

Overrides com.calendarfx.view.DateControl.goBack.

Doc from com.calendarfx.view.DateControl.goBack.

Makes the control go forward in time by removing one or more days from the current date. Subclasses override this method to adjust it to their needs, e.g. the DetailedWeekView removes the number of days found in DetailedWeekView#getNumberOfDays().

Annotations
@Override
goForwardback to summary
public final void goForward()

Overrides com.calendarfx.view.DateControl.goForward.

Doc from com.calendarfx.view.DateControl.goForward.

Makes the control go forward in time by adding one or more days to the current date. Subclasses override this method to adjust it to their needs, e.g. the DetailedWeekView adds the number of days found in DetailedWeekView#getNumberOfDays().

Annotations
@Override
isShowDayPageLayoutControlsback to summary
public final boolean isShowDayPageLayoutControls()

Returns the value of showDayPageLayoutControlsProperty().

Returns:boolean

true if the controls will be shown

isShowLayoutButtonback to summary
public final boolean isShowLayoutButton()

Returns the value of showLayoutButtonProperty().

Returns:boolean

true if the "layout" button will be accessible by the user

setDayPageLayoutback to summary
public final void setDayPageLayout(DayPage.DayPageLayout layout)

Sets the value of dayPageLayoutProperty().

Parameters
layout:DayPage.DayPageLayout

the layout

setShowDayPageLayoutControlsback to summary
public final void setShowDayPageLayoutControls(boolean show)

Sets the value of showDayPageLayoutControlsProperty().

Parameters
show:boolean

if true the controls will be shown

setShowLayoutButtonback to summary
public final void setShowLayoutButton(boolean show)

Sets the value of showLayoutButtonProperty().

Parameters
show:boolean

if true the "layout" button will be accessible by the user

showDayPageLayoutControlsPropertyback to summary
public final BooleanProperty showDayPageLayoutControlsProperty()

Determines if the controls for switching between different layouts of this view will be shown to the user or not.

Returns:BooleanProperty

true if the controls will be shown

showLayoutButtonPropertyback to summary
public final BooleanProperty showLayoutButtonProperty()

Controls whether the "layout" button (to toggle between standard and swimlane layout) in the upper left corner of the control will be shown to the user or not.

Returns:BooleanProperty

true if the "print" button will be accessible by the user

updateDayPageLayoutButtonsback to summary
private void updateDayPageLayoutButtons(ToggleButton agendaOnlyButton, ToggleButton dayOnlyButton, ToggleButton standardButton)
updateToolBarControlsback to summary
private void updateToolBarControls(SegmentedButton segmentedButton, ToggleButton layoutButton)
com.calendarfx.view.page back to summary

public final Enum DayPage.DayPageLayout

extends Enum<DayPage.DayPageLayout>
Class Inheritance

An enumerator used for telling the DayPage view to show more or less content.

Field Summary

Modifier and TypeField and Description
public static final DayPage.DayPageLayout
AGENDA_ONLY

Only displays an AgendaView.

public static final DayPage.DayPageLayout
DAY_ONLY

Only displays the DayView.

public static final DayPage.DayPageLayout
STANDARD

Specifies that the view will display a DayView, a MonthView, and an AgendaView.

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static DayPage.DayPageLayout
public static DayPage.DayPageLayout[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

AGENDA_ONLYback to summary
public static final DayPage.DayPageLayout AGENDA_ONLY

Only displays an AgendaView.

DAY_ONLYback to summary
public static final DayPage.DayPageLayout DAY_ONLY

Only displays the DayView.

STANDARDback to summary
public static final DayPage.DayPageLayout STANDARD

Specifies that the view will display a DayView, a MonthView, and an AgendaView.

Constructor Detail

DayPageLayoutback to summary
private DayPageLayout()

Method Detail

valueOfback to summary
public static DayPage.DayPageLayout valueOf(String name)
valuesback to summary
public static DayPage.DayPageLayout[] values()