Module com.dlsc.gemsfx
Package com.dlsc.gemsfx

Class TimePicker

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.control.Control
javafx.scene.control.ComboBoxBase<LocalTime>
com.dlsc.gemsfx.TimePicker
All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable
public class TimePicker extends javafx.scene.control.ComboBoxBase<LocalTime>
A control for letting the user enter a time of day (see LocalTime). The control can be configured to only enter a time within a given time range. It can also be configured to show hours and minutes, or hours and minutes and seconds, or hours and minutes and seconds and milliseconds (see formatProperty())

  • Property Summary

    Properties
    Type
    Property
    Description
    final javafx.beans.property.ReadOnlyBooleanProperty
    adjusted
     
    final javafx.beans.property.ObjectProperty<TimePicker.ClockType>
    clockType
    The clock type determines whether the control will display 24 or 12 hours.
    final javafx.beans.property.ObjectProperty<LocalTime>
    earliestTime
    The earliest time that the user can enter via the time picker.
    final javafx.beans.property.ObjectProperty<TimePicker.Format>
    format
    The format used by the picker, e.g.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    hoursSeparator
    The node that will be placed between the hours and the minutes field.
    final javafx.beans.property.ObjectProperty<LocalTime>
    latestTime
    The latest time that the user can enter via the time picker.
    final javafx.beans.property.BooleanProperty
    linkingFields
    A property used to control whether the fields should automatically increase or decrease the previous field when they reach their upper or lower limit.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    minutesSeparator
    The node that will be placed between the minutes and the seconds field.
    final javafx.beans.property.ObjectProperty<Consumer<TimePicker>>
    onShowPopup
    This consumer will be invoked to bring up a control for entering the time without using the keyboard.
    final javafx.beans.property.BooleanProperty
    rollover
    A flag used to signal whether the time fields should start at the beginning of its value range when it reaches the end of it.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    secondsSeparator
    The node that will be placed between the seconds and the milliseconds field.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    separator
    Deprecated.
    final javafx.beans.property.BooleanProperty
    showPopupTriggerButton
    Determines if the control will show a button for showing or hiding the popup.
    final javafx.beans.property.IntegerProperty
    stepRateInMinutes
    Stores the "step rate" used by the control when the user increases or decreases the minutes field.
    final javafx.beans.property.ObjectProperty<LocalTime>
    time
    Stores the current time displayed by the control.

    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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    TimePicker.ClockType
    The time picker control supports 12 and 24 hour times.
    static enum 
    TimePicker.Format
    An enum for supported time units.

  • 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
    TimePicker()
    Constructs a new time picker.

  • Method Summary

    Modifier and Type
    Method
    Description
    final void
    adjust()
    Adjusts the time picker's time based on the earliest and latest time allowed and also based on the step rate currently in effect.
    final javafx.beans.property.ReadOnlyBooleanProperty
    adjustedProperty()
     
    final javafx.beans.property.ObjectProperty<TimePicker.ClockType>
    clockTypeProperty()
    The clock type determines whether the control will display 24 or 12 hours.
    protected javafx.scene.control.Skin<?>
    createDefaultSkin()
     
    final javafx.beans.property.ObjectProperty<LocalTime>
    earliestTimeProperty()
    The earliest time that the user can enter via the time picker.
    final javafx.beans.property.ObjectProperty<TimePicker.Format>
    formatProperty()
    The format used by the picker, e.g.
    final TimePicker.ClockType
    getClockType()
    Gets the value of the clockType property.
    final LocalTime
    getEarliestTime()
    Gets the value of the earliestTime property.
    final TimePicker.Format
    getFormat()
    Gets the value of the format property.
    final javafx.scene.Node
    getHoursSeparator()
    Gets the value of the hoursSeparator property.
    final LocalTime
    getLatestTime()
    Gets the value of the latestTime property.
    final javafx.scene.Node
    getMinutesSeparator()
    Gets the value of the minutesSeparator property.
    final Consumer<TimePicker>
    getOnShowPopup()
    Gets the value of the onShowPopup property.
    final javafx.scene.Node
    getSecondsSeparator()
    Gets the value of the secondsSeparator property.
    final javafx.scene.Node
    getSeparator()
    Deprecated.
    final int
    getStepRateInMinutes()
    Gets the value of the stepRateInMinutes property.
    final LocalTime
    getTime()
    Gets the value of the time property.
    String
    getUserAgentStylesheet()
     
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    hoursSeparatorProperty()
    The node that will be placed between the hours and the minutes field.
    final boolean
    isAdjusted()
    Gets the value of the adjusted property.
    final boolean
    isLinkingFields()
    Gets the value of the linkingFields property.
    final boolean
    isRollover()
    Gets the value of the rollover property.
    final boolean
    isShowPopupTriggerButton()
    Gets the value of the showPopupTriggerButton property.
    final javafx.beans.property.ObjectProperty<LocalTime>
    latestTimeProperty()
    The latest time that the user can enter via the time picker.
    final javafx.beans.property.BooleanProperty
    linkingFieldsProperty()
    A property used to control whether the fields should automatically increase or decrease the previous field when they reach their upper or lower limit.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    minutesSeparatorProperty()
    The node that will be placed between the minutes and the seconds field.
    final javafx.beans.property.ObjectProperty<Consumer<TimePicker>>
    onShowPopupProperty()
    This consumer will be invoked to bring up a control for entering the time without using the keyboard.
    final javafx.beans.property.BooleanProperty
    rolloverProperty()
    A flag used to signal whether the time fields should start at the beginning of its value range when it reaches the end of it.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    secondsSeparatorProperty()
    The node that will be placed between the seconds and the milliseconds field.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    separatorProperty()
    Deprecated.
    final void
    setClockType(TimePicker.ClockType clockType)
    Sets the value of the clockType property.
    final void
    setEarliestTime(LocalTime earliestTime)
    Sets the value of the earliestTime property.
    final void
    setFormat(TimePicker.Format timeUnit)
    Sets the value of the format property.
    final void
    setHoursSeparator(javafx.scene.Node separator)
    Sets the value of the hoursSeparator property.
    final void
    setLatestTime(LocalTime latestTime)
    Sets the value of the latestTime property.
    final void
    setLinkingFields(boolean linkingFields)
    Sets the value of the linkingFields property.
    final void
    setMinutesSeparator(javafx.scene.Node separator)
    Sets the value of the minutesSeparator property.
    final void
    setOnShowPopup(Consumer<TimePicker> onShowPopup)
    Sets the value of the onShowPopup property.
    final void
    setRollover(boolean rollover)
    Sets the value of the rollover property.
    final void
    setSecondsSeparator(javafx.scene.Node separator)
    Sets the value of the secondsSeparator property.
    final void
    setSeparator(javafx.scene.Node separator)
    Deprecated.
    final void
    setShowPopupTriggerButton(boolean showPopupTriggerButton)
    Sets the value of the showPopupTriggerButton property.
    final void
    setStepRateInMinutes(int stepRateInMinutes)
    Sets the value of the stepRateInMinutes property.
    final void
    setTime(LocalTime time)
    Sets the value of the time property.
    final javafx.beans.property.BooleanProperty
    showPopupTriggerButtonProperty()
    Determines if the control will show a button for showing or hiding the popup.
    final javafx.beans.property.IntegerProperty
    stepRateInMinutesProperty()
    Stores the "step rate" used by the control when the user increases or decreases the minutes field.
    final javafx.beans.property.ObjectProperty<LocalTime>
    timeProperty()
    Stores the current time displayed by the control.

    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, 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

    • TimePicker

      public TimePicker()
      Constructs a new time picker.

  • Method Details

    • isAdjusted

      public final boolean isAdjusted()
      Gets the value of the adjusted property.
      Property description:
      Returns:
      the value of the adjusted property
      See Also:

    • adjustedProperty

      public final javafx.beans.property.ReadOnlyBooleanProperty adjustedProperty()
      Returns:
      the adjusted property
      See Also:

    • 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

    • getEarliestTime

      public final LocalTime getEarliestTime()
      Gets the value of the earliestTime property.
      Property description:
      The earliest time that the user can enter via the time picker.
      Returns:
      the value of the earliestTime property
      See Also:

    • earliestTimeProperty

      public final javafx.beans.property.ObjectProperty<LocalTime> earliestTimeProperty()
      The earliest time that the user can enter via the time picker.
      Returns:
      the earliest time allowed
      See Also:

    • setEarliestTime

      public final void setEarliestTime(LocalTime earliestTime)
      Sets the value of the earliestTime property.
      Property description:
      The earliest time that the user can enter via the time picker.
      Parameters:
      earliestTime - the value for the earliestTime property
      See Also:

    • getLatestTime

      public final LocalTime getLatestTime()
      Gets the value of the latestTime property.
      Property description:
      The latest time that the user can enter via the time picker.
      Returns:
      the value of the latestTime property
      See Also:

    • latestTimeProperty

      public final javafx.beans.property.ObjectProperty<LocalTime> latestTimeProperty()
      The latest time that the user can enter via the time picker.
      Returns:
      the latest time allowed
      See Also:

    • setLatestTime

      public final void setLatestTime(LocalTime latestTime)
      Sets the value of the latestTime property.
      Property description:
      The latest time that the user can enter via the time picker.
      Parameters:
      latestTime - the value for the latestTime property
      See Also:

    • getSeparator

      @Deprecated public final javafx.scene.Node getSeparator()
      Deprecated.
      Gets the value of the separator property.
      Property description:
      The node that will be placed between the hours and the minutes field. The default separator is a label with text ":".
      Returns:
      the value of the separator property
      See Also:

    • separatorProperty

      @Deprecated public final javafx.beans.property.ObjectProperty<javafx.scene.Node> separatorProperty()
      Deprecated.
      The node that will be placed between the hours and the minutes field. The default separator is a label with text ":".
      Returns:
      a node used as a hoursSeparator
      See Also:

    • setSeparator

      @Deprecated public final void setSeparator(javafx.scene.Node separator)
      Deprecated.
      Sets the value of the separator property.
      Property description:
      The node that will be placed between the hours and the minutes field. The default separator is a label with text ":".
      Parameters:
      separator - the value for the separator property
      See Also:

    • getHoursSeparator

      public final javafx.scene.Node getHoursSeparator()
      Gets the value of the hoursSeparator property.
      Property description:
      The node that will be placed between the hours and the minutes field. The default separator is a label with text ":".
      Returns:
      the value of the hoursSeparator property
      See Also:

    • hoursSeparatorProperty

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> hoursSeparatorProperty()
      The node that will be placed between the hours and the minutes field. The default separator is a label with text ":".
      Returns:
      a node used as a hoursSeparator
      See Also:

    • setHoursSeparator

      public final void setHoursSeparator(javafx.scene.Node separator)
      Sets the value of the hoursSeparator property.
      Property description:
      The node that will be placed between the hours and the minutes field. The default separator is a label with text ":".
      Parameters:
      separator - the value for the hoursSeparator property
      See Also:

    • isShowPopupTriggerButton

      public final boolean isShowPopupTriggerButton()
      Gets the value of the showPopupTriggerButton property.
      Property description:
      Determines if the control will show a button for showing or hiding the popup.
      Returns:
      the value of the showPopupTriggerButton property
      See Also:

    • showPopupTriggerButtonProperty

      public final javafx.beans.property.BooleanProperty showPopupTriggerButtonProperty()
      Determines if the control will show a button for showing or hiding the popup.
      Returns:
      true if the control will show a button for showing the popup
      See Also:

    • setShowPopupTriggerButton

      public final void setShowPopupTriggerButton(boolean showPopupTriggerButton)
      Sets the value of the showPopupTriggerButton property.
      Property description:
      Determines if the control will show a button for showing or hiding the popup.
      Parameters:
      showPopupTriggerButton - the value for the showPopupTriggerButton property
      See Also:

    • adjust

      public final void adjust()
      Adjusts the time picker's time based on the earliest and latest time allowed and also based on the step rate currently in effect.

    • getTime

      public final LocalTime getTime()
      Gets the value of the time property.
      Property description:
      Stores the current time displayed by the control.
      Returns:
      the value of the time property
      See Also:

    • timeProperty

      public final javafx.beans.property.ObjectProperty<LocalTime> timeProperty()
      Stores the current time displayed by the control.
      Returns:
      the chosen time
      See Also:

    • setTime

      public final void setTime(LocalTime time)
      Sets the value of the time property.
      Property description:
      Stores the current time displayed by the control.
      Parameters:
      time - the value for the time property
      See Also:

    • getStepRateInMinutes

      public final int getStepRateInMinutes()
      Gets the value of the stepRateInMinutes property.
      Property description:
      Stores the "step rate" used by the control when the user increases or decreases the minutes field. The step rate can be used to (for example) make the minutes increase or decrease by 15 minutes every time the user presses the arrow up or down keys.
      Returns:
      the value of the stepRateInMinutes property
      See Also:

    • stepRateInMinutesProperty

      public final javafx.beans.property.IntegerProperty stepRateInMinutesProperty()
      Stores the "step rate" used by the control when the user increases or decreases the minutes field. The step rate can be used to (for example) make the minutes increase or decrease by 15 minutes every time the user presses the arrow up or down keys.
      Returns:
      the step rate in minutes
      See Also:

    • setStepRateInMinutes

      public final void setStepRateInMinutes(int stepRateInMinutes)
      Sets the value of the stepRateInMinutes property.
      Property description:
      Stores the "step rate" used by the control when the user increases or decreases the minutes field. The step rate can be used to (for example) make the minutes increase or decrease by 15 minutes every time the user presses the arrow up or down keys.
      Parameters:
      stepRateInMinutes - the value for the stepRateInMinutes property
      See Also:

    • getClockType

      public final TimePicker.ClockType getClockType()
      Gets the value of the clockType property.
      Property description:
      The clock type determines whether the control will display 24 or 12 hours. If the control shows 12 hours then an additional field for choosing between the "am" or "pm" meridian will be added.
      Returns:
      the value of the clockType property
      See Also:

    • clockTypeProperty

      public final javafx.beans.property.ObjectProperty<TimePicker.ClockType> clockTypeProperty()
      The clock type determines whether the control will display 24 or 12 hours. If the control shows 12 hours then an additional field for choosing between the "am" or "pm" meridian will be added.
      Returns:
      the type of the clock
      See Also:

    • setClockType

      public final void setClockType(TimePicker.ClockType clockType)
      Sets the value of the clockType property.
      Property description:
      The clock type determines whether the control will display 24 or 12 hours. If the control shows 12 hours then an additional field for choosing between the "am" or "pm" meridian will be added.
      Parameters:
      clockType - the value for the clockType property
      See Also:

    • isLinkingFields

      public final boolean isLinkingFields()
      Gets the value of the linkingFields property.
      Property description:
      A property used to control whether the fields should automatically increase or decrease the previous field when they reach their upper or lower limit.
      Returns:
      the value of the linkingFields property
      See Also:

    • linkingFieldsProperty

      public final javafx.beans.property.BooleanProperty linkingFieldsProperty()
      A property used to control whether the fields should automatically increase or decrease the previous field when they reach their upper or lower limit.
      Returns:
      true if rollover is desired
      See Also:

    • setLinkingFields

      public final void setLinkingFields(boolean linkingFields)
      Sets the value of the linkingFields property.
      Property description:
      A property used to control whether the fields should automatically increase or decrease the previous field when they reach their upper or lower limit.
      Parameters:
      linkingFields - the value for the linkingFields property
      See Also:

    • isRollover

      public final boolean isRollover()
      Gets the value of the rollover property.
      Property description:
      A flag used to signal whether the time fields should start at the beginning of its value range when it reaches the end of it. E.g. incrementing hour 23 would result in hour 0 when the user tries to increase it by one.
      Returns:
      the value of the rollover property
      See Also:

    • rolloverProperty

      public final javafx.beans.property.BooleanProperty rolloverProperty()
      A flag used to signal whether the time fields should start at the beginning of its value range when it reaches the end of it. E.g. incrementing hour 23 would result in hour 0 when the user tries to increase it by one.
      Returns:
      true if the fields should rollover
      See Also:

    • setRollover

      public final void setRollover(boolean rollover)
      Sets the value of the rollover property.
      Property description:
      A flag used to signal whether the time fields should start at the beginning of its value range when it reaches the end of it. E.g. incrementing hour 23 would result in hour 0 when the user tries to increase it by one.
      Parameters:
      rollover - the value for the rollover property
      See Also:

    • getOnShowPopup

      public final Consumer<TimePicker> getOnShowPopup()
      Gets the value of the onShowPopup property.
      Property description:
      This consumer will be invoked to bring up a control for entering the time without using the keyboard. The default implementation shows a popup.
      Returns:
      the value of the onShowPopup property
      See Also:

    • onShowPopupProperty

      public final javafx.beans.property.ObjectProperty<Consumer<TimePicker>> onShowPopupProperty()
      This consumer will be invoked to bring up a control for entering the time without using the keyboard. The default implementation shows a popup.
      Returns:
      the "on show popup" consumer
      See Also:

    • setOnShowPopup

      public final void setOnShowPopup(Consumer<TimePicker> onShowPopup)
      Sets the value of the onShowPopup property.
      Property description:
      This consumer will be invoked to bring up a control for entering the time without using the keyboard. The default implementation shows a popup.
      Parameters:
      onShowPopup - the value for the onShowPopup property
      See Also:

    • formatProperty

      public final javafx.beans.property.ObjectProperty<TimePicker.Format> formatProperty()
      The format used by the picker, e.g. "hours and minutes", or "hours, minutes, and seconds".
      Returns:
      the time unit
      See Also:

    • getFormat

      public final TimePicker.Format getFormat()
      Gets the value of the format property.
      Property description:
      The format used by the picker, e.g. "hours and minutes", or "hours, minutes, and seconds".
      Returns:
      the value of the format property
      See Also:

    • setFormat

      public final void setFormat(TimePicker.Format timeUnit)
      Sets the value of the format property.
      Property description:
      The format used by the picker, e.g. "hours and minutes", or "hours, minutes, and seconds".
      Parameters:
      timeUnit - the value for the format property
      See Also:

    • getMinutesSeparator

      public final javafx.scene.Node getMinutesSeparator()
      Gets the value of the minutesSeparator property.
      Property description:
      The node that will be placed between the minutes and the seconds field. The default separator is a label with text ":".
      Returns:
      the value of the minutesSeparator property
      See Also:

    • minutesSeparatorProperty

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> minutesSeparatorProperty()
      The node that will be placed between the minutes and the seconds field. The default separator is a label with text ":".
      Returns:
      a node used as a hoursSeparator
      See Also:

    • setMinutesSeparator

      public final void setMinutesSeparator(javafx.scene.Node separator)
      Sets the value of the minutesSeparator property.
      Property description:
      The node that will be placed between the minutes and the seconds field. The default separator is a label with text ":".
      Parameters:
      separator - the value for the minutesSeparator property
      See Also:

    • getSecondsSeparator

      public final javafx.scene.Node getSecondsSeparator()
      Gets the value of the secondsSeparator property.
      Property description:
      The node that will be placed between the seconds and the milliseconds field. The default separator is a label with text ".".
      Returns:
      the value of the secondsSeparator property
      See Also:

    • secondsSeparatorProperty

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> secondsSeparatorProperty()
      The node that will be placed between the seconds and the milliseconds field. The default separator is a label with text ".".
      Returns:
      a node used as a hoursSeparator
      See Also:

    • setSecondsSeparator

      public final void setSecondsSeparator(javafx.scene.Node separator)
      Sets the value of the secondsSeparator property.
      Property description:
      The node that will be placed between the seconds and the milliseconds field. The default separator is a label with text ".".
      Parameters:
      separator - the value for the secondsSeparator property
      See Also: