Class LocalDateTimePicker

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.control.Control
jfxtras.scene.control.LocalDateTimePicker
All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable

public class LocalDateTimePicker extends javafx.scene.control.Control
// These are used for the includes :control: LocalDateTimePicker :control_instance: LocalDateTimePicker :calendar: localDateTime :calendars: localDateTimes :calendar_class: LocalDateTime :calendars_class: LocalDateTimes = LocalDateTimePicker LocalDatePicker is a control for selecting one LocalDateTime (JSR-310). The name LocalDatePicker is because it uses Java's LocalDateTime (JSR-310) (as opposed to Date) in its API to do so. include::src/main/asciidoc/scene/control/CalendarPicker_properties.adoc[] == Callback include::src/main/asciidoc/scene/control/CalendarPicker_callbacks.adoc[]
  • Property Summary

    Properties
    Type
    Property
    Description
    javafx.beans.property.BooleanProperty
    AllowNull: indicates if no selected date (resulting in null in the localDateTime property) is an allowed state.
    javafx.beans.property.ObjectProperty<LocalDateTime>
    DisplayedLocalDateTime:
    javafx.beans.property.ObjectProperty<LocalDateTime>
    LocalDateTime:
    javafx.beans.property.ObjectProperty<javafx.util.Callback<LocalDateTimePicker.LocalDateTimeRange,Void>>
    localDateTimeRangeCallback: 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, etc
    javafx.beans.property.ObjectProperty<javafx.util.Callback<LocalDateTime,Boolean>>
    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 Classes
    Modifier and Type
    Class
    Description
    static class 
    A Calendar range
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private javafx.beans.property.BooleanProperty
     
    private final javafx.collections.ObservableList<LocalDateTime>
     
    private final javafx.beans.property.ObjectProperty<LocalDateTime>
     
    private final javafx.collections.ObservableList<LocalDateTime>
     
    private final javafx.beans.property.ObjectProperty<LocalDateTime>
     
    private final javafx.beans.property.ObjectProperty<javafx.util.Callback<LocalDateTimePicker.LocalDateTimeRange,Void>>
     
    private javafx.beans.property.ObjectProperty<Locale>
     
    private final javafx.beans.property.ObjectProperty<javafx.util.Callback<LocalDateTime,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
    Constructor
    Description
     
     
  • Method Summary

    Modifier and Type
    Method
    Description
    javafx.beans.property.BooleanProperty
    AllowNull: indicates if no selected date (resulting in null in the localDateTime property) is an allowed state.
    private void
     
    javafx.scene.control.Skin
     
    javafx.collections.ObservableList<LocalDateTime>
    DisabledLocalDateTimes: a list of dates that cannot be selected.
    javafx.beans.property.ObjectProperty<LocalDateTime>
    DisplayedLocalDateTime:
    boolean
    Gets the value of the allowNull property.
    Gets the value of the displayedLocalDateTime property.
    Gets the value of the localDateTime property.
    Gets the value of the localDateTimeRangeCallback property.
    Gets the value of the locale property.
    javafx.util.Callback<LocalDateTime,Boolean>
    Gets the value of the valueValidationCallback property.
    javafx.collections.ObservableList<LocalDateTime>
    HighlightedLocalDateTimes: a list of dates that are rendered with the highlight class added.
    javafx.beans.property.ObjectProperty<LocalDateTime>
    LocalDateTime:
    javafx.beans.property.ObjectProperty<javafx.util.Callback<LocalDateTimePicker.LocalDateTimeRange,Void>>
    localDateTimeRangeCallback: 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, etc
    void
    setAllowNull(boolean allowNull)
    Sets the value of the allowNull property.
    void
    Sets the value of the displayedLocalDateTime property.
    void
    Sets the value of the localDateTime property.
    void
    Sets the value of the localDateTimeRangeCallback property.
    void
    Sets the value of the locale property.
    void
    setValueValidationCallback(javafx.util.Callback<LocalDateTime,Boolean> value)
    Sets the value of the valueValidationCallback property.
    javafx.beans.property.ObjectProperty<javafx.util.Callback<LocalDateTime,Boolean>>
    valueValidationCallback: This callback allows a developer deny or accept a value just prior before it gets added.
    withAllowNull(boolean value)
     
     
     
     
     
    withValueValidationCallback(javafx.util.Callback<LocalDateTime,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

  • Field Details

    • localDateTimeObjectProperty

      private final javafx.beans.property.ObjectProperty<LocalDateTime> localDateTimeObjectProperty
    • displayedLocalDateTimeObjectProperty

      private final javafx.beans.property.ObjectProperty<LocalDateTime> displayedLocalDateTimeObjectProperty
    • localeObjectProperty

      private volatile javafx.beans.property.ObjectProperty<Locale> localeObjectProperty
    • allowNullProperty

      private volatile javafx.beans.property.BooleanProperty allowNullProperty
    • highlightedLocalDateTimes

      private final javafx.collections.ObservableList<LocalDateTime> highlightedLocalDateTimes
    • disabledLocalDateTimes

      private final javafx.collections.ObservableList<LocalDateTime> disabledLocalDateTimes
    • localDateTimeRangeCallbackObjectProperty

      private final javafx.beans.property.ObjectProperty<javafx.util.Callback<LocalDateTimePicker.LocalDateTimeRange,Void>> localDateTimeRangeCallbackObjectProperty
    • valueValidationCallbackObjectProperty

      private final javafx.beans.property.ObjectProperty<javafx.util.Callback<LocalDateTime,Boolean>> valueValidationCallbackObjectProperty
  • Constructor Details

    • LocalDateTimePicker

      public LocalDateTimePicker()
    • LocalDateTimePicker

      public LocalDateTimePicker(LocalDateTime localDateTime)
      Parameters:
      localDateTime -
  • Method Details

    • construct

      private void construct()
    • createDefaultSkin

      public javafx.scene.control.Skin createDefaultSkin()
      Overrides:
      createDefaultSkin in class javafx.scene.control.Control
    • localDateTimeProperty

      public javafx.beans.property.ObjectProperty<LocalDateTime> localDateTimeProperty()
      LocalDateTime:
      Returns:
      the localDateTime property
      See Also:
    • getLocalDateTime

      public LocalDateTime getLocalDateTime()
      Gets the value of the localDateTime property.
      Property description:
      LocalDateTime:
      Returns:
      the value of the localDateTime property
      See Also:
    • setLocalDateTime

      public void setLocalDateTime(LocalDateTime value)
      Sets the value of the localDateTime property.
      Property description:
      LocalDateTime:
      Parameters:
      value - the value for the localDateTime property
      See Also:
    • withLocalDateTime

      public LocalDateTimePicker withLocalDateTime(LocalDateTime value)
    • displayedLocalDateTimeProperty

      public javafx.beans.property.ObjectProperty<LocalDateTime> displayedLocalDateTimeProperty()
      DisplayedLocalDateTime:
      Returns:
      the displayedLocalDateTime property
      See Also:
    • getDisplayedLocalDateTime

      public LocalDateTime getDisplayedLocalDateTime()
      Gets the value of the displayedLocalDateTime property.
      Property description:
      DisplayedLocalDateTime:
      Returns:
      the value of the displayedLocalDateTime property
      See Also:
    • setDisplayedLocalDateTime

      public void setDisplayedLocalDateTime(LocalDateTime value)
      Sets the value of the displayedLocalDateTime property.
      Property description:
      DisplayedLocalDateTime:
      Parameters:
      value - the value for the displayedLocalDateTime property
      See Also:
    • withDisplayedLocalDateTime

      public LocalDateTimePicker withDisplayedLocalDateTime(LocalDateTime value)
    • localeProperty

      public javafx.beans.property.ObjectProperty<Locale> localeProperty()
      Locale: the locale is used to determine first-day-of-week, weekday labels, etc
      Returns:
      the locale property
      See Also:
    • getLocale

      public Locale getLocale()
      Gets the value of the locale property.
      Property description:
      Locale: the locale is used to determine first-day-of-week, weekday labels, etc
      Returns:
      the value of the locale property
      See Also:
    • setLocale

      public void setLocale(Locale value)
      Sets the value of the locale property.
      Property description:
      Locale: the locale is used to determine first-day-of-week, weekday labels, etc
      Parameters:
      value - the value for the locale property
      See Also:
    • withLocale

      public LocalDateTimePicker withLocale(Locale value)
    • allowNullProperty

      public javafx.beans.property.BooleanProperty allowNullProperty()
      AllowNull: indicates if no selected date (resulting in null in the localDateTime property) is an allowed state.
      Returns:
      the allowNull property
      See Also:
    • getAllowNull

      public boolean getAllowNull()
      Gets the value of the allowNull property.
      Property description:
      AllowNull: indicates if no selected date (resulting in null in the localDateTime property) is an allowed state.
      Returns:
      the value of the allowNull property
      See Also:
    • setAllowNull

      public void setAllowNull(boolean allowNull)
      Sets the value of the allowNull property.
      Property description:
      AllowNull: indicates if no selected date (resulting in null in the localDateTime property) is an allowed state.
      Parameters:
      allowNull - the value for the allowNull property
      See Also:
    • withAllowNull

      public LocalDateTimePicker withAllowNull(boolean value)
    • highlightedLocalDateTimes

      public javafx.collections.ObservableList<LocalDateTime> highlightedLocalDateTimes()
      HighlightedLocalDateTimes: a list of dates that are rendered with the highlight class added. This can then be styled using CSS.
    • disabledLocalDateTimes

      public javafx.collections.ObservableList<LocalDateTime> disabledLocalDateTimes()
      DisabledLocalDateTimes: a list of dates that cannot be selected.
    • LocalDateTimeRangeCallbackProperty

      public javafx.beans.property.ObjectProperty<javafx.util.Callback<LocalDateTimePicker.LocalDateTimeRange,Void>> LocalDateTimeRangeCallbackProperty()
      localDateTimeRangeCallback: 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.
      Returns:
      the LocalDateTimeRangeCallback property
      See Also:
    • getLocalDateTimeRangeCallback

      public javafx.util.Callback<LocalDateTimePicker.LocalDateTimeRange,Void> getLocalDateTimeRangeCallback()
      Gets the value of the localDateTimeRangeCallback property.
      Property description:
      localDateTimeRangeCallback: 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.
      Returns:
      the value of the localDateTimeRangeCallback property
      See Also:
    • setLocalDateTimeRangeCallback

      public void setLocalDateTimeRangeCallback(javafx.util.Callback<LocalDateTimePicker.LocalDateTimeRange,Void> value)
      Sets the value of the localDateTimeRangeCallback property.
      Property description:
      localDateTimeRangeCallback: 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.
      Parameters:
      value - the value for the localDateTimeRangeCallback property
      See Also:
    • withLocalDateTimeRangeCallback

      public LocalDateTimePicker withLocalDateTimeRangeCallback(javafx.util.Callback<LocalDateTimePicker.LocalDateTimeRange,Void> value)
    • valueValidationCallbackProperty

      public javafx.beans.property.ObjectProperty<javafx.util.Callback<LocalDateTime,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.
      Returns:
      the valueValidationCallback property
      See Also:
    • getValueValidationCallback

      public javafx.util.Callback<LocalDateTime,Boolean> getValueValidationCallback()
      Gets the value of the valueValidationCallback property.
      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.
      Returns:
      the value of the valueValidationCallback property
      See Also:
    • setValueValidationCallback

      public void setValueValidationCallback(javafx.util.Callback<LocalDateTime,Boolean> value)
      Sets the value of the valueValidationCallback property.
      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.
      Parameters:
      value - the value for the valueValidationCallback property
      See Also:
    • withValueValidationCallback

      public LocalDateTimePicker withValueValidationCallback(javafx.util.Callback<LocalDateTime,Boolean> value)