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 apperance of this control: Date Picker
  • Property Summary

    Properties
    Type
    Property
    Description
    final javafx.beans.property.ObjectProperty<javafx.util.Callback<CalendarView,CalendarView.DateCell>>
    A factory for creating alternative content for the month view.
    final javafx.beans.property.BooleanProperty
    A property to control whether the "show next month" button will be disabled or not.
    final javafx.beans.property.BooleanProperty
    A property to control whether the "show next year" button will be disabled or not.
    final javafx.beans.property.BooleanProperty
    A property to control whether the "show previous month" button will be disabled or not.
    final javafx.beans.property.BooleanProperty
    A property to control whether the "show previous year" button will be disabled or not.
    final javafx.beans.property.ObjectProperty<CalendarView.SelectionModel>
     
    final javafx.beans.property.BooleanProperty
    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
    Shows or hides the arrows to change the month.
    javafx.beans.property.BooleanProperty
     
    final javafx.beans.property.BooleanProperty
    Show or hide a button to quickly go to today's date.
    final javafx.beans.property.BooleanProperty
    A flag used to indicate that the view will mark the area that represents the value of todayProperty().
    final javafx.beans.property.BooleanProperty
    Controls whether the view will show week numbers.
    final javafx.beans.property.BooleanProperty
    Show or hide the year in the header.
    final javafx.beans.property.BooleanProperty
    Show or hide the year / month spinner.
    final javafx.beans.property.ObjectProperty<LocalDate>
    Stores the date that is considered to represent "today".
    final javafx.beans.property.ObjectProperty<YearMonth>
    Stores the year and month shown by the control.

    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 
    The base date cell implementation for month views.
    static class 
     
  • 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
    Constructs a new view.
  • Method Summary

    Modifier and Type
    Method
    Description
    final javafx.beans.property.ObjectProperty<javafx.util.Callback<CalendarView,CalendarView.DateCell>>
    A factory for creating alternative content for the month view.
    protected javafx.scene.control.Skin<?>
     
    final javafx.beans.property.BooleanProperty
    A property to control whether the "show next month" button will be disabled or not.
    final javafx.beans.property.BooleanProperty
    A property to control whether the "show next year" button will be disabled or not.
    final javafx.beans.property.BooleanProperty
    A property to control whether the "show previous month" button will be disabled or not.
    final javafx.beans.property.BooleanProperty
    A property to control whether the "show previous year" button will be disabled or not.
    final javafx.util.Callback<CalendarView,CalendarView.DateCell>
    Returns the value of cellFactoryProperty().
    Gets the value of the selectionModel property.
    final LocalDate
    Returns the value of todayProperty().
     
    javafx.collections.ObservableSet<DayOfWeek>
    Returns the days of the week that are considered to be weekend days, for example Saturday and Sunday, or Friday and Saturday.
    final YearMonth
    Returns the value of yearMonthProperty().
    final boolean
    Gets the value of the disableNextMonthButton property.
    final boolean
    Gets the value of the disableNextYearButton property.
    final boolean
    Gets the value of the disablePreviousMonthButton property.
    final boolean
    Gets the value of the disablePreviousYearButton property.
    final boolean
    Gets the value of the showDaysOfPreviousOrNextMonth property.
    boolean
    Gets the value of the showMonth property.
    final boolean
    Returns the value of the showMonthArrowsProperty().
    final boolean
    Returns the value of showTodayProperty().
    final boolean
    Returns the value of the showTodayButtonProperty().
    final boolean
    Returns the value of showWeekNumbersProperty().
    final boolean
    Gets the value of the showYear property.
    final boolean
    Returns the value of showYearSpinnerProperty().
    final javafx.beans.property.ObjectProperty<CalendarView.SelectionModel>
     
    final void
    setCellFactory(javafx.util.Callback<CalendarView,CalendarView.DateCell> factory)
    Sets the value of cellFactoryProperty().
    final void
    setDisableNextMonthButton(boolean disableNextMonthButton)
    Sets the value of the disableNextMonthButton property.
    final void
    setDisableNextYearButton(boolean disableNextYearButton)
    Sets the value of the disableNextYearButton property.
    final void
    setDisablePreviousMonthButton(boolean disablePreviousMonthButton)
    Sets the value of the disablePreviousMonthButton property.
    final void
    setDisablePreviousYearButton(boolean disablePreviousYearButton)
    Sets the value of the disablePreviousYearButton property.
    final void
    Sets the value of the selectionModel property.
    final void
    setShowDaysOfPreviousOrNextMonth(boolean showDaysOfPreviousOrNextMonth)
    Sets the value of the showDaysOfPreviousOrNextMonth property.
    void
    setShowMonth(boolean showMonth)
    Sets the value of the showMonth property.
    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 showYear property.
    final void
    setShowYearSpinner(boolean show)
    Sets the value of showYearSpinnerProperty().
    final void
    Sets the value of todayProperty().
    void
    Sets the value of the yearMonth property.
    final javafx.beans.property.BooleanProperty
    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
    Shows or hides the arrows to change the month.
    javafx.beans.property.BooleanProperty
     
    final javafx.beans.property.BooleanProperty
    Show or hide a button to quickly go to today's date.
    final javafx.beans.property.BooleanProperty
    A flag used to indicate that the view will mark the area that represents the value of todayProperty().
    final javafx.beans.property.BooleanProperty
    Controls whether the view will show week numbers.
    final javafx.beans.property.BooleanProperty
    Show or hide the year in the header.
    final javafx.beans.property.BooleanProperty
    Show or hide the year / month spinner.
    final javafx.beans.property.ObjectProperty<LocalDate>
    Stores the date that is considered to represent "today".
    final javafx.beans.property.ObjectProperty<YearMonth>
    Stores the year and month shown by the control.

    Methods inherited from class javafx.scene.control.Control

    computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, executeAccessibleAction, getBaselineOffset, getClassCssMetaData, getContextMenu, getControlCssMetaData, 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
    • yearMonthProperty

      public final javafx.beans.property.ObjectProperty<YearMonth> yearMonthProperty()
      Stores the year and month shown by the control.
      Returns:
      the year and month
      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 yearMonth property.
      Property description:
      Stores the year and month shown by the control.
      Parameters:
      yearMonth - the value for the yearMonth property
      See Also:
    • 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.
      Returns:
      true if week numbers are shown
      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
    • isShowDaysOfPreviousOrNextMonth

      public final boolean isShowDaysOfPreviousOrNextMonth()
      Gets the value of the showDaysOfPreviousOrNextMonth property.
      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.
      Returns:
      the value of the showDaysOfPreviousOrNextMonth property
      See Also:
    • 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.
      Returns:
      true if the calendar will be filled up with days of the previous and the next month
      See Also:
    • setShowDaysOfPreviousOrNextMonth

      public final void setShowDaysOfPreviousOrNextMonth(boolean showDaysOfPreviousOrNextMonth)
      Sets the value of the showDaysOfPreviousOrNextMonth property.
      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.
      Parameters:
      showDaysOfPreviousOrNextMonth - the value for the showDaysOfPreviousOrNextMonth property
      See Also:
    • 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.
      Returns:
      the date representing "today"
      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
      Returns:
      true if today will be shown differently
      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 disablePreviousMonthButton property.
      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.
      Returns:
      the value of the disablePreviousMonthButton property
      See Also:
    • 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.
      Returns:
      true if the button used for going to the next month is currently disabled
      See Also:
    • setDisablePreviousMonthButton

      public final void setDisablePreviousMonthButton(boolean disablePreviousMonthButton)
      Sets the value of the disablePreviousMonthButton property.
      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.
      Parameters:
      disablePreviousMonthButton - the value for the disablePreviousMonthButton property
      See Also:
    • isDisableNextMonthButton

      public final boolean isDisableNextMonthButton()
      Gets the value of the disableNextMonthButton property.
      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.
      Returns:
      the value of the disableNextMonthButton property
      See Also:
    • 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.
      Returns:
      true if the button used for going to the next month is currently disabled
      See Also:
    • setDisableNextMonthButton

      public final void setDisableNextMonthButton(boolean disableNextMonthButton)
      Sets the value of the disableNextMonthButton property.
      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.
      Parameters:
      disableNextMonthButton - the value for the disableNextMonthButton property
      See Also:
    • isDisableNextYearButton

      public final boolean isDisableNextYearButton()
      Gets the value of the disableNextYearButton property.
      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.
      Returns:
      the value of the disableNextYearButton property
      See Also:
    • 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.
      Returns:
      true if the button used for going to the next year is currently disabled
      See Also:
    • setDisableNextYearButton

      public final void setDisableNextYearButton(boolean disableNextYearButton)
      Sets the value of the disableNextYearButton property.
      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.
      Parameters:
      disableNextYearButton - the value for the disableNextYearButton property
      See Also:
    • isDisablePreviousYearButton

      public final boolean isDisablePreviousYearButton()
      Gets the value of the disablePreviousYearButton property.
      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.
      Returns:
      the value of the disablePreviousYearButton property
      See Also:
    • 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.
      Returns:
      true if the button used for going to the next year is currently disabled
      See Also:
    • setDisablePreviousYearButton

      public final void setDisablePreviousYearButton(boolean disablePreviousYearButton)
      Sets the value of the disablePreviousYearButton property.
      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.
      Parameters:
      disablePreviousYearButton - the value for the disablePreviousYearButton property
      See Also:
    • 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
      Returns:
      the 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
    • isShowMonth

      public boolean isShowMonth()
      Gets the value of the showMonth property.
      Property description:
      Returns:
      the value of the showMonth property
      See Also:
    • showMonthProperty

      public javafx.beans.property.BooleanProperty showMonthProperty()
      Returns:
      the showMonth property
      See Also:
    • setShowMonth

      public void setShowMonth(boolean showMonth)
      Sets the value of the showMonth property.
      Property description:
      Parameters:
      showMonth - the value for the showMonth property
      See Also:
    • isShowYear

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

      public final javafx.beans.property.BooleanProperty showYearProperty()
      Show or hide the year in the header.
      Returns:
      true if the year is shown in the header
      See Also:
    • setShowYear

      public final void setShowYear(boolean showYear)
      Sets the value of the showYear property.
      Property description:
      Show or hide the year in the header.
      Parameters:
      showYear - the value for the showYear property
      See Also:
    • showYearSpinnerProperty

      public final javafx.beans.property.BooleanProperty showYearSpinnerProperty()
      Show or hide the year / month spinner.
      Returns:
      true if the year will be shown
      See Also:
    • setShowYearSpinner

      public final void setShowYearSpinner(boolean show)
      Sets the value of showYearSpinnerProperty().
      Parameters:
      show - if true the year / month spinner at the top will be shown
    • isShowYearSpinner

      public final boolean isShowYearSpinner()
      Returns the value of showYearSpinnerProperty().
      Returns:
      true if the year / month spinner will be shown
    • showTodayButtonProperty

      public final javafx.beans.property.BooleanProperty showTodayButtonProperty()
      Show or hide a button to quickly go to today's date.
      Returns:
      true if the button will be shown
      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.
      Returns:
      true if the arrows will be shown
      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 selectionModel property.
      Property description:
      Returns:
      the value of the selectionModel property
      See Also:
    • selectionModelProperty

      public final javafx.beans.property.ObjectProperty<CalendarView.SelectionModel> selectionModelProperty()
      Returns:
      the selectionModel property
      See Also:
    • setSelectionModel

      public final void setSelectionModel(CalendarView.SelectionModel selectionModel)
      Sets the value of the selectionModel property.
      Property description:
      Parameters:
      selectionModel - the value for the selectionModel property
      See Also: