java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.control.Control
jfxtras.scene.control.CalendarPicker
- All Implemented Interfaces:
javafx.css.Styleable
,javafx.event.EventTarget
,javafx.scene.control.Skinnable
public class CalendarPicker
extends javafx.scene.control.Control
// These are used for the includes
:control: CalendarPicker
:control_instance: calendarPicker
:calendar: calendar
:calendars: calendars
:calendar_class: Calendar
:calendars_class: Calendars
= CalendarPicker
CalendarPicker is a control for selecting one, multiple or a range of dates, possibly including time.
The name CalendarPicker is because it uses Java's Calendar (as opposed to Date) in its API to do so, mainly because Calendar holds Locale information and thus the days of the week can be rendered correctly.
include::src/main/asciidoc/scene/control/CalendarPicker_properties.adoc[]
include::src/main/asciidoc/scene/control/CalendarPicker_modeProperty.adoc[]
- The showTime property enables the embedded time picker, so the time part of a Calendar can be set as well. This is only possible in SINGLE mode.
== Callback
include::src/main/asciidoc/scene/control/CalendarPicker_callbacks.adoc[]
== Immutability
include::src/main/asciidoc/scene/control/Calendar_immutability.adoc[]
-
Property Summary
PropertiesTypePropertyDescriptionjavafx.beans.property.BooleanProperty
AllowNull: indicates if no selected date (resulting in null in the calendar property) is an allowed state.javafx.beans.property.ObjectProperty<Calendar>
Calendar: the selected date, or when in RANGE or MULTIPLE mode, the last selected date.javafx.beans.property.ObjectProperty<javafx.util.Callback<CalendarPicker.CalendarRange,
Void>> calendarRangeCallback: This callback allows a developer to limit the amount of calendars put in any of the collections like highlighted or disabled.javafx.beans.property.ObjectProperty<Locale>
Locale: the locale is used to determine first-day-of-week, weekday labels, etcjavafx.beans.property.ObjectProperty<CalendarPicker.Mode>
Mode: single, range or multiple.javafx.beans.property.ObjectProperty<Boolean>
ShowTime: enable the specifying of the time part in a Calendar.valueValidationCallback: This callback allows a developer deny or accept a value just prior before it gets added.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, 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 ClassesModifier and TypeClassDescriptionstatic class
A Calendar rangestatic enum
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate javafx.beans.property.BooleanProperty
private final javafx.beans.property.ObjectProperty<Calendar>
private final javafx.beans.property.ObjectProperty<javafx.util.Callback<CalendarPicker.CalendarRange,
Void>> private final javafx.collections.ObservableList<Calendar>
private final javafx.collections.ObservableList<Calendar>
private javafx.beans.property.ObjectProperty<Calendar>
private final javafx.collections.ObservableList<Calendar>
private javafx.beans.property.ObjectProperty<Locale>
private final javafx.beans.property.SimpleObjectProperty<CalendarPicker.Mode>
private final AtomicInteger
private javafx.beans.property.ObjectProperty<Boolean>
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 -
Method Summary
Modifier and TypeMethodDescriptionjavafx.beans.property.BooleanProperty
AllowNull: indicates if no selected date (resulting in null in the calendar property) is an allowed state.javafx.beans.property.ObjectProperty<Calendar>
Calendar: the selected date, or when in RANGE or MULTIPLE mode, the last selected date.javafx.beans.property.ObjectProperty<javafx.util.Callback<CalendarPicker.CalendarRange,
Void>> calendarRangeCallback: This callback allows a developer to limit the amount of calendars put in any of the collections like highlighted or disabled.javafx.collections.ObservableList<Calendar>
Calendars: a list of all selected calendars.private Calendar
cloneWithMillis0
(Calendar calendar) private void
private void
private void
private void
javafx.scene.control.Skin<?>
javafx.collections.ObservableList<Calendar>
disabledCalendars: a list of dates that cannot be selected.javafx.beans.property.ObjectProperty<Calendar>
DisplayedCalendar: You may set this value, but it is also overwritten by other logic and the skin.boolean
Gets the value of the property allowNull.Gets the value of the property calendar.javafx.util.Callback<CalendarPicker.CalendarRange,
Void> Gets the value of the property calendarRangeCallback.Gets the value of the property locale.getMode()
Gets the value of the property mode.Gets the value of the property showTime.Return the path to the CSS file so things are setup rightGets the value of the property valueValidationCallback.javafx.collections.ObservableList<Calendar>
highlightedCalendars: a list of dates that are rendered with the highlight class added.javafx.beans.property.ObjectProperty<Locale>
Locale: the locale is used to determine first-day-of-week, weekday labels, etcjavafx.beans.property.ObjectProperty<CalendarPicker.Mode>
Mode: single, range or multiple.void
setAllowNull
(boolean allowNull) Sets the value of the property allowNull.void
setCalendar
(Calendar value) Sets the value of the property calendar.void
setCalendarRangeCallback
(javafx.util.Callback<CalendarPicker.CalendarRange, Void> value) Sets the value of the property calendarRangeCallback.void
setDisplayedCalendar
(Calendar value) void
Sets the value of the property locale.void
setMode
(CalendarPicker.Mode value) Sets the value of the property mode.void
setShowTime
(Boolean value) Sets the value of the property showTime.void
setValueValidationCallback
(javafx.util.Callback<Calendar, Boolean> value) Sets the value of the property valueValidationCallback.javafx.beans.property.ObjectProperty<Boolean>
ShowTime: enable the specifying of the time part in a Calendar.valueValidationCallback: This callback allows a developer deny or accept a value just prior before it gets added.withAllowNull
(boolean value) withCalendar
(Calendar value) withCalendarRangeCallback
(javafx.util.Callback<CalendarPicker.CalendarRange, Void> value) withDisplayedCalendar
(Calendar value) Id: for a fluent APIwithLocale
(Locale value) withMode
(CalendarPicker.Mode value) withShowTime
(Boolean value) withValueValidationCallback
(javafx.util.Callback<Calendar, Boolean> value) 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, 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, 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
-
calendar
Calendar: the selected date, or when in RANGE or MULTIPLE mode, the last selected date.- See Also:
-
locale
Locale: the locale is used to determine first-day-of-week, weekday labels, etc- See Also:
-
mode
Mode: single, range or multiple.- See Also:
-
showTime
ShowTime: enable the specifying of the time part in a Calendar. Only applicable in SINGLE mode.- See Also:
-
allowNull
public javafx.beans.property.BooleanProperty allowNullPropertyAllowNull: indicates if no selected date (resulting in null in the calendar property) is an allowed state.- See Also:
-
calendarRangeCallback
public javafx.beans.property.ObjectProperty<javafx.util.Callback<CalendarPicker.CalendarRange,Void>> calendarRangeCallbackPropertycalendarRangeCallback: This callback allows a developer to limit the amount of calendars put in any of the collections like highlighted or disabled. It is called just before a new range is being displayed, so the developer can change the values in the collections. -
valueValidationCallback
public javafx.beans.property.ObjectProperty<javafx.util.Callback<Calendar,Boolean>> valueValidationCallbackPropertyvalueValidationCallback: This callback allows a developer deny or accept a value just prior before it gets added. Returning true will allow the value.
-
-
Field Details
-
calendarObjectProperty
-
calendars
-
modifyingCalendersAtomicInteger
-
localeObjectProperty
-
modeObjectProperty
-
showTimeObjectProperty
-
allowNullProperty
private volatile javafx.beans.property.BooleanProperty allowNullProperty -
disabledCalendars
-
highlightedCalendars
-
calendarRangeCallbackObjectProperty
private final javafx.beans.property.ObjectProperty<javafx.util.Callback<CalendarPicker.CalendarRange,Void>> calendarRangeCallbackObjectProperty -
displayedCalendarObjectProperty
-
valueValidationCallbackObjectProperty
-
-
Constructor Details
-
CalendarPicker
public CalendarPicker()
-
-
Method Details
-
construct
private void construct() -
getUserAgentStylesheet
Return the path to the CSS file so things are setup right- Overrides:
getUserAgentStylesheet
in classjavafx.scene.layout.Region
-
createDefaultSkin
public javafx.scene.control.Skin<?> createDefaultSkin()- Overrides:
createDefaultSkin
in classjavafx.scene.control.Control
-
withId
Id: for a fluent API -
calendarProperty
Calendar: the selected date, or when in RANGE or MULTIPLE mode, the last selected date.- See Also:
-
getCalendar
Gets the value of the property calendar.- Property description:
- Calendar: the selected date, or when in RANGE or MULTIPLE mode, the last selected date.
-
setCalendar
Sets the value of the property calendar.- Property description:
- Calendar: the selected date, or when in RANGE or MULTIPLE mode, the last selected date.
-
withCalendar
-
constructCalendar
private void constructCalendar() -
calendars
Calendars: a list of all selected calendars. -
constructCalendars
private void constructCalendars() -
localeProperty
Locale: the locale is used to determine first-day-of-week, weekday labels, etc- See Also:
-
getLocale
Gets the value of the property locale.- Property description:
- Locale: the locale is used to determine first-day-of-week, weekday labels, etc
-
setLocale
Sets the value of the property locale.- Property description:
- Locale: the locale is used to determine first-day-of-week, weekday labels, etc
-
withLocale
-
modeProperty
Mode: single, range or multiple.- See Also:
-
getMode
Gets the value of the property mode.- Property description:
- Mode: single, range or multiple.
-
setMode
Sets the value of the property mode.- Property description:
- Mode: single, range or multiple.
-
withMode
-
showTimeProperty
ShowTime: enable the specifying of the time part in a Calendar. Only applicable in SINGLE mode.- See Also:
-
getShowTime
Gets the value of the property showTime.- Property description:
- ShowTime: enable the specifying of the time part in a Calendar. Only applicable in SINGLE mode.
-
setShowTime
Sets the value of the property showTime.- Property description:
- ShowTime: enable the specifying of the time part in a Calendar. Only applicable in SINGLE mode.
-
withShowTime
-
allowNullProperty
public javafx.beans.property.BooleanProperty allowNullProperty()AllowNull: indicates if no selected date (resulting in null in the calendar property) is an allowed state.- See Also:
-
getAllowNull
public boolean getAllowNull()Gets the value of the property allowNull.- Property description:
- AllowNull: indicates if no selected date (resulting in null in the calendar property) is an allowed state.
-
setAllowNull
public void setAllowNull(boolean allowNull) Sets the value of the property allowNull.- Property description:
- AllowNull: indicates if no selected date (resulting in null in the calendar property) is an allowed state.
-
withAllowNull
-
disabledCalendars
disabledCalendars: a list of dates that cannot be selected. -
highlightedCalendars
highlightedCalendars: a list of dates that are rendered with the highlight class added. This can then be styled using CSS. -
calendarRangeCallbackProperty
public javafx.beans.property.ObjectProperty<javafx.util.Callback<CalendarPicker.CalendarRange,Void>> calendarRangeCallbackProperty()calendarRangeCallback: This callback allows a developer to limit the amount of calendars put in any of the collections like highlighted or disabled. It is called just before a new range is being displayed, so the developer can change the values in the collections. -
getCalendarRangeCallback
Gets the value of the property calendarRangeCallback.- Property description:
- calendarRangeCallback: This callback allows a developer to limit the amount of calendars put in any of the collections like highlighted or disabled. It is called just before a new range is being displayed, so the developer can change the values in the collections.
-
setCalendarRangeCallback
Sets the value of the property calendarRangeCallback.- Property description:
- calendarRangeCallback: This callback allows a developer to limit the amount of calendars put in any of the collections like highlighted or disabled. It is called just before a new range is being displayed, so the developer can change the values in the collections.
-
withCalendarRangeCallback
public CalendarPicker withCalendarRangeCallback(javafx.util.Callback<CalendarPicker.CalendarRange, Void> value) -
displayedCalendar
DisplayedCalendar: You may set this value, but it is also overwritten by other logic and the skin. Do not assume you have total control. The calendar should not be modified using any of its add or set methods (it should be considered immutable) -
getDisplayedCalendar
-
setDisplayedCalendar
-
withDisplayedCalendar
-
constructDisplayedCalendar
private void constructDisplayedCalendar() -
valueValidationCallbackProperty
public javafx.beans.property.ObjectProperty<javafx.util.Callback<Calendar,Boolean>> valueValidationCallbackProperty()valueValidationCallback: This callback allows a developer deny or accept a value just prior before it gets added. Returning true will allow the value. -
getValueValidationCallback
Gets the value of the property valueValidationCallback.- Property description:
- valueValidationCallback: This callback allows a developer deny or accept a value just prior before it gets added. Returning true will allow the value.
-
setValueValidationCallback
Sets the value of the property valueValidationCallback.- Property description:
- valueValidationCallback: This callback allows a developer deny or accept a value just prior before it gets added. Returning true will allow the value.
-
withValueValidationCallback
-
cloneWithMillis0
-