MonthSheetView (CalendarFX API)

java.lang.Object
- javafx.scene.Node
- - javafx.scene.Parent
  - - javafx.scene.layout.Region
    - - javafx.scene.control.Control
      - com.calendarfx.view.CalendarFXControl
        
        com.calendarfx.view.DateControl
        
        com.calendarfx.view.MonthSheetView

All Implemented Interfaces:

Styleable, EventTarget, Skinnable
```
public class MonthSheetView
extends DateControl
```
A view laying out months and dates in a spreadsheet style. An ideal way of displaying several months or even a year. Each day is represented by a cell (see MonthSheetView.DateCell). Cells are created by a cell factory and can be customized to fit an application's needs.
Screenshot (Using DetailedDateCell)

Screenshot (Using "aligned" weekday layout)

See Also:

setWeekDayLayout(WeekDayLayoutStrategy), setCellFactory(Callback), MonthSheetView.DateCell, MonthSheetView.SimpleDateCell, MonthSheetView.DetailedDateCell, MonthSheetView.BadgeDateCell, MonthSheetView.UsageDateCell

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`ObjectProperty<Callback<MonthSheetView.DateParameter,MonthSheetView.DateCell>>`	`cellFactory` A property used to store a reference to the cell factory for this view.
`ObjectProperty<MonthSheetView.ClickBehaviour>`	`clickBehaviour` The behaviour used when the user clicks on a date.
`ObjectProperty<DateSelectionModel>`	`dateSelectionModel` A property used to store a selection model for selecting dates.
`IntegerProperty`	`extendedUnitsBackward` An integer property that stores the number of units that will be used to extend the view by.
`IntegerProperty`	`extendedUnitsForward` An integer property that stores the number of units that will be used to extend the view by.
`ObjectProperty<MonthSheetView.ViewUnit>`	`extendedViewUnit` A property used to store the unit shown by the view in front of or after the main columns (e.g.
`ObjectProperty<Callback<MonthSheetView.HeaderParameter,Node>>`	`headerCellFactory` A property used to store a reference to the "header" cell factory for this view.
`BooleanProperty`	`showWeekNumber` A property used to control whether the week numbers should be shown.
`ObjectProperty<MonthSheetView.ViewUnit>`	`viewUnit` A property used to store the unit shown by the view (e.g.
`ObjectProperty<MonthSheetView.WeekDayLayoutStrategy>`	`weekDayLayout` A property used to store the layout strategy used by this view.

Properties inherited from class javafx.scene.control.Control
contextMenuProperty, skinClassNameProperty, skinProperty, tooltipProperty

Properties inherited from class javafx.scene.layout.Region
backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, heightProperty, insetsProperty, maxHeightProperty, maxWidthProperty, minHeightProperty, minWidthProperty, opaqueInsetsProperty, paddingProperty, prefHeightProperty, prefWidthProperty, scaleShapeProperty, shapeProperty, snapToPixelProperty, widthProperty

Properties inherited from class javafx.scene.Parent
impl_traversalEngineProperty, needsLayoutProperty

Properties inherited from class javafx.scene.Node
accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, cacheHintProperty, cacheProperty, clipProperty, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, focusedProperty, focusTraversableProperty, hoverProperty, idProperty, impl_showMnemonicsProperty, impl_treeVisibleProperty, inputMethodRequestsProperty, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParentTransformProperty, localToSceneTransformProperty, managedProperty, mouseTransparentProperty, nodeOrientationProperty, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, pickOnBoundsProperty, pressedProperty, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, styleProperty, translateXProperty, translateYProperty, translateZProperty, visibleProperty

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`MonthSheetView.BadgeDateCell` The badge date cell extends the `MonthSheetView.SimpleDateCell` and adds another label to it that is used to display a counter of the number of entries that exist on that date.
`static class`	`MonthSheetView.ClickBehaviour` An enumerator to control the behaviour of the control when the user clicks on a date.
`static class`	`MonthSheetView.DateCell` The base class for all date cells that are used in combination with the `MonthSheetView`.
`static class`	`MonthSheetView.DateParameter` A parameter object used by the cell factory of the month sheet view.
`static class`	`MonthSheetView.DetailedDateCell` A specialization of the `MonthSheetView.SimpleDateCell` that adds a small canvas on the right-hand side to visualize the utilization of the day (the entries that exist on that date).
`static class`	`MonthSheetView.HeaderParameter` A parameter object used by the "header" cell factory of the month sheet view.
`static class`	`MonthSheetView.MonthHeaderCell` The default cell used for month headers.
`static class`	`MonthSheetView.SimpleDateCell` A date cell used to display the day of month, the day of week, and the week of year in three separate labels.
`static class`	`MonthSheetView.UsageDateCell` A specialization of the `MonthSheetView.SimpleDateCell` that adds utilization information to the cell by coloring its background differently based on the number of entries found on that day.
`static class`	`MonthSheetView.ViewUnit` A view unit describes how many months the view should show.
`static class`	`MonthSheetView.WeekDayLayoutStrategy` The different ways the view can align date cells.

Nested classes/interfaces inherited from class com.calendarfx.view.DateControl
DateControl.ContextMenuParameter, DateControl.CreateCalendarSourceParameter, DateControl.CreateEntryParameter, DateControl.DateDetailsParameter, DateControl.EntryContextMenuParameter, DateControl.EntryDetailsParameter, DateControl.EntryDetailsPopOverContentParameter, DateControl.Layout, DateControl.Usage

Field Summary
- Fields inherited from class com.calendarfx.view.DateControl
  usagePolicy
- Fields inherited from class javafx.scene.layout.Region
  USE_COMPUTED_SIZE, USE_PREF_SIZE
- Fields inherited from class javafx.scene.Node
  BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

Constructors
Constructor and Description

MonthSheetView()
Constructs a new month sheet view that is using the MonthSheetView.SimpleDateCell.

Constructors
Constructor and Description
`MonthSheetView()` Constructs a new month sheet view that is using the `MonthSheetView.SimpleDateCell`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ObjectProperty<Callback<MonthSheetView.DateParameter,MonthSheetView.DateCell>>`	`cellFactoryProperty()` A property used to store a reference to the cell factory for this view.
`ObjectProperty<MonthSheetView.ClickBehaviour>`	`clickBehaviourProperty()` The behaviour used when the user clicks on a date.
`protected Skin<?>`	`createDefaultSkin()`
`ObjectProperty<DateSelectionModel>`	`dateSelectionModelProperty()` A property used to store a selection model for selecting dates.
`IntegerProperty`	`extendedUnitsBackwardProperty()` An integer property that stores the number of units that will be used to extend the view by.
`IntegerProperty`	`extendedUnitsForwardProperty()` An integer property that stores the number of units that will be used to extend the view by.
`ObjectProperty<MonthSheetView.ViewUnit>`	`extendedViewUnitProperty()` A property used to store the unit shown by the view in front of or after the main columns (e.g.
`Callback<MonthSheetView.DateParameter,MonthSheetView.DateCell>`	`getCellFactory()` Returns the value of `cellFactoryProperty()`.
`MonthSheetView.ClickBehaviour`	`getClickBehaviour()` Returns the value of `clickBehaviourProperty()`.
`DateSelectionModel`	`getDateSelectionModel()` Returns the value of `dateSelectionModelProperty()`.
`YearMonth`	`getEndMonth()` Returns the first "regular" month shown by the view.
`YearMonth`	`getExtendedEndMonth()` Returns the last month shown by the view.
`YearMonth`	`getExtendedStartMonth()` Returns the first month shown by the view.
`int`	`getExtendedUnitsBackward()` Returns the value of `extendedUnitsBackwardProperty()`.
`int`	`getExtendedUnitsForward()` Returns the value of `extendedUnitsForward`.
`MonthSheetView.ViewUnit`	`getExtendedViewUnit()` Returns the value of `extendedViewUnitProperty()`.
`Callback<MonthSheetView.HeaderParameter,Node>`	`getHeaderCellFactory()` Returns the value of `headerCellFactoryProperty()`.
`ObservableList<org.controlsfx.control.PropertySheet.Item>`	`getPropertySheetItems()` Returns a list of property items that can be shown by the `PropertySheet` of ControlsFX.
`YearMonth`	`getStartMonth()` Returns the first "regular" month shown by the view.
`MonthSheetView.ViewUnit`	`getViewUnit()` Returns the value of `viewUnitProperty()`.
`MonthSheetView.WeekDayLayoutStrategy`	`getWeekDayLayout()` Returns the value of `weekDayLayoutProperty()`.
`ObjectProperty<Callback<MonthSheetView.HeaderParameter,Node>>`	`headerCellFactoryProperty()` A property used to store a reference to the "header" cell factory for this view.
`boolean`	`isExtendedMonth(YearMonth month)` A simple check to see if the given month is part of the extended months.
`boolean`	`isShowWeekNumber()` Returns the value of `showWeekNumberProperty()`.
`boolean`	`isVisibleDate(LocalDate date)` Determines if the given date is currently showing is part of the view.
`void`	`setCellFactory(Callback<MonthSheetView.DateParameter,MonthSheetView.DateCell> factory)` Sets the value of `cellFactoryProperty()`.
`void`	`setClickBehaviour(MonthSheetView.ClickBehaviour behaviour)` Sets the value of `clickBehaviourProperty()`.
`void`	`setDateSelectionModel(DateSelectionModel model)` Sets the value of `dateSelectionModelProperty()`.
`void`	`setExtendedUnitsBackward(int units)` Sets the value of `extendedUnitsBackwardProperty()`.
`void`	`setExtendedUnitsForward(int units)` Sets the value of `extendedUnitsForward`.
`void`	`setExtendedViewUnit(MonthSheetView.ViewUnit unit)` Sets the value of `extendedViewUnitProperty()`.
`void`	`setHeaderCellFactory(Callback<MonthSheetView.HeaderParameter,Node> factory)` Sets the value of `headerCellFactoryProperty()`.
`void`	`setShowWeekNumber(boolean show)` Sets the value of `showWeekNumberProperty()`.
`void`	`setViewUnit(MonthSheetView.ViewUnit unit)` Sets the value of `viewUnitProperty()`.
`void`	`setWeekDayLayout(MonthSheetView.WeekDayLayoutStrategy weekDayLayout)` Sets the value of `weekDayLayoutProperty()`.
`BooleanProperty`	`showWeekNumberProperty()` A property used to control whether the week numbers should be shown.
`ObjectProperty<MonthSheetView.ViewUnit>`	`viewUnitProperty()` A property used to store the unit shown by the view (e.g.
`ObjectProperty<MonthSheetView.WeekDayLayoutStrategy>`	`weekDayLayoutProperty()` A property used to store the layout strategy used by this view.

Methods inherited from class com.calendarfx.view.DateControl
bind, calendarSourceFactoryProperty, calendarsProperty, clearSelection, contextMenuCallbackProperty, createCalendarSource, createEntryAt, createEntryAt, dateDetailsCallbackProperty, dateProperty, defaultCalendarProviderProperty, deselect, draggedEntryProperty, editEntry, enableHyperlinksProperty, endTimeProperty, entryContextMenuCallbackProperty, entryDetailsCallbackProperty, entryDetailsPopOverContentCallbackProperty, entryFactoryProperty, findEntryView, getBoundDateControls, getCalendarAt, getCalendars, getCalendarSourceFactory, getCalendarSources, getCalendarVisibilityMap, getCalendarVisibilityProperty, getContextMenuCallback, getDate, getDateDetailsCallback, getDefaultCalendarProvider, getDraggedEntry, getEndTime, getEntryContextMenuCallback, getEntryDetailsCallback, getEntryDetailsPopOverContentCallback, getEntryFactory, getFirstDayOfWeek, getLayout, getRequestedTime, getSelectionMode, getSelections, getStartTime, getTime, getToday, getUsagePolicy, getVirtualGrid, getWeekendDays, getWeekFields, getZoneId, goBack, goForward, goToday, isCalendarVisible, isEnableHyperlinks, isShowToday, isSuspendUpdates, layoutProperty, refreshData, requestedTimeProperty, select, selectionModeProperty, setCalendarSourceFactory, setCalendarVisibility, setContextMenuCallback, setDate, setDateDetailsCallback, setDefaultCalendarProvider, setDraggedEntry, setEnableHyperlinks, setEndTime, setEntryContextMenuCallback, setEntryDetailsCallback, setEntryDetailsPopOverContentCallback, setEntryFactory, setLayout, setRequestedTime, setSelectionMode, setShowToday, setStartTime, setSuspendUpdates, setTime, setToday, setUsagePolicy, setVirtualGrid, setWeekFields, setZoneId, showDateDetails, showEntry, showTodayProperty, startTimeProperty, suspendUpdatesProperty, timeProperty, todayProperty, unbind, usagePolicyProperty, virtualGridProperty, weekFieldsProperty, zoneIdProperty

Methods inherited from class com.calendarfx.view.CalendarFXControl
getUserAgentStylesheet

Methods inherited from class javafx.scene.layout.Region
backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getWidth, heightProperty, impl_computeContains, impl_computeGeomBounds, impl_computeLayoutBounds, impl_createPeer, impl_notifyLayoutBoundsChanged, impl_pickNodeLocal, impl_updatePeer, insetsProperty, isCacheShape, isCenterShape, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapSize, snapSpace, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent
getChildren, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_getAllParentStylesheets, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setImpl_traversalEngine, setNeedsLayout, updateBounds

Methods inherited from class javafx.scene.Node
accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, containsBounds, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_cssGetCursorInitialValue, impl_findStyles, impl_geomChanged, impl_getLeafTransform, impl_getMatchingStyles, impl_getPeer, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_intersectsBounds, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_markDirty, impl_pickNode, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPeer, impl_transformsChanged, impl_traverse, impl_treeVisibleProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Property Detail
  - cellFactory
```
public final ObjectProperty<Callback<MonthSheetView.DateParameter,MonthSheetView.DateCell>> cellFactoryProperty
```
    A property used to store a reference to the cell factory for this view. The default cell factory simply returns an instance of type MonthSheetView.SimpleDateCell.
    
    See Also:
    
    getCellFactory(), setCellFactory(Callback)
  - headerCellFactory
```
public final ObjectProperty<Callback<MonthSheetView.HeaderParameter,Node>> headerCellFactoryProperty
```
    A property used to store a reference to the "header" cell factory for this view. The default cell factory simply returns an instance of type MonthSheetView.MonthHeaderCell.
    
    See Also:
    
    getHeaderCellFactory(), setHeaderCellFactory(Callback)
  - weekDayLayout
```
public final ObjectProperty<MonthSheetView.WeekDayLayoutStrategy> weekDayLayoutProperty
```
    A property used to store the layout strategy used by this view. The month sheet view is capable of ensuring that the date cells next to each other always show the same weekday. For this extra empty cells are added at the top of some of the columns. However, the standard layout is to always show the first day of the month in the first cell from the top.
    
    See Also:
    
    getWeekDayLayout(), setWeekDayLayout(WeekDayLayoutStrategy)
  - viewUnit
```
public final ObjectProperty<MonthSheetView.ViewUnit> viewUnitProperty
```
    A property used to store the unit shown by the view (e.g. "quarters", "year", "month").
    
    See Also:
    
    getViewUnit(), setViewUnit(ViewUnit)
  - extendedViewUnit
```
public final ObjectProperty<MonthSheetView.ViewUnit> extendedViewUnitProperty
```
    A property used to store the unit shown by the view in front of or after the main columns (e.g. "quarters", "year", "month"). So a month showing twelve months of a year might decide to add some "padding" and show another month in front of the year and one month after the year.
    
    See Also:
    
    getExtendedViewUnit(), setExtendedViewUnit(ViewUnit)
  - extendedUnitsForward
```
public final IntegerProperty extendedUnitsForwardProperty
```
    An integer property that stores the number of units that will be used to extend the view by. A month showing twelve months of a year might decide to add some "padding" and show another month at the end of the year. In this case the number of extended units will be 1.
    
    See Also:
    
    getExtendedUnitsForward(), setExtendedUnitsForward(int)
  - extendedUnitsBackward
```
public final IntegerProperty extendedUnitsBackwardProperty
```
    An integer property that stores the number of units that will be used to extend the view by. A month showing twelve months of a year might decide to put some "padding" in front of the year and show another month. In this case the number of extended units will be 1.
    
    See Also:
    
    getExtendedUnitsBackward(), setExtendedUnitsBackward(int)
  - showWeekNumber
```
public final BooleanProperty showWeekNumberProperty
```
    A property used to control whether the week numbers should be shown.
    
    See Also:
    
    isShowWeekNumber(), setShowWeekNumber(boolean)
  - dateSelectionModel
```
public final ObjectProperty<DateSelectionModel> dateSelectionModelProperty
```
    A property used to store a selection model for selecting dates.
    
    See Also:
    
    getDateSelectionModel(), setDateSelectionModel(DateSelectionModel)
  - clickBehaviour
```
public final ObjectProperty<MonthSheetView.ClickBehaviour> clickBehaviourProperty
```
    The behaviour used when the user clicks on a date.
    
    See Also:
    
    getClickBehaviour(), setClickBehaviour(ClickBehaviour)
- Constructor Detail
  - MonthSheetView
```
public MonthSheetView()
```
    Constructs a new month sheet view that is using the MonthSheetView.SimpleDateCell.
- Method Detail
  - createDefaultSkin
```
protected Skin<?> createDefaultSkin()
```
    Overrides:
    
    createDefaultSkin in class Control
  - cellFactoryProperty
```
public final ObjectProperty<Callback<MonthSheetView.DateParameter,MonthSheetView.DateCell>> cellFactoryProperty()
```
    A property used to store a reference to the cell factory for this view. The default cell factory simply returns an instance of type MonthSheetView.SimpleDateCell.
    
    See Also:
    
    getCellFactory(), setCellFactory(Callback)
  - getCellFactory
```
public final Callback<MonthSheetView.DateParameter,MonthSheetView.DateCell> getCellFactory()
```
    Returns the value of cellFactoryProperty().
    
    Returns:
    
    the cell factory
  - setCellFactory
```
public final void setCellFactory(Callback<MonthSheetView.DateParameter,MonthSheetView.DateCell> factory)
```
    Sets the value of cellFactoryProperty().
    
    Parameters:
    
    factory - the cell factory
  - headerCellFactoryProperty
```
public final ObjectProperty<Callback<MonthSheetView.HeaderParameter,Node>> headerCellFactoryProperty()
```
    A property used to store a reference to the "header" cell factory for this view. The default cell factory simply returns an instance of type MonthSheetView.MonthHeaderCell.
    
    See Also:
    
    getHeaderCellFactory(), setHeaderCellFactory(Callback)
  - getHeaderCellFactory
```
public final Callback<MonthSheetView.HeaderParameter,Node> getHeaderCellFactory()
```
    Returns the value of headerCellFactoryProperty().
    
    Returns:
    
    the "header" cell factory
  - setHeaderCellFactory
```
public final void setHeaderCellFactory(Callback<MonthSheetView.HeaderParameter,Node> factory)
```
    Sets the value of headerCellFactoryProperty().
    
    Parameters:
    
    factory - the "header" cell factory
  - weekDayLayoutProperty
```
public final ObjectProperty<MonthSheetView.WeekDayLayoutStrategy> weekDayLayoutProperty()
```
    A property used to store the layout strategy used by this view. The month sheet view is capable of ensuring that the date cells next to each other always show the same weekday. For this extra empty cells are added at the top of some of the columns. However, the standard layout is to always show the first day of the month in the first cell from the top.
    
    See Also:
    
    getWeekDayLayout(), setWeekDayLayout(WeekDayLayoutStrategy)
  - getWeekDayLayout
```
public final MonthSheetView.WeekDayLayoutStrategy getWeekDayLayout()
```
    Returns the value of weekDayLayoutProperty().
    
    Returns:
    
    the weekday layout strategy
  - setWeekDayLayout
```
public final void setWeekDayLayout(MonthSheetView.WeekDayLayoutStrategy weekDayLayout)
```
    Sets the value of weekDayLayoutProperty().
    
    Parameters:
    
    weekDayLayout - the weekday layout strategy
  - viewUnitProperty
```
public final ObjectProperty<MonthSheetView.ViewUnit> viewUnitProperty()
```
    A property used to store the unit shown by the view (e.g. "quarters", "year", "month").
    
    See Also:
    
    getViewUnit(), setViewUnit(ViewUnit)
  - getViewUnit
```
public final MonthSheetView.ViewUnit getViewUnit()
```
    Returns the value of viewUnitProperty().
    
    Returns:
    
    the view unit (e.g. "quarters", "year", "month")
  - setViewUnit
```
public final void setViewUnit(MonthSheetView.ViewUnit unit)
```
    Sets the value of viewUnitProperty().
    
    Parameters:
    
    unit - the view unit (e.g. "quarters", "year", "month")
  - extendedViewUnitProperty
```
public final ObjectProperty<MonthSheetView.ViewUnit> extendedViewUnitProperty()
```
    A property used to store the unit shown by the view in front of or after the main columns (e.g. "quarters", "year", "month"). So a month showing twelve months of a year might decide to add some "padding" and show another month in front of the year and one month after the year.
    
    See Also:
    
    getExtendedViewUnit(), setExtendedViewUnit(ViewUnit)
  - getExtendedViewUnit
```
public final MonthSheetView.ViewUnit getExtendedViewUnit()
```
    Returns the value of extendedViewUnitProperty().
    
    Returns:
    
    the extended view unit (e.g. "quarters", "year", "month")
  - setExtendedViewUnit
```
public final void setExtendedViewUnit(MonthSheetView.ViewUnit unit)
```
    Sets the value of extendedViewUnitProperty().
    
    Parameters:
    
    unit - the extended view unit (e.g. "quarters", "year", "month")
  - extendedUnitsForwardProperty
```
public final IntegerProperty extendedUnitsForwardProperty()
```
    An integer property that stores the number of units that will be used to extend the view by. A month showing twelve months of a year might decide to add some "padding" and show another month at the end of the year. In this case the number of extended units will be 1.
    
    See Also:
    
    getExtendedUnitsForward(), setExtendedUnitsForward(int)
  - getExtendedUnitsForward
```
public final int getExtendedUnitsForward()
```
    Returns the value of extendedUnitsForward.
    
    Returns:
    
    the number of units shown at the end of the view
  - setExtendedUnitsForward
```
public final void setExtendedUnitsForward(int units)
```
    Sets the value of extendedUnitsForward.
    
    Parameters:
    
    units - the number of units shown at the end of the view
  - extendedUnitsBackwardProperty
```
public final IntegerProperty extendedUnitsBackwardProperty()
```
    An integer property that stores the number of units that will be used to extend the view by. A month showing twelve months of a year might decide to put some "padding" in front of the year and show another month. In this case the number of extended units will be 1.
    
    See Also:
    
    getExtendedUnitsBackward(), setExtendedUnitsBackward(int)
  - getExtendedUnitsBackward
```
public final int getExtendedUnitsBackward()
```
    Returns the value of extendedUnitsBackwardProperty().
    
    Returns:
    
    the number of units shown at the beginning of the view
  - setExtendedUnitsBackward
```
public final void setExtendedUnitsBackward(int units)
```
    Sets the value of extendedUnitsBackwardProperty().
    
    Parameters:
    
    units - the number of units shown at the beginning of the view
  - getStartMonth
```
public final YearMonth getStartMonth()
```
    Returns the first "regular" month shown by the view. This method does not consider the extended months. If the view shows a whole year then the start month will be January.
    
    Returns:
    
    the start month
  - getEndMonth
```
public final YearMonth getEndMonth()
```
    Returns the first "regular" month shown by the view. This method does not consider the extended months. If the view shows a whole year then the end month will be December.
    
    Returns:
    
    the start month
  - getExtendedStartMonth
```
public final YearMonth getExtendedStartMonth()
```
    Returns the first month shown by the view. This method also takes the extended months into account. If the view shows a whole year with an extended unit of "month" and and extended unit count of two, then the start month will be November of the previous year.
    
    Returns:
    
    the start month
    
    See Also:
    
    setExtendedViewUnit(ViewUnit), setExtendedUnitsBackward(int), setExtendedUnitsForward(int)
  - getExtendedEndMonth
```
public final YearMonth getExtendedEndMonth()
```
    Returns the last month shown by the view. This method also takes the extended months into account. If the view shows a whole year with an extended unit of "month" and and extended unit count of two, then the end month will be February of the next year.
    
    Returns:
    
    the start month
    
    See Also:
    
    setExtendedViewUnit(ViewUnit), setExtendedUnitsBackward(int), setExtendedUnitsForward(int)
  - isExtendedMonth
```
public final boolean isExtendedMonth(YearMonth month)
```
    A simple check to see if the given month is part of the extended months.
    
    Parameters:
    
    month - the month to check
    
    Returns:
    
    true if the given month is part of the extended months
    
    See Also:
    
    setExtendedViewUnit(ViewUnit), setExtendedUnitsBackward(int), setExtendedUnitsForward(int)
  - isVisibleDate
```
public final boolean isVisibleDate(LocalDate date)
```
    Determines if the given date is currently showing is part of the view. This method uses the extended start and end months.
    
    Parameters:
    
    date - the date to check for visibility
    
    Returns:
    
    true if the date is within the time range of the view
    
    See Also:
    
    getExtendedStartMonth(), getExtendedEndMonth()
  - showWeekNumberProperty
```
public final BooleanProperty showWeekNumberProperty()
```
    A property used to control whether the week numbers should be shown.
    
    See Also:
    
    isShowWeekNumber(), setShowWeekNumber(boolean)
  - isShowWeekNumber
```
public final boolean isShowWeekNumber()
```
    Returns the value of showWeekNumberProperty().
    
    Returns:
    
    true if the numbers should be shown
  - setShowWeekNumber
```
public final void setShowWeekNumber(boolean show)
```
    Sets the value of showWeekNumberProperty().
    
    Parameters:
    
    show - true if the numbers should be shown
  - dateSelectionModelProperty
```
public final ObjectProperty<DateSelectionModel> dateSelectionModelProperty()
```
    A property used to store a selection model for selecting dates.
    
    See Also:
    
    getDateSelectionModel(), setDateSelectionModel(DateSelectionModel)
  - getDateSelectionModel
```
public final DateSelectionModel getDateSelectionModel()
```
    Returns the value of dateSelectionModelProperty().
    
    Returns:
    
    the date selection model
  - setDateSelectionModel
```
public final void setDateSelectionModel(DateSelectionModel model)
```
    Sets the value of dateSelectionModelProperty().
    
    Parameters:
    
    model - the date selection model
  - clickBehaviourProperty
```
public final ObjectProperty<MonthSheetView.ClickBehaviour> clickBehaviourProperty()
```
    The behaviour used when the user clicks on a date.
    
    See Also:
    
    getClickBehaviour(), setClickBehaviour(ClickBehaviour)
  - setClickBehaviour
```
public final void setClickBehaviour(MonthSheetView.ClickBehaviour behaviour)
```
    Sets the value of clickBehaviourProperty().
    
    Parameters:
    
    behaviour - the click behaviour
  - getClickBehaviour
```
public final MonthSheetView.ClickBehaviour getClickBehaviour()
```
    Returns the value of clickBehaviourProperty().
    
    Returns:
    
    the click behaviour
  - getPropertySheetItems
```
public ObservableList<org.controlsfx.control.PropertySheet.Item> getPropertySheetItems()
```
    Description copied from class: CalendarFXControl
    
    Returns a list of property items that can be shown by the PropertySheet of ControlsFX.
    
    Overrides:
    
    getPropertySheetItems in class DateControl
    
    Returns:
    
    the property sheet items

Class MonthSheetView

Screenshot (Using DetailedDateCell)

Screenshot (Using "aligned" weekday layout)

Property Summary

Properties inherited from class com.calendarfx.view.DateControl

Properties inherited from class javafx.scene.control.Control

Properties inherited from class javafx.scene.layout.Region

Properties inherited from class javafx.scene.Parent

Properties inherited from class javafx.scene.Node

Nested Class Summary

Nested classes/interfaces inherited from class com.calendarfx.view.DateControl

Field Summary

Fields inherited from class com.calendarfx.view.DateControl

Fields inherited from class javafx.scene.layout.Region

Fields inherited from class javafx.scene.Node

Constructor Summary

Method Summary

Methods inherited from class com.calendarfx.view.DateControl

Methods inherited from class com.calendarfx.view.CalendarFXControl

Methods inherited from class javafx.scene.control.Control

Methods inherited from class javafx.scene.layout.Region

Methods inherited from class javafx.scene.Parent

Methods inherited from class javafx.scene.Node

Methods inherited from class java.lang.Object

Property Detail

cellFactory

headerCellFactory

weekDayLayout

viewUnit

extendedViewUnit

extendedUnitsForward

extendedUnitsBackward

showWeekNumber

dateSelectionModel

clickBehaviour

Constructor Detail

MonthSheetView

Method Detail

createDefaultSkin

cellFactoryProperty

getCellFactory

setCellFactory

headerCellFactoryProperty

getHeaderCellFactory

setHeaderCellFactory

weekDayLayoutProperty

getWeekDayLayout

setWeekDayLayout

viewUnitProperty

getViewUnit

setViewUnit

extendedViewUnitProperty

getExtendedViewUnit

setExtendedViewUnit

extendedUnitsForwardProperty

getExtendedUnitsForward

setExtendedUnitsForward

extendedUnitsBackwardProperty

getExtendedUnitsBackward

setExtendedUnitsBackward

getStartMonth

getEndMonth

getExtendedStartMonth

getExtendedEndMonth

isExtendedMonth

isVisibleDate

showWeekNumberProperty

isShowWeekNumber

setShowWeekNumber

dateSelectionModelProperty

getDateSelectionModel

setDateSelectionModel

clickBehaviourProperty

setClickBehaviour

getClickBehaviour

getPropertySheetItems