java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.control.Control
jfxtras.scene.control.LocalDatePicker
- All Implemented Interfaces:
javafx.css.Styleable
,javafx.event.EventTarget
,javafx.scene.control.Skinnable
public class LocalDatePicker
extends javafx.scene.control.Control
// These are used for the includes
:control: LocalDatePicker
:control_instance: localDatePicker
:calendar: localDate
:calendars: localDates
:calendar_class: LocalDate
:calendars_class: LocalDates
= LocalDatePicker
LocalDatePicker is a control for selecting one, multiple or a range of dates.
The name LocalDatePicker is because it uses Java's LocalDate (JSR-310) (as opposed to Date) in its API to do so.
include::src/main/asciidoc/scene/control/CalendarPicker_properties.adoc[]
include::src/main/asciidoc/scene/control/CalendarPicker_modeProperty.adoc[]
== Callback
include::src/main/asciidoc/scene/control/CalendarPicker_callbacks.adoc[]
-
Property Summary
PropertiesTypePropertyDescriptionjavafx.beans.property.BooleanProperty
AllowNull: indicates if no selected date (resulting in null in the localDate property) is an allowed state.javafx.beans.property.ObjectProperty<LocalDate>
DisplayedLocalDate:javafx.beans.property.ObjectProperty<LocalDate>
LocalDate: the selected date, or when in RANGE or MULTIPLE mode, the last selected date.javafx.beans.property.ObjectProperty<javafx.util.Callback<LocalDatePicker.LocalDateRange,
Void>> localDateRangeCallback: This callback allows a developer to limit the amount of calendars put in any of the collections.javafx.beans.property.ObjectProperty<Locale>
Locale: the locale is used to determine first-day-of-week, weekday labels, etcjavafx.beans.property.ObjectProperty<LocalDatePicker.Mode>
Mode: single, range or multiplevalueValidationCallback: 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.collections.ObservableList<LocalDate>
private final javafx.beans.property.ObjectProperty<LocalDate>
private final javafx.collections.ObservableList<LocalDate>
private final javafx.beans.property.ObjectProperty<LocalDate>
private final javafx.beans.property.ObjectProperty<javafx.util.Callback<LocalDatePicker.LocalDateRange,
Void>> private final javafx.collections.ObservableList<LocalDate>
private javafx.beans.property.ObjectProperty<Locale>
private final javafx.beans.property.SimpleObjectProperty<LocalDatePicker.Mode>
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 localDate property) is an allowed state.private void
javafx.scene.control.Skin<LocalDatePicker>
javafx.collections.ObservableList<LocalDate>
disabledLocalDates: a list of dates that cannot be selected.javafx.beans.property.ObjectProperty<LocalDate>
DisplayedLocalDate:boolean
Gets the value of the property allowNull.Gets the value of the property displayedLocalDate.Gets the value of the property localDate.javafx.util.Callback<LocalDatePicker.LocalDateRange,
Void> Gets the value of the property localDateRangeCallback.Gets the value of the property locale.getMode()
Gets the value of the property mode.Gets the value of the property valueValidationCallback.javafx.collections.ObservableList<LocalDate>
highlightedLocalDates: a list of dates that are rendered with the highlight class added.javafx.beans.property.ObjectProperty<LocalDate>
LocalDate: the selected date, or when in RANGE or MULTIPLE mode, the last selected date.javafx.beans.property.ObjectProperty<javafx.util.Callback<LocalDatePicker.LocalDateRange,
Void>> localDateRangeCallback: This callback allows a developer to limit the amount of calendars put in any of the collections.javafx.collections.ObservableList<LocalDate>
LocalDates: a list of all selected dates.javafx.beans.property.ObjectProperty<Locale>
Locale: the locale is used to determine first-day-of-week, weekday labels, etcjavafx.beans.property.ObjectProperty<LocalDatePicker.Mode>
Mode: single, range or multiplevoid
setAllowNull
(boolean allowNull) Sets the value of the property allowNull.void
setDisplayedLocalDate
(LocalDate value) Sets the value of the property displayedLocalDate.void
setLocalDate
(LocalDate value) Sets the value of the property localDate.void
setLocalDateRangeCallback
(javafx.util.Callback<LocalDatePicker.LocalDateRange, Void> value) Sets the value of the property localDateRangeCallback.void
Sets the value of the property locale.void
setMode
(LocalDatePicker.Mode value) Sets the value of the property mode.void
setValueValidationCallback
(javafx.util.Callback<LocalDate, Boolean> value) Sets the value of the property valueValidationCallback.valueValidationCallback: This callback allows a developer deny or accept a value just prior before it gets added.withAllowNull
(boolean value) withDisplayedLocalDate
(LocalDate value) withLocalDate
(LocalDate value) withLocalDateRangeCallback
(javafx.util.Callback<LocalDatePicker.LocalDateRange, Void> value) withLocale
(Locale value) withMode
(LocalDatePicker.Mode value) withValueValidationCallback
(javafx.util.Callback<LocalDate, 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, getUserAgentStylesheet, 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
-
mode
Mode: single, range or multiple- See Also:
-
localDate
LocalDate: 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:
-
allowNull
public javafx.beans.property.BooleanProperty allowNullPropertyAllowNull: indicates if no selected date (resulting in null in the localDate property) is an allowed state.- See Also:
-
displayedLocalDate
DisplayedLocalDate: -
LocalDateRangeCallback
public javafx.beans.property.ObjectProperty<javafx.util.Callback<LocalDatePicker.LocalDateRange,Void>> LocalDateRangeCallbackPropertylocalDateRangeCallback: This callback allows a developer to limit the amount of calendars put in any of the collections. It is called just before a new range is being displayed, so the developer can change the values in the collections like highlighted or disabled. -
valueValidationCallback
public javafx.beans.property.ObjectProperty<javafx.util.Callback<LocalDate,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
-
modeObjectProperty
-
localDateObjectProperty
-
localDates
-
localeObjectProperty
-
allowNullProperty
private volatile javafx.beans.property.BooleanProperty allowNullProperty -
highlightedLocalDates
-
disabledLocalDates
-
displayedLocalDateObjectProperty
-
localDateRangeCallbackObjectProperty
private final javafx.beans.property.ObjectProperty<javafx.util.Callback<LocalDatePicker.LocalDateRange,Void>> localDateRangeCallbackObjectProperty -
valueValidationCallbackObjectProperty
-
-
Constructor Details
-
LocalDatePicker
public LocalDatePicker() -
LocalDatePicker
- Parameters:
localDateTime
-
-
-
Method Details
-
construct
private void construct() -
createDefaultSkin
- Overrides:
createDefaultSkin
in classjavafx.scene.control.Control
-
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
-
localDateProperty
LocalDate: the selected date, or when in RANGE or MULTIPLE mode, the last selected date.- See Also:
-
getLocalDate
Gets the value of the property localDate.- Property description:
- LocalDate: the selected date, or when in RANGE or MULTIPLE mode, the last selected date.
-
setLocalDate
Sets the value of the property localDate.- Property description:
- LocalDate: the selected date, or when in RANGE or MULTIPLE mode, the last selected date.
-
withLocalDate
-
localDates
LocalDates: a list of all selected dates. -
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
-
allowNullProperty
public javafx.beans.property.BooleanProperty allowNullProperty()AllowNull: indicates if no selected date (resulting in null in the localDate 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 localDate 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 localDate property) is an allowed state.
-
withAllowNull
-
highlightedLocalDates
highlightedLocalDates: a list of dates that are rendered with the highlight class added. This can then be styled using CSS. -
disabledLocalDates
disabledLocalDates: a list of dates that cannot be selected. -
displayedLocalDateProperty
DisplayedLocalDate: -
getDisplayedLocalDate
Gets the value of the property displayedLocalDate.- Property description:
- DisplayedLocalDate:
-
setDisplayedLocalDate
Sets the value of the property displayedLocalDate.- Property description:
- DisplayedLocalDate:
-
withDisplayedLocalDate
-
LocalDateRangeCallbackProperty
public javafx.beans.property.ObjectProperty<javafx.util.Callback<LocalDatePicker.LocalDateRange,Void>> LocalDateRangeCallbackProperty()localDateRangeCallback: This callback allows a developer to limit the amount of calendars put in any of the collections. It is called just before a new range is being displayed, so the developer can change the values in the collections like highlighted or disabled. -
getLocalDateRangeCallback
Gets the value of the property localDateRangeCallback.- Property description:
- localDateRangeCallback: This callback allows a developer to limit the amount of calendars put in any of the collections. It is called just before a new range is being displayed, so the developer can change the values in the collections like highlighted or disabled.
-
setLocalDateRangeCallback
public void setLocalDateRangeCallback(javafx.util.Callback<LocalDatePicker.LocalDateRange, Void> value) Sets the value of the property localDateRangeCallback.- Property description:
- localDateRangeCallback: This callback allows a developer to limit the amount of calendars put in any of the collections. It is called just before a new range is being displayed, so the developer can change the values in the collections like highlighted or disabled.
-
withLocalDateRangeCallback
public LocalDatePicker withLocalDateRangeCallback(javafx.util.Callback<LocalDatePicker.LocalDateRange, Void> value) -
valueValidationCallbackProperty
public javafx.beans.property.ObjectProperty<javafx.util.Callback<LocalDate,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
-