Class DateRangePicker

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.control.Control
javafx.scene.control.ComboBoxBase<DateRange>
com.dlsc.gemsfx.daterange.DateRangePicker
All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable
public class DateRangePicker extends javafx.scene.control.ComboBoxBase<DateRange>
A control to let the user select a date range (start date, end date) via two CalendarView instances or via a preset link.
See Also:

  • Property Summary

    Properties
    Type
    Property
    Description
    final javafx.beans.property.StringProperty
    customRangeText
    Stores the text shown when a custom date range has been selected by the user instead of a preset range.
    final javafx.beans.property.ObjectProperty<DateTimeFormatter>
    formatter
    The formatter used to convert the selected date / date range to text.
    final javafx.beans.property.BooleanProperty
    showIcon
    Determines if the picker will show the calendar icon in front of the selected date range.
    final javafx.beans.property.BooleanProperty
    showPresetTitle
    Determines if the picker will show the name of the selected preset in front of the selected date range, e.g.
    final javafx.beans.property.BooleanProperty
    small
    The picker can either display all of its information on two lines or in a single line (small).

    Properties inherited from class javafx.scene.control.ComboBoxBase

    armed, editable, onAction, onHidden, onHiding, onShowing, onShown, promptText, showing, value

    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

  • Field Summary

    Fields inherited from class javafx.scene.control.ComboBoxBase

    ON_HIDDEN, ON_HIDING, ON_SHOWING, ON_SHOWN

    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
    DateRangePicker()
    Constructs a new picker.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected javafx.scene.control.Skin<?>
    createDefaultSkin()
     
    final javafx.beans.property.StringProperty
    customRangeTextProperty()
    Stores the text shown when a custom date range has been selected by the user instead of a preset range.
    final javafx.beans.property.ObjectProperty<DateTimeFormatter>
    formatterProperty()
    The formatter used to convert the selected date / date range to text.
    final String
    getCustomRangeText()
    Gets the value of the customRangeText property.
    DateRangeView
    getDateRangeView()
    Returns the view that will be shown by this picker when expanded.
    final DateTimeFormatter
    getFormatter()
    Gets the value of the formatter property.
    String
    getUserAgentStylesheet()
     
    final boolean
    isShowIcon()
    Gets the value of the showIcon property.
    final boolean
    isShowPresetTitle()
    Gets the value of the showPresetTitle property.
    final boolean
    isSmall()
    Gets the value of the small property.
    final void
    setCustomRangeText(String customRangeText)
    Sets the value of the customRangeText property.
    final void
    setFormatter(DateTimeFormatter formatter)
    Sets the value of the formatter property.
    final void
    setShowIcon(boolean showIcon)
    Sets the value of the showIcon property.
    final void
    setShowPresetTitle(boolean showPresetTitle)
    Sets the value of the showPresetTitle property.
    final void
    setSmall(boolean small)
    Sets the value of the small property.
    final javafx.beans.property.BooleanProperty
    showIconProperty()
    Determines if the picker will show the calendar icon in front of the selected date range.
    final javafx.beans.property.BooleanProperty
    showPresetTitleProperty()
    Determines if the picker will show the name of the selected preset in front of the selected date range, e.g.
    final javafx.beans.property.BooleanProperty
    smallProperty()
    The picker can either display all of its information on two lines or in a single line (small).

    Methods inherited from class javafx.scene.control.ComboBoxBase

    arm, armedProperty, disarm, editableProperty, executeAccessibleAction, getOnAction, getOnHidden, getOnHiding, getOnShowing, getOnShown, getPromptText, getValue, hide, isArmed, isEditable, isShowing, onActionProperty, onHiddenProperty, onHidingProperty, onShowingProperty, onShownProperty, promptTextProperty, queryAccessibleAttribute, setEditable, setOnAction, setOnHidden, setOnHiding, setOnShowing, setOnShown, setPromptText, setValue, show, showingProperty, valueProperty

    Methods inherited from class javafx.scene.control.Control

    computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, getBaselineOffset, getClassCssMetaData, getContextMenu, getControlCssMetaData, getCssMetaData, getInitialFocusTraversable, getSkin, getTooltip, isResizable, layoutChildren, 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, requestFocusTraversal, 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 Object

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

    Methods inherited from interface javafx.css.Styleable

    getStyleableNode

  • Property Details

  • Constructor Details

    • DateRangePicker

      public DateRangePicker()
      Constructs a new picker.

  • 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

    • getDateRangeView

      public DateRangeView getDateRangeView()
      Returns the view that will be shown by this picker when expanded.
      Returns:
      the actual view when expanded

    • isShowIcon

      public final boolean isShowIcon()
      Gets the value of the showIcon property.
      Property description:
      Determines if the picker will show the calendar icon in front of the selected date range.
      Returns:
      the value of the showIcon property
      See Also:

    • showIconProperty

      public final javafx.beans.property.BooleanProperty showIconProperty()
      Determines if the picker will show the calendar icon in front of the selected date range.
      Returns:
      true if the icon will be shown
      See Also:

    • setShowIcon

      public final void setShowIcon(boolean showIcon)
      Sets the value of the showIcon property.
      Property description:
      Determines if the picker will show the calendar icon in front of the selected date range.
      Parameters:
      showIcon - the value for the showIcon property
      See Also:

    • isShowPresetTitle

      public final boolean isShowPresetTitle()
      Gets the value of the showPresetTitle property.
      Property description:
      Determines if the picker will show the name of the selected preset in front of the selected date range, e.g. "Last Week".
      Returns:
      the value of the showPresetTitle property
      See Also:

    • showPresetTitleProperty

      public final javafx.beans.property.BooleanProperty showPresetTitleProperty()
      Determines if the picker will show the name of the selected preset in front of the selected date range, e.g. "Last Week".
      Returns:
      true if the preset title will be shown
      See Also:

    • setShowPresetTitle

      public final void setShowPresetTitle(boolean showPresetTitle)
      Sets the value of the showPresetTitle property.
      Property description:
      Determines if the picker will show the name of the selected preset in front of the selected date range, e.g. "Last Week".
      Parameters:
      showPresetTitle - the value for the showPresetTitle property
      See Also:

    • isSmall

      public final boolean isSmall()
      Gets the value of the small property.
      Property description:
      The picker can either display all of its information on two lines or in a single line (small).
      Returns:
      the value of the small property
      See Also:

    • smallProperty

      public final javafx.beans.property.BooleanProperty smallProperty()
      The picker can either display all of its information on two lines or in a single line (small).
      Returns:
      true if the picker displays its value on a single line of text
      See Also:

    • setSmall

      public final void setSmall(boolean small)
      Sets the value of the small property.
      Property description:
      The picker can either display all of its information on two lines or in a single line (small).
      Parameters:
      small - the value for the small property
      See Also:

    • getFormatter

      public final DateTimeFormatter getFormatter()
      Gets the value of the formatter property.
      Property description:
      The formatter used to convert the selected date / date range to text.
      Returns:
      the value of the formatter property
      See Also:

    • formatterProperty

      public final javafx.beans.property.ObjectProperty<DateTimeFormatter> formatterProperty()
      The formatter used to convert the selected date / date range to text.
      Returns:
      the date formatter
      See Also:

    • setFormatter

      public final void setFormatter(DateTimeFormatter formatter)
      Sets the value of the formatter property.
      Property description:
      The formatter used to convert the selected date / date range to text.
      Parameters:
      formatter - the value for the formatter property
      See Also:

    • getCustomRangeText

      public final String getCustomRangeText()
      Gets the value of the customRangeText property.
      Property description:
      Stores the text shown when a custom date range has been selected by the user instead of a preset range.
      Returns:
      the value of the customRangeText property
      See Also:

    • customRangeTextProperty

      public final javafx.beans.property.StringProperty customRangeTextProperty()
      Stores the text shown when a custom date range has been selected by the user instead of a preset range.
      Returns:
      the text to show when a custom range has been selected
      See Also:

    • setCustomRangeText

      public final void setCustomRangeText(String customRangeText)
      Sets the value of the customRangeText property.
      Property description:
      Stores the text shown when a custom date range has been selected by the user instead of a preset range.
      Parameters:
      customRangeText - the value for the customRangeText property
      See Also: