Module com.dlsc.gemsfx
Package com.dlsc.gemsfx

Class CalendarView

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.control.Control
com.dlsc.gemsfx.CalendarView
All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable
public class CalendarView extends javafx.scene.control.Control
Displays a given month of a given year. The view can be configured in many ways:
  • Show / hide the name of the month
  • Show / hide the year
  • Show / hide arrow buttons for changing the month
  • Show / hide arrow buttons for changing the year
  • Show / hide today
  • Show / hide a button for going to today
  • Show / hide usage colors
Additionally the application can choose from two different behaviours when the user clicks on a date:
  1. Perform a selection / select the date
  2. Show details of the date (by default shows a popover with all entries on that date)
The image below shows the visual appearance of this control: Date Picker

  • Property Summary

    Properties
    Type
    Property
    Description
    final javafx.beans.property.ObjectProperty<javafx.util.Callback<CalendarView,CalendarView.DateCell>>
    cellFactory
    A factory for creating alternative content for the month view.
    final javafx.beans.property.ObjectProperty<javafx.util.Callback<LocalDate,Boolean>>
    dateFilter
    A property to define a filter for determining which dates in the calendar can be selected.
    final javafx.beans.property.BooleanProperty
    disableMonthDropdownButton
    A property to control whether the "show month view" button will be disabled or not.
    final javafx.beans.property.BooleanProperty
    disableNextMonthButton
    A property to control whether the "show next month" button will be disabled or not.
    final javafx.beans.property.BooleanProperty
    disableNextYearButton
    A property to control whether the "show next year" button will be disabled or not.
    final javafx.beans.property.BooleanProperty
    disablePreviousMonthButton
    A property to control whether the "show previous month" button will be disabled or not.
    final javafx.beans.property.BooleanProperty
    disablePreviousYearButton
    A property to control whether the "show previous year" button will be disabled or not.
    final javafx.beans.property.BooleanProperty
    disableYearDropdownButton
    A property to control whether the "show year view" button will be disabled or not.
    final javafx.beans.property.ObjectProperty<LocalDate>
    earliestDate
    The earliest day that can be selected in the view.
    final javafx.beans.property.ObjectProperty<CalendarView.HeaderLayout>
    headerLayout
    The header layout value determines how the information and the navigation elements in the header will be laid out.
    final javafx.beans.property.ObjectProperty<LocalDate>
    latestDate
    The latest day that can be selected in the view.
    final javafx.beans.property.BooleanProperty
    markSelectedDaysOfPreviousOrNextMonth
    Determines whether selected dates will be marked as such when they are being displayed at the beginning of the next month or at the end of the previous month.
    final javafx.beans.property.ObjectProperty<CalendarView.MonthDisplayMode>
    monthDisplayMode
    The display mode for the month label at the top of the calendar view.
    final javafx.beans.property.BooleanProperty
    monthSelectionViewEnabled
    Determines whether the control offers the option to the user to pick a different month directly via a designated month selection view.
    final javafx.beans.property.ObjectProperty<CalendarView.SelectionModel>
    selectionModel
     
    final javafx.beans.property.BooleanProperty
    showDaysOfPreviousOrNextMonth
    By default, the calendar for a given month might also show some days of the previous and the next month.
    final javafx.beans.property.BooleanProperty
    showMonthArrows
    Shows or hides the arrows to change the month.
    final javafx.beans.property.BooleanProperty
    showMonth
    Returns the BooleanProperty that controls the visibility of the month display in the header.
    final javafx.beans.property.BooleanProperty
    showTodayButton
    Show or hide a button to quickly go to today's date.
    final javafx.beans.property.BooleanProperty
    showToday
    A flag used to indicate that the view will mark the area that represents the value of todayProperty().
    final javafx.beans.property.BooleanProperty
    showWeekNumbers
    Controls whether the view will show week numbers.
    final javafx.beans.property.BooleanProperty
    showYear
    Show or hide the year in the header.
    final javafx.beans.property.ObjectProperty<LocalDate>
    today
    Stores the date that is considered to represent "today".
    final javafx.beans.property.StringProperty
    todayText
    The text that will be shown on the button used for going to today's date.
    final javafx.beans.property.DoubleProperty
    weekNumberColumnWidth
     
    final javafx.beans.property.ObjectProperty<CalendarView.YearDisplayMode>
    yearDisplayMode
    The display mode for the year label at the top of the calendar view.
    final javafx.beans.property.ObjectProperty<YearMonth>
    yearMonth
    Stores the year and month shown by the control.
    final javafx.beans.property.BooleanProperty
    yearSelectionViewEnabled
    Determines whether the control offers the option to the user to pick a different year directly via a designated year selection view.

    Properties inherited from class javafx.scene.control.Control

    contextMenu, skin, tooltip

    Properties inherited from class javafx.scene.layout.Region

    background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width

    Properties inherited from class javafx.scene.Parent

    needsLayout

    Properties inherited from class javafx.scene.Node

    accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, focusVisible, focusWithin, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, viewOrder, visible

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    CalendarView.DateCell
    The base date cell implementation for month views.
    static enum 
    CalendarView.HeaderLayout
    Different layouts that can be used to position the month, the year, and the various navigation elements in the header of the view.
    static enum 
    CalendarView.MonthDisplayMode
    Enumerates the display modes for the month label at the top of the calendar view.
    static class 
    CalendarView.SelectionModel
     
    static enum 
    CalendarView.YearDisplayMode
    Enumerates the display modes for the year label at the top of the calendar view.

  • Field Summary

    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
    Description
    CalendarView()
    Constructs a new view.

  • Method Summary

    Modifier and Type
    Method
    Description
    final javafx.beans.property.ObjectProperty<javafx.util.Callback<CalendarView,CalendarView.DateCell>>
    cellFactoryProperty()
    A factory for creating alternative content for the month view.
    protected javafx.scene.control.Skin<?>
    createDefaultSkin()
     
    final javafx.beans.property.ObjectProperty<javafx.util.Callback<LocalDate,Boolean>>
    dateFilterProperty()
    A property to define a filter for determining which dates in the calendar can be selected.
    final javafx.beans.property.BooleanProperty
    disableMonthDropdownButtonProperty()
    A property to control whether the "show month view" button will be disabled or not.
    final javafx.beans.property.BooleanProperty
    disableNextMonthButtonProperty()
    A property to control whether the "show next month" button will be disabled or not.
    final javafx.beans.property.BooleanProperty
    disableNextYearButtonProperty()
    A property to control whether the "show next year" button will be disabled or not.
    final javafx.beans.property.BooleanProperty
    disablePreviousMonthButtonProperty()
    A property to control whether the "show previous month" button will be disabled or not.
    final javafx.beans.property.BooleanProperty
    disablePreviousYearButtonProperty()
    A property to control whether the "show previous year" button will be disabled or not.
    final javafx.beans.property.BooleanProperty
    disableYearDropdownButtonProperty()
    A property to control whether the "show year view" button will be disabled or not.
    final javafx.beans.property.ObjectProperty<LocalDate>
    earliestDateProperty()
    The earliest day that can be selected in the view.
    final javafx.util.Callback<CalendarView,CalendarView.DateCell>
    getCellFactory()
    Returns the value of cellFactoryProperty().
    static List<javafx.css.CssMetaData<? extends javafx.css.Styleable,?>>
    getClassCssMetaData()
     
    List<javafx.css.CssMetaData<? extends javafx.css.Styleable,?>>
    getControlCssMetaData()
     
    final javafx.util.Callback<LocalDate,Boolean>
    getDateFilter()
    Gets the value of the property dateFilter.
    final LocalDate
    getEarliestDate()
    Gets the value of the property earliestDate.
    final CalendarView.HeaderLayout
    getHeaderLayout()
    Gets the value of the property headerLayout.
    final LocalDate
    getLatestDate()
    Gets the value of the property latestDate.
    final CalendarView.MonthDisplayMode
    getMonthDisplayMode()
    Gets the value of the property monthDisplayMode.
    final CalendarView.SelectionModel
    getSelectionModel()
    Gets the value of the property selectionModel.
    final LocalDate
    getToday()
    Returns the value of todayProperty().
    final String
    getTodayText()
    Gets the value of the property todayText.
    String
    getUserAgentStylesheet()
     
    javafx.collections.ObservableSet<DayOfWeek>
    getWeekendDays()
    Returns the days of the week that are considered to be weekend days, for example Saturday and Sunday, or Friday and Saturday.
    final double
    getWeekNumberColumnWidth()
    Gets the value of the property weekNumberColumnWidth.
    final CalendarView.YearDisplayMode
    getYearDisplayMode()
    Gets the value of the property yearDisplayMode.
    final YearMonth
    getYearMonth()
    Returns the value of yearMonthProperty().
    YearMonthView
    getYearMonthView()
    Returns the view used to display a month selection to the user.
    YearView
    getYearView()
    Returns the view used to display a year selection to the user.
    final javafx.beans.property.ObjectProperty<CalendarView.HeaderLayout>
    headerLayoutProperty()
    The header layout value determines how the information and the navigation elements in the header will be laid out.
    final boolean
    isDisableMonthDropdownButton()
    Gets the value of the property disableMonthDropdownButton.
    final boolean
    isDisableNextMonthButton()
    Gets the value of the property disableNextMonthButton.
    final boolean
    isDisableNextYearButton()
    Gets the value of the property disableNextYearButton.
    final boolean
    isDisablePreviousMonthButton()
    Gets the value of the property disablePreviousMonthButton.
    final boolean
    isDisablePreviousYearButton()
    Gets the value of the property disablePreviousYearButton.
    final boolean
    isDisableYearDropdownButton()
    Gets the value of the property disableYearDropdownButton.
    final boolean
    isMarkSelectedDaysOfPreviousOrNextMonth()
    Gets the value of the property markSelectedDaysOfPreviousOrNextMonth.
    final boolean
    isMonthSelectionViewEnabled()
    Gets the value of the property monthSelectionViewEnabled.
    final boolean
    isShowDaysOfPreviousOrNextMonth()
    Gets the value of the property showDaysOfPreviousOrNextMonth.
    final boolean
    isShowMonth()
    Gets the value of the property showMonth.
    final boolean
    isShowMonthArrows()
    Returns the value of the showMonthArrowsProperty().
    final boolean
    isShowToday()
    Returns the value of showTodayProperty().
    final boolean
    isShowTodayButton()
    Returns the value of the showTodayButtonProperty().
    final boolean
    isShowWeekNumbers()
    Returns the value of showWeekNumbersProperty().
    final boolean
    isShowYear()
    Gets the value of the property showYear.
    final boolean
    isYearSelectionViewEnabled()
    Gets the value of the property yearSelectionViewEnabled.
    final javafx.beans.property.ObjectProperty<LocalDate>
    latestDateProperty()
    The latest day that can be selected in the view.
    final javafx.beans.property.BooleanProperty
    markSelectedDaysOfPreviousOrNextMonthProperty()
    Determines whether selected dates will be marked as such when they are being displayed at the beginning of the next month or at the end of the previous month.
    final javafx.beans.property.ObjectProperty<CalendarView.MonthDisplayMode>
    monthDisplayModeProperty()
    The display mode for the month label at the top of the calendar view.
    final javafx.beans.property.BooleanProperty
    monthSelectionViewEnabledProperty()
    Determines whether the control offers the option to the user to pick a different month directly via a designated month selection view.
    final javafx.beans.property.ObjectProperty<CalendarView.SelectionModel>
    selectionModelProperty()
     
    final void
    setCellFactory(javafx.util.Callback<CalendarView,CalendarView.DateCell> factory)
    Sets the value of cellFactoryProperty().
    final void
    setDateFilter(javafx.util.Callback<LocalDate,Boolean> dateFilter)
    Sets the value of the property dateFilter.
    final void
    setDisableMonthDropdownButton(boolean disableMonthDropdownButton)
    Sets the value of the property disableMonthDropdownButton.
    final void
    setDisableNextMonthButton(boolean disableNextMonthButton)
    Sets the value of the property disableNextMonthButton.
    final void
    setDisableNextYearButton(boolean disableNextYearButton)
    Sets the value of the property disableNextYearButton.
    final void
    setDisablePreviousMonthButton(boolean disablePreviousMonthButton)
    Sets the value of the property disablePreviousMonthButton.
    final void
    setDisablePreviousYearButton(boolean disablePreviousYearButton)
    Sets the value of the property disablePreviousYearButton.
    final void
    setDisableYearDropdownButton(boolean disableYearDropdownButton)
    Sets the value of the property disableYearDropdownButton.
    final void
    setEarliestDate(LocalDate earliestDate)
    Sets the value of the property earliestDate.
    final void
    setHeaderLayout(CalendarView.HeaderLayout headerLayout)
    Sets the value of the property headerLayout.
    final void
    setLatestDate(LocalDate latestDate)
    Sets the value of the property latestDate.
    final void
    setMarkSelectedDaysOfPreviousOrNextMonth(boolean markSelectedDaysOfPreviousOrNextMonth)
    Sets the value of the property markSelectedDaysOfPreviousOrNextMonth.
    final void
    setMonthDisplayMode(CalendarView.MonthDisplayMode monthDisplayMode)
    Sets the value of the property monthDisplayMode.
    final void
    setMonthSelectionViewEnabled(boolean monthSelectionViewEnabled)
    Sets the value of the property monthSelectionViewEnabled.
    final void
    setSelectionModel(CalendarView.SelectionModel selectionModel)
    Sets the value of the property selectionModel.
    final void
    setShowDaysOfPreviousOrNextMonth(boolean showDaysOfPreviousOrNextMonth)
    Sets the value of the property showDaysOfPreviousOrNextMonth.
    final void
    setShowMonth(boolean showMonth)
    Sets the value of the property showMonth.
    final void
    setShowMonthArrows(boolean show)
    Sets the value of the showMonthArrowsProperty().
    final void
    setShowToday(boolean show)
    Sets the value of showTodayProperty().
    final void
    setShowTodayButton(boolean show)
    Sets the value of the showTodayButtonProperty().
    final void
    setShowWeekNumbers(boolean show)
    Sets the value of showWeekNumbersProperty().
    final void
    setShowYear(boolean showYear)
    Sets the value of the property showYear.
    final void
    setToday(LocalDate date)
    Sets the value of todayProperty().
    final void
    setTodayText(String todayText)
    Sets the value of the property todayText.
    final void
    setWeekNumberColumnWidth(double weekNumberColumnWidth)
    Sets the value of the property weekNumberColumnWidth.
    final void
    setYearDisplayMode(CalendarView.YearDisplayMode yearDisplayMode)
    Sets the value of the property yearDisplayMode.
    void
    setYearMonth(YearMonth yearMonth)
    Sets the value of the property yearMonth.
    final void
    setYearSelectionViewEnabled(boolean yearSelectionViewEnabled)
    Sets the value of the property yearSelectionViewEnabled.
    final javafx.beans.property.BooleanProperty
    showDaysOfPreviousOrNextMonthProperty()
    By default, the calendar for a given month might also show some days of the previous and the next month.
    final javafx.beans.property.BooleanProperty
    showMonthArrowsProperty()
    Shows or hides the arrows to change the month.
    final javafx.beans.property.BooleanProperty
    showMonthProperty()
    Returns the BooleanProperty that controls the visibility of the month display in the header.
    final javafx.beans.property.BooleanProperty
    showTodayButtonProperty()
    Show or hide a button to quickly go to today's date.
    final javafx.beans.property.BooleanProperty
    showTodayProperty()
    A flag used to indicate that the view will mark the area that represents the value of todayProperty().
    final javafx.beans.property.BooleanProperty
    showWeekNumbersProperty()
    Controls whether the view will show week numbers.
    final javafx.beans.property.BooleanProperty
    showYearProperty()
    Show or hide the year in the header.
    final javafx.beans.property.ObjectProperty<LocalDate>
    todayProperty()
    Stores the date that is considered to represent "today".
    final javafx.beans.property.StringProperty
    todayTextProperty()
    The text that will be shown on the button used for going to today's date.
    final javafx.beans.property.DoubleProperty
    weekNumberColumnWidthProperty()
     
    final javafx.beans.property.ObjectProperty<CalendarView.YearDisplayMode>
    yearDisplayModeProperty()
    The display mode for the year label at the top of the calendar view.
    final javafx.beans.property.ObjectProperty<YearMonth>
    yearMonthProperty()
    Stores the year and month shown by the control.
    final javafx.beans.property.BooleanProperty
    yearSelectionViewEnabledProperty()
    Determines whether the control offers the option to the user to pick a different year directly via a designated year selection view.

    Methods inherited from class javafx.scene.control.Control

    computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, executeAccessibleAction, getBaselineOffset, getContextMenu, getCssMetaData, getInitialFocusTraversable, getSkin, getTooltip, isResizable, layoutChildren, queryAccessibleAttribute, setContextMenu, setSkin, setTooltip, skinProperty, tooltipProperty

    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, 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, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty

    Methods inherited from class javafx.scene.Parent

    getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, 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, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, focusVisibleProperty, focusWithinProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, 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, getViewOrder, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isFocusVisible, isFocusWithin, 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, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface javafx.css.Styleable

    getStyleableNode

  • Property Details

  • Constructor Details

    • CalendarView

      public CalendarView()
      Constructs a new view.

  • Method Details

    • createDefaultSkin

      protected javafx.scene.control.Skin<?> createDefaultSkin()
      Overrides:
      createDefaultSkin in class javafx.scene.control.Control

    • getUserAgentStylesheet

      public String getUserAgentStylesheet()
      Overrides:
      getUserAgentStylesheet in class javafx.scene.layout.Region

    • getYearMonthView

      public YearMonthView getYearMonthView()
      Returns the view used to display a month selection to the user. Applications can choose to override this method and return their own custom view.
      Returns:
      the view used for showing and selecting a month

    • getYearView

      public YearView getYearView()
      Returns the view used to display a year selection to the user. Applications can choose to override this method and return their own custom view.
      Returns:
      the view used for showing and selecting a year

    • yearMonthProperty

      public final javafx.beans.property.ObjectProperty<YearMonth> yearMonthProperty()
      Stores the year and month shown by the control.
      See Also:

    • getYearMonth

      public final YearMonth getYearMonth()
      Returns the value of yearMonthProperty().
      Returns:
      the year and month

    • setYearMonth

      public void setYearMonth(YearMonth yearMonth)
      Sets the value of the property yearMonth.
      Property description:
      Stores the year and month shown by the control.

    • getWeekendDays

      public javafx.collections.ObservableSet<DayOfWeek> getWeekendDays()
      Returns the days of the week that are considered to be weekend days, for example Saturday and Sunday, or Friday and Saturday.
      Returns:
      the weekend days

    • showWeekNumbersProperty

      public final javafx.beans.property.BooleanProperty showWeekNumbersProperty()
      Controls whether the view will show week numbers.
      See Also:

    • setShowWeekNumbers

      public final void setShowWeekNumbers(boolean show)
      Sets the value of showWeekNumbersProperty().
      Parameters:
      show - if true will show week numbers

    • isShowWeekNumbers

      public final boolean isShowWeekNumbers()
      Returns the value of showWeekNumbersProperty().
      Returns:
      true if week numbers will be shown

    • isMarkSelectedDaysOfPreviousOrNextMonth

      public final boolean isMarkSelectedDaysOfPreviousOrNextMonth()
      Gets the value of the property markSelectedDaysOfPreviousOrNextMonth.
      Property description:
      Determines whether selected dates will be marked as such when they are being displayed at the beginning of the next month or at the end of the previous month.

    • markSelectedDaysOfPreviousOrNextMonthProperty

      public final javafx.beans.property.BooleanProperty markSelectedDaysOfPreviousOrNextMonthProperty()
      Determines whether selected dates will be marked as such when they are being displayed at the beginning of the next month or at the end of the previous month.
      See Also:

    • setMarkSelectedDaysOfPreviousOrNextMonth

      public final void setMarkSelectedDaysOfPreviousOrNextMonth(boolean markSelectedDaysOfPreviousOrNextMonth)
      Sets the value of the property markSelectedDaysOfPreviousOrNextMonth.
      Property description:
      Determines whether selected dates will be marked as such when they are being displayed at the beginning of the next month or at the end of the previous month.

    • isShowDaysOfPreviousOrNextMonth

      public final boolean isShowDaysOfPreviousOrNextMonth()
      Gets the value of the property showDaysOfPreviousOrNextMonth.
      Property description:
      By default, the calendar for a given month might also show some days of the previous and the next month. This property allows applications to hide them if needed.

    • showDaysOfPreviousOrNextMonthProperty

      public final javafx.beans.property.BooleanProperty showDaysOfPreviousOrNextMonthProperty()
      By default, the calendar for a given month might also show some days of the previous and the next month. This property allows applications to hide them if needed.
      See Also:

    • setShowDaysOfPreviousOrNextMonth

      public final void setShowDaysOfPreviousOrNextMonth(boolean showDaysOfPreviousOrNextMonth)
      Sets the value of the property showDaysOfPreviousOrNextMonth.
      Property description:
      By default, the calendar for a given month might also show some days of the previous and the next month. This property allows applications to hide them if needed.

    • todayProperty

      public final javafx.beans.property.ObjectProperty<LocalDate> todayProperty()
      Stores the date that is considered to represent "today". This property is initialized with LocalDate.now() but can be any date.
      See Also:

    • setToday

      public final void setToday(LocalDate date)
      Sets the value of todayProperty().
      Parameters:
      date - the date representing "today"

    • getToday

      public final LocalDate getToday()
      Returns the value of todayProperty().
      Returns:
      the date representing "today"

    • showTodayProperty

      public final javafx.beans.property.BooleanProperty showTodayProperty()
      A flag used to indicate that the view will mark the area that represents the value of todayProperty(). By default, this area will be filled with a different color (red) than the rest (white). All Day View Today
      See Also:

    • isShowToday

      public final boolean isShowToday()
      Returns the value of showTodayProperty().
      Returns:
      true if today will be highlighted visually

    • setShowToday

      public final void setShowToday(boolean show)
      Sets the value of showTodayProperty().
      Parameters:
      show - if true today will be highlighted visually

    • isDisablePreviousMonthButton

      public final boolean isDisablePreviousMonthButton()
      Gets the value of the property disablePreviousMonthButton.
      Property description:
      A property to control whether the "show previous month" button will be disabled or not. This property can be very useful when working with (for example) two calendars used for selecting a date range. Then the second calendar should never show a month that is earlier than the first calendar.

    • disablePreviousMonthButtonProperty

      public final javafx.beans.property.BooleanProperty disablePreviousMonthButtonProperty()
      A property to control whether the "show previous month" button will be disabled or not. This property can be very useful when working with (for example) two calendars used for selecting a date range. Then the second calendar should never show a month that is earlier than the first calendar.
      See Also:

    • setDisablePreviousMonthButton

      public final void setDisablePreviousMonthButton(boolean disablePreviousMonthButton)
      Sets the value of the property disablePreviousMonthButton.
      Property description:
      A property to control whether the "show previous month" button will be disabled or not. This property can be very useful when working with (for example) two calendars used for selecting a date range. Then the second calendar should never show a month that is earlier than the first calendar.

    • isDisableNextMonthButton

      public final boolean isDisableNextMonthButton()
      Gets the value of the property disableNextMonthButton.
      Property description:
      A property to control whether the "show next month" button will be disabled or not. This property can be very useful when working with (for example) two calendars used for selecting a date range. Then the first calendar should never show a month that is later than the second calendar.

    • disableNextMonthButtonProperty

      public final javafx.beans.property.BooleanProperty disableNextMonthButtonProperty()
      A property to control whether the "show next month" button will be disabled or not. This property can be very useful when working with (for example) two calendars used for selecting a date range. Then the first calendar should never show a month that is later than the second calendar.
      See Also:

    • setDisableNextMonthButton

      public final void setDisableNextMonthButton(boolean disableNextMonthButton)
      Sets the value of the property disableNextMonthButton.
      Property description:
      A property to control whether the "show next month" button will be disabled or not. This property can be very useful when working with (for example) two calendars used for selecting a date range. Then the first calendar should never show a month that is later than the second calendar.

    • isDisableNextYearButton

      public final boolean isDisableNextYearButton()
      Gets the value of the property disableNextYearButton.
      Property description:
      A property to control whether the "show next year" button will be disabled or not. This property can be very useful when working with (for example) two calendars used for selecting a date range. Then the first calendar should never show a year that is later than the second calendar.

    • disableNextYearButtonProperty

      public final javafx.beans.property.BooleanProperty disableNextYearButtonProperty()
      A property to control whether the "show next year" button will be disabled or not. This property can be very useful when working with (for example) two calendars used for selecting a date range. Then the first calendar should never show a year that is later than the second calendar.
      See Also:

    • setDisableNextYearButton

      public final void setDisableNextYearButton(boolean disableNextYearButton)
      Sets the value of the property disableNextYearButton.
      Property description:
      A property to control whether the "show next year" button will be disabled or not. This property can be very useful when working with (for example) two calendars used for selecting a date range. Then the first calendar should never show a year that is later than the second calendar.

    • isDisablePreviousYearButton

      public final boolean isDisablePreviousYearButton()
      Gets the value of the property disablePreviousYearButton.
      Property description:
      A property to control whether the "show previous year" button will be disabled or not. This property can be very useful when working with (for example) two calendars used for selecting a date range. Then the second calendar should never show a year that is earlier than the first calendar.

    • disablePreviousYearButtonProperty

      public final javafx.beans.property.BooleanProperty disablePreviousYearButtonProperty()
      A property to control whether the "show previous year" button will be disabled or not. This property can be very useful when working with (for example) two calendars used for selecting a date range. Then the second calendar should never show a year that is earlier than the first calendar.
      See Also:

    • setDisablePreviousYearButton

      public final void setDisablePreviousYearButton(boolean disablePreviousYearButton)
      Sets the value of the property disablePreviousYearButton.
      Property description:
      A property to control whether the "show previous year" button will be disabled or not. This property can be very useful when working with (for example) two calendars used for selecting a date range. Then the second calendar should never show a year that is earlier than the first calendar.

    • isDisableMonthDropdownButton

      public final boolean isDisableMonthDropdownButton()
      Gets the value of the property disableMonthDropdownButton.
      Property description:
      A property to control whether the "show month view" button will be disabled or not.

    • disableMonthDropdownButtonProperty

      public final javafx.beans.property.BooleanProperty disableMonthDropdownButtonProperty()
      A property to control whether the "show month view" button will be disabled or not.
      See Also:

    • setDisableMonthDropdownButton

      public final void setDisableMonthDropdownButton(boolean disableMonthDropdownButton)
      Sets the value of the property disableMonthDropdownButton.
      Property description:
      A property to control whether the "show month view" button will be disabled or not.

    • isDisableYearDropdownButton

      public final boolean isDisableYearDropdownButton()
      Gets the value of the property disableYearDropdownButton.
      Property description:
      A property to control whether the "show year view" button will be disabled or not.

    • disableYearDropdownButtonProperty

      public final javafx.beans.property.BooleanProperty disableYearDropdownButtonProperty()
      A property to control whether the "show year view" button will be disabled or not.
      See Also:

    • setDisableYearDropdownButton

      public final void setDisableYearDropdownButton(boolean disableYearDropdownButton)
      Sets the value of the property disableYearDropdownButton.
      Property description:
      A property to control whether the "show year view" button will be disabled or not.

    • getDateFilter

      public final javafx.util.Callback<LocalDate,Boolean> getDateFilter()
      Gets the value of the property dateFilter.
      Property description:
      A property to define a filter for determining which dates in the calendar can be selected. This filter is applied to each date displayed in the calendar. If the filter returns true for a given date, that date will be selectable (i.e., it passes the filter). If the filter returns false, the date will be disabled and cannot be selected. This property is particularly useful for scenarios where only specific dates should be available for selection based on custom logic, such as business rules, holidays, or availability.

      When SelectionMode is CalendarView.SelectionModel.SelectionMode.DATE_RANGE, disabled dates can be included within the selected range. However, disabled dates cannot be used as either the starting or ending point of the range.

    • dateFilterProperty

      public final javafx.beans.property.ObjectProperty<javafx.util.Callback<LocalDate,Boolean>> dateFilterProperty()
      A property to define a filter for determining which dates in the calendar can be selected. This filter is applied to each date displayed in the calendar. If the filter returns true for a given date, that date will be selectable (i.e., it passes the filter). If the filter returns false, the date will be disabled and cannot be selected. This property is particularly useful for scenarios where only specific dates should be available for selection based on custom logic, such as business rules, holidays, or availability.

      When SelectionMode is CalendarView.SelectionModel.SelectionMode.DATE_RANGE, disabled dates can be included within the selected range. However, disabled dates cannot be used as either the starting or ending point of the range.

      See Also:

    • setDateFilter

      public final void setDateFilter(javafx.util.Callback<LocalDate,Boolean> dateFilter)
      Sets the value of the property dateFilter.
      Property description:
      A property to define a filter for determining which dates in the calendar can be selected. This filter is applied to each date displayed in the calendar. If the filter returns true for a given date, that date will be selectable (i.e., it passes the filter). If the filter returns false, the date will be disabled and cannot be selected. This property is particularly useful for scenarios where only specific dates should be available for selection based on custom logic, such as business rules, holidays, or availability.

      When SelectionMode is CalendarView.SelectionModel.SelectionMode.DATE_RANGE, disabled dates can be included within the selected range. However, disabled dates cannot be used as either the starting or ending point of the range.

    • cellFactoryProperty

      public final javafx.beans.property.ObjectProperty<javafx.util.Callback<CalendarView,CalendarView.DateCell>> cellFactoryProperty()
      A factory for creating alternative content for the month view. The image below shows the CalendarView once with the default factory and once with an alternative factory that creates checkboxes.

      Month Cell Factory
      See Also:

    • setCellFactory

      public final void setCellFactory(javafx.util.Callback<CalendarView,CalendarView.DateCell> factory)
      Sets the value of cellFactoryProperty().
      Parameters:
      factory - the cell factory

    • getCellFactory

      public final javafx.util.Callback<CalendarView,CalendarView.DateCell> getCellFactory()
      Returns the value of cellFactoryProperty().
      Returns:
      the cell factory

    • isMonthSelectionViewEnabled

      public final boolean isMonthSelectionViewEnabled()
      Gets the value of the property monthSelectionViewEnabled.
      Property description:
      Determines whether the control offers the option to the user to pick a different month directly via a designated month selection view.

    • monthSelectionViewEnabledProperty

      public final javafx.beans.property.BooleanProperty monthSelectionViewEnabledProperty()
      Determines whether the control offers the option to the user to pick a different month directly via a designated month selection view.
      See Also:

    • setMonthSelectionViewEnabled

      public final void setMonthSelectionViewEnabled(boolean monthSelectionViewEnabled)
      Sets the value of the property monthSelectionViewEnabled.
      Property description:
      Determines whether the control offers the option to the user to pick a different month directly via a designated month selection view.

    • isYearSelectionViewEnabled

      public final boolean isYearSelectionViewEnabled()
      Gets the value of the property yearSelectionViewEnabled.
      Property description:
      Determines whether the control offers the option to the user to pick a different year directly via a designated year selection view.

    • yearSelectionViewEnabledProperty

      public final javafx.beans.property.BooleanProperty yearSelectionViewEnabledProperty()
      Determines whether the control offers the option to the user to pick a different year directly via a designated year selection view.
      See Also:

    • setYearSelectionViewEnabled

      public final void setYearSelectionViewEnabled(boolean yearSelectionViewEnabled)
      Sets the value of the property yearSelectionViewEnabled.
      Property description:
      Determines whether the control offers the option to the user to pick a different year directly via a designated year selection view.

    • isShowMonth

      public final boolean isShowMonth()
      Gets the value of the property showMonth.
      Property description:
      Returns the BooleanProperty that controls the visibility of the month display in the header. This property impacts whether the month name and month navigation controls are shown.

    • showMonthProperty

      public final javafx.beans.property.BooleanProperty showMonthProperty()
      Returns the BooleanProperty that controls the visibility of the month display in the header. This property impacts whether the month name and month navigation controls are shown.
      See Also:

    • setShowMonth

      public final void setShowMonth(boolean showMonth)
      Sets the value of the property showMonth.
      Property description:
      Returns the BooleanProperty that controls the visibility of the month display in the header. This property impacts whether the month name and month navigation controls are shown.

    • isShowYear

      public final boolean isShowYear()
      Gets the value of the property showYear.
      Property description:
      Show or hide the year in the header.

    • showYearProperty

      public final javafx.beans.property.BooleanProperty showYearProperty()
      Show or hide the year in the header.
      See Also:

    • setShowYear

      public final void setShowYear(boolean showYear)
      Sets the value of the property showYear.
      Property description:
      Show or hide the year in the header.

    • showTodayButtonProperty

      public final javafx.beans.property.BooleanProperty showTodayButtonProperty()
      Show or hide a button to quickly go to today's date.
      See Also:

    • setShowTodayButton

      public final void setShowTodayButton(boolean show)
      Sets the value of the showTodayButtonProperty().
      Parameters:
      show - if true will show the button

    • isShowTodayButton

      public final boolean isShowTodayButton()
      Returns the value of the showTodayButtonProperty().
      Returns:
      true if the button is shown

    • showMonthArrowsProperty

      public final javafx.beans.property.BooleanProperty showMonthArrowsProperty()
      Shows or hides the arrows to change the month.
      See Also:

    • setShowMonthArrows

      public final void setShowMonthArrows(boolean show)
      Sets the value of the showMonthArrowsProperty().
      Parameters:
      show - if true will show the arrows

    • isShowMonthArrows

      public final boolean isShowMonthArrows()
      Returns the value of the showMonthArrowsProperty().
      Returns:
      true if the arrows will be shown

    • getSelectionModel

      public final CalendarView.SelectionModel getSelectionModel()
      Gets the value of the property selectionModel.
      Property description:

    • selectionModelProperty

      public final javafx.beans.property.ObjectProperty<CalendarView.SelectionModel> selectionModelProperty()
      See Also:

    • setSelectionModel

      public final void setSelectionModel(CalendarView.SelectionModel selectionModel)
      Sets the value of the property selectionModel.
      Property description:

    • getWeekNumberColumnWidth

      public final double getWeekNumberColumnWidth()
      Gets the value of the property weekNumberColumnWidth.
      Property description:

    • weekNumberColumnWidthProperty

      public final javafx.beans.property.DoubleProperty weekNumberColumnWidthProperty()
      See Also:

    • setWeekNumberColumnWidth

      public final void setWeekNumberColumnWidth(double weekNumberColumnWidth)
      Sets the value of the property weekNumberColumnWidth.
      Property description:

    • getHeaderLayout

      public final CalendarView.HeaderLayout getHeaderLayout()
      Gets the value of the property headerLayout.
      Property description:
      The header layout value determines how the information and the navigation elements in the header will be laid out.

    • headerLayoutProperty

      public final javafx.beans.property.ObjectProperty<CalendarView.HeaderLayout> headerLayoutProperty()
      The header layout value determines how the information and the navigation elements in the header will be laid out.
      See Also:

    • setHeaderLayout

      public final void setHeaderLayout(CalendarView.HeaderLayout headerLayout)
      Sets the value of the property headerLayout.
      Property description:
      The header layout value determines how the information and the navigation elements in the header will be laid out.

    • getTodayText

      public final String getTodayText()
      Gets the value of the property todayText.
      Property description:
      The text that will be shown on the button used for going to today's date.

    • todayTextProperty

      public final javafx.beans.property.StringProperty todayTextProperty()
      The text that will be shown on the button used for going to today's date.
      See Also:

    • setTodayText

      public final void setTodayText(String todayText)
      Sets the value of the property todayText.
      Property description:
      The text that will be shown on the button used for going to today's date.

    • getEarliestDate

      public final LocalDate getEarliestDate()
      Gets the value of the property earliestDate.
      Property description:
      The earliest day that can be selected in the view.

    • earliestDateProperty

      public final javafx.beans.property.ObjectProperty<LocalDate> earliestDateProperty()
      The earliest day that can be selected in the view.
      See Also:

    • setEarliestDate

      public final void setEarliestDate(LocalDate earliestDate)
      Sets the value of the property earliestDate.
      Property description:
      The earliest day that can be selected in the view.

    • getLatestDate

      public final LocalDate getLatestDate()
      Gets the value of the property latestDate.
      Property description:
      The latest day that can be selected in the view.

    • latestDateProperty

      public final javafx.beans.property.ObjectProperty<LocalDate> latestDateProperty()
      The latest day that can be selected in the view.
      See Also:

    • setLatestDate

      public final void setLatestDate(LocalDate latestDate)
      Sets the value of the property latestDate.
      Property description:
      The latest day that can be selected in the view.

    • yearDisplayModeProperty

      public final javafx.beans.property.ObjectProperty<CalendarView.YearDisplayMode> yearDisplayModeProperty()
      The display mode for the year label at the top of the calendar view. CalendarView.YearDisplayMode.TEXT_ONLY is the default mode.
      See Also:

    • getYearDisplayMode

      public final CalendarView.YearDisplayMode getYearDisplayMode()
      Gets the value of the property yearDisplayMode.
      Property description:
      The display mode for the year label at the top of the calendar view. CalendarView.YearDisplayMode.TEXT_ONLY is the default mode.

    • setYearDisplayMode

      public final void setYearDisplayMode(CalendarView.YearDisplayMode yearDisplayMode)
      Sets the value of the property yearDisplayMode.
      Property description:
      The display mode for the year label at the top of the calendar view. CalendarView.YearDisplayMode.TEXT_ONLY is the default mode.

    • monthDisplayModeProperty

      public final javafx.beans.property.ObjectProperty<CalendarView.MonthDisplayMode> monthDisplayModeProperty()
      The display mode for the month label at the top of the calendar view. CalendarView.MonthDisplayMode.TEXT_ONLY is the default mode.
      See Also:

    • getMonthDisplayMode

      public final CalendarView.MonthDisplayMode getMonthDisplayMode()
      Gets the value of the property monthDisplayMode.
      Property description:
      The display mode for the month label at the top of the calendar view. CalendarView.MonthDisplayMode.TEXT_ONLY is the default mode.

    • setMonthDisplayMode

      public final void setMonthDisplayMode(CalendarView.MonthDisplayMode monthDisplayMode)
      Sets the value of the property monthDisplayMode.
      Property description:
      The display mode for the month label at the top of the calendar view. CalendarView.MonthDisplayMode.TEXT_ONLY is the default mode.

    • getControlCssMetaData

      public List<javafx.css.CssMetaData<? extends javafx.css.Styleable,?>> getControlCssMetaData()
      Overrides:
      getControlCssMetaData in class javafx.scene.control.Control

    • getClassCssMetaData

      public static List<javafx.css.CssMetaData<? extends javafx.css.Styleable,?>> getClassCssMetaData()