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

public Class WeekPage

extends PageBase
Class Inheritance
Imports
com.calendarfx.view.AllDayView, .DetailedWeekView, .Messages, .WeekDayView, .WeekTimeScaleView, com.calendarfx.view.print.ViewType, impl.com.calendarfx.view.page.WeekPageSkin, javafx.beans.property.BooleanProperty, .SimpleBooleanProperty, javafx.beans.value.ObservableValue, javafx.collections.ObservableList, javafx.scene.Node, javafx.scene.control.Skin, .ToggleButton, .Tooltip, javafx.scene.layout.HBox, org.controlsfx.control.PropertySheet, 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 several days in a row, normally a week. The view consists of the page "chrome" inherited from the superclass, a WeekDayView for each day, an AllDayView, and a WeekTimeScaleView. Week Page

Field Summary

Modifier and TypeField and Description
private final DetailedWeekView
detailedWeekView

private final BooleanProperty
showLayoutButton

private final HBox
toolBarControls

private final String
WEEK_PAGE_CATEGORY

Constructor Summary

AccessConstructor and Description
public
WeekPage()

Constructs a new week 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.

public final DetailedWeekView

Returns:

the week view
getDetailedWeekView()

Returns the week view child control.

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 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 "layout" button will be accessible by the user
isShowLayoutButton()

Returns the value of showLayoutButtonProperty().

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 "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
updateToolBarControls(ToggleButton layoutButton)

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

Field Detail

detailedWeekViewback to summary
private final DetailedWeekView detailedWeekView
showLayoutButtonback to summary
private final BooleanProperty showLayoutButton
toolBarControlsback to summary
private final HBox toolBarControls
WEEK_PAGE_CATEGORYback to summary
private final String WEEK_PAGE_CATEGORY

Constructor Detail

WeekPageback to summary
public WeekPage()

Constructs a new week 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
getDetailedWeekViewback to summary
public final DetailedWeekView getDetailedWeekView()

Returns the week view child control.

Returns:DetailedWeekView

the week 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
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
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

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

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

updateToolBarControlsback to summary
private void updateToolBarControls(ToggleButton layoutButton)