Class HistoryButton<T>

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.control.Control
javafx.scene.control.Labeled
javafx.scene.control.ButtonBase
javafx.scene.control.Button
com.dlsc.gemsfx.HistoryButton<T>
Type Parameters:
T - the type of the objects that this button manages in its history
All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable
public class HistoryButton<T> extends javafx.scene.control.Button
A custom button that manages and displays a history of entries based on a generic type T. This button integrates directly with a HistoryManager to present a list of previously used items to the user. The user can then pick one of those items to set a value on an input field.

Usage scenarios include search fields, form inputs, or any other component where users might benefit from being able to see and interact with their previous entries. The generic type T allows for flexibility, making it suitable for various data types that can represent user input history.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    class 
    HistoryButton.HistoryPopup
    The popup used by the HistoryButton to display a list view with the previously used items.
    class 
    HistoryButton.HistoryPopupSkin
    The skin used for the HistoryButton<T>.HistoryPopup.

  • Property Summary

    Properties
    Type
    Property
    Description
    final javafx.beans.property.ObjectProperty<javafx.util.Callback<javafx.scene.control.ListView<T>, javafx.scene.control.ListCell<T>>>
    cellFactory
    The cell factory for the history popup list view.
    final javafx.beans.property.ObjectProperty<HistoryManager<T>>
    historyManager
    The history manager that is used for persisting the history of the button.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    listDecorationBottom
    The list used by the popup to show previously used items can be easily decorated by specifying nodes for its left, right, top, and / or bottom sides.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    listDecorationLeft
    The list used by the popup to show previously used items can be easily decorated by specifying nodes for its left, right, top, and / or bottom sides.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    listDecorationRight
    The list used by the popup to show previously used items can be easily decorated by specifying nodes for its left, right, top, and / or bottom sides.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    listDecorationTop
    The list used by the popup to show previously used items can be easily decorated by specifying nodes for its left, right, top, and / or bottom sides.
    final javafx.beans.property.ObjectProperty<Consumer<T>>
    onItemSelected
    Returns the property representing the callback function to be executed when a history item within the list view is either clicked directly or selected via the ENTER key press.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    owner
    The (optional) "owner" of a history button can be a textfield where the button is shown inside the field.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    placeholder
    Returns the property representing the history placeholder node.
    final javafx.beans.property.ReadOnlyBooleanProperty
    popupShowing
    Indicates whether the history popup is showing.

    Properties inherited from class javafx.scene.control.Button

    cancelButton, defaultButton

    Properties inherited from class javafx.scene.control.ButtonBase

    armed, onAction

    Properties inherited from class javafx.scene.control.Labeled

    alignment, contentDisplay, ellipsisString, font, graphic, graphicTextGap, labelPadding, lineSpacing, mnemonicParsing, textAlignment, textFill, textOverrun, text, textTruncated, underline, wrapText

    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.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
    HistoryButton()
    Creates a new instance of the history button.
    HistoryButton(javafx.scene.Node owner)
    Creates a new instance of the history button where the button will be used in combination with the given node.

  • Method Summary

    Modifier and Type
    Method
    Description
    final javafx.beans.property.ObjectProperty<javafx.util.Callback<javafx.scene.control.ListView<T>, javafx.scene.control.ListCell<T>>>
    cellFactoryProperty()
    The cell factory for the history popup list view.
    final javafx.util.Callback<javafx.scene.control.ListView<T>, javafx.scene.control.ListCell<T>>
    getCellFactory()
    Gets the value of the cellFactory property.
    final HistoryManager<T>
    getHistoryManager()
    Gets the value of the historyManager property.
    final javafx.scene.Node
    getListDecorationBottom()
    Gets the value of the listDecorationBottom property.
    final javafx.scene.Node
    getListDecorationLeft()
    Gets the value of the listDecorationLeft property.
    final javafx.scene.Node
    getListDecorationRight()
    Gets the value of the listDecorationRight property.
    final javafx.scene.Node
    getListDecorationTop()
    Gets the value of the listDecorationTop property.
    final Consumer<T>
    getOnItemSelected()
    Gets the value of the onItemSelected property.
    final javafx.scene.Node
    getOwner()
    Gets the value of the owner property.
    final javafx.scene.Node
    getPlaceholder()
    Gets the value of the placeholder property.
    void
    hidePopup()
    Hides the popup that is showing the history items.
    final javafx.beans.property.ObjectProperty<HistoryManager<T>>
    historyManagerProperty()
    The history manager that is used for persisting the history of the button.
    final boolean
    isPopupShowing()
    Gets the value of the popupShowing property.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    listDecorationBottomProperty()
    The list used by the popup to show previously used items can be easily decorated by specifying nodes for its left, right, top, and / or bottom sides.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    listDecorationLeftProperty()
    The list used by the popup to show previously used items can be easily decorated by specifying nodes for its left, right, top, and / or bottom sides.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    listDecorationRightProperty()
    The list used by the popup to show previously used items can be easily decorated by specifying nodes for its left, right, top, and / or bottom sides.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    listDecorationTopProperty()
    The list used by the popup to show previously used items can be easily decorated by specifying nodes for its left, right, top, and / or bottom sides.
    final javafx.beans.property.ObjectProperty<Consumer<T>>
    onItemSelectedProperty()
    Returns the property representing the callback function to be executed when a history item within the list view is either clicked directly or selected via the ENTER key press.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    ownerProperty()
    The (optional) "owner" of a history button can be a textfield where the button is shown inside the field.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    placeholderProperty()
    Returns the property representing the history placeholder node.
    final javafx.beans.property.ReadOnlyBooleanProperty
    popupShowingProperty()
    Indicates whether the history popup is showing.
    final void
    setCellFactory(javafx.util.Callback<javafx.scene.control.ListView<T>, javafx.scene.control.ListCell<T>> cellFactory)
    Sets the value of the cellFactory property.
    final void
    setHistoryManager(HistoryManager<T> historyManager)
    Sets the value of the historyManager property.
    final void
    setListDecorationBottom(javafx.scene.Node listDecorationBottom)
    Sets the value of the listDecorationBottom property.
    final void
    setListDecorationLeft(javafx.scene.Node listDecorationLeft)
    Sets the value of the listDecorationLeft property.
    final void
    setListDecorationRight(javafx.scene.Node listDecorationRight)
    Sets the value of the listDecorationRight property.
    final void
    setListDecorationTop(javafx.scene.Node listDecorationTop)
    Sets the value of the listDecorationTop property.
    final void
    setOnItemSelected(Consumer<T> onItemSelected)
    Sets the value of the onItemSelected property.
    final void
    setOwner(javafx.scene.Node owner)
    Sets the value of the owner property.
    final void
    setPlaceholder(javafx.scene.Node placeholder)
    Sets the value of the placeholder property.
    void
    showPopup()
    Shows the popup that includes the list view with the items stored by the history manager.

    Methods inherited from class javafx.scene.control.Button

    cancelButtonProperty, createDefaultSkin, defaultButtonProperty, fire, isCancelButton, isDefaultButton, setCancelButton, setDefaultButton

    Methods inherited from class javafx.scene.control.ButtonBase

    arm, armedProperty, disarm, executeAccessibleAction, getOnAction, isArmed, onActionProperty, setOnAction

    Methods inherited from class javafx.scene.control.Labeled

    alignmentProperty, contentDisplayProperty, ellipsisStringProperty, fontProperty, getAlignment, getClassCssMetaData, getContentBias, getContentDisplay, getControlCssMetaData, getEllipsisString, getFont, getGraphic, getGraphicTextGap, getInitialAlignment, getLabelPadding, getLineSpacing, getText, getTextAlignment, getTextFill, getTextOverrun, graphicProperty, graphicTextGapProperty, isMnemonicParsing, isTextTruncated, isUnderline, isWrapText, labelPaddingProperty, lineSpacingProperty, mnemonicParsingProperty, setAlignment, setContentDisplay, setEllipsisString, setFont, setGraphic, setGraphicTextGap, setLineSpacing, setMnemonicParsing, setText, setTextAlignment, setTextFill, setTextOverrun, setUnderline, setWrapText, textAlignmentProperty, textFillProperty, textOverrunProperty, textProperty, textTruncatedProperty, toString, underlineProperty, wrapTextProperty

    Methods inherited from class javafx.scene.control.Control

    computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, getBaselineOffset, getContextMenu, 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, focusVisibleProperty, focusWithinProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, 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, 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

    • placeholder

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> placeholderProperty
      Returns the property representing the history placeholder node.
      See Also:

    • onItemSelected

      public final javafx.beans.property.ObjectProperty<Consumer<T>> onItemSelectedProperty
      Returns the property representing the callback function to be executed when a history item within the list view is either clicked directly or selected via the ENTER key press. This property enables setting a custom callback function that will be invoked with the text of the clicked or selected history item as the argument.
      See Also:

    • historyManager

      public final javafx.beans.property.ObjectProperty<HistoryManager<T>> historyManagerProperty
      The history manager that is used for persisting the history of the button.

      If its value is null, clicking the button will not display the history popup.

      If its value is not null, clicking the button will display a popup showing the items previously stored for this button.

      See Also:

    • owner

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> ownerProperty
      The (optional) "owner" of a history button can be a textfield where the button is shown inside the field.
      See Also:

    • listDecorationLeft

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> listDecorationLeftProperty
      The list used by the popup to show previously used items can be easily decorated by specifying nodes for its left, right, top, and / or bottom sides. This property stores an optional node for the left side.
      See Also:

    • listDecorationRight

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> listDecorationRightProperty
      The list used by the popup to show previously used items can be easily decorated by specifying nodes for its left, right, top, and / or bottom sides. This property stores an optional node for the right side.
      See Also:

    • listDecorationTop

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> listDecorationTopProperty
      The list used by the popup to show previously used items can be easily decorated by specifying nodes for its left, right, top, and / or bottom sides. This property stores an optional node for the top side.
      See Also:

    • listDecorationBottom

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> listDecorationBottomProperty
      The list used by the popup to show previously used items can be easily decorated by specifying nodes for its left, right, top, and / or bottom sides. This property stores an optional node for the bottom side.
      See Also:

    • cellFactory

      public final javafx.beans.property.ObjectProperty<javafx.util.Callback<javafx.scene.control.ListView<T>, javafx.scene.control.ListCell<T>>> cellFactoryProperty
      The cell factory for the history popup list view.
      See Also:

    • popupShowing

      public final javafx.beans.property.ReadOnlyBooleanProperty popupShowingProperty
      Indicates whether the history popup is showing. This is a read-only property.
      See Also:

  • Constructor Details

    • HistoryButton

      public HistoryButton()
      Creates a new instance of the history button.

    • HistoryButton

      public HistoryButton(javafx.scene.Node owner)
      Creates a new instance of the history button where the button will be used in combination with the given node.
      Parameters:
      owner - the owner of the button, used for focus management.

  • Method Details

    • showPopup

      public void showPopup()
      Shows the popup that includes the list view with the items stored by the history manager.

    • hidePopup

      public void hidePopup()
      Hides the popup that is showing the history items.

    • placeholderProperty

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> placeholderProperty()
      Returns the property representing the history placeholder node.
      Returns:
      the property representing the history placeholder node
      See Also:

    • getPlaceholder

      public final javafx.scene.Node getPlaceholder()
      Gets the value of the placeholder property.
      Property description:
      Returns the property representing the history placeholder node.
      Returns:
      the value of the placeholder property
      See Also:

    • setPlaceholder

      public final void setPlaceholder(javafx.scene.Node placeholder)
      Sets the value of the placeholder property.
      Property description:
      Returns the property representing the history placeholder node.
      Parameters:
      placeholder - the value for the placeholder property
      See Also:

    • getOnItemSelected

      public final Consumer<T> getOnItemSelected()
      Gets the value of the onItemSelected property.
      Property description:
      Returns the property representing the callback function to be executed when a history item within the list view is either clicked directly or selected via the ENTER key press. This property enables setting a custom callback function that will be invoked with the text of the clicked or selected history item as the argument.
      Returns:
      the value of the onItemSelected property
      See Also:

    • onItemSelectedProperty

      public final javafx.beans.property.ObjectProperty<Consumer<T>> onItemSelectedProperty()
      Returns the property representing the callback function to be executed when a history item within the list view is either clicked directly or selected via the ENTER key press. This property enables setting a custom callback function that will be invoked with the text of the clicked or selected history item as the argument.
      Returns:
      the property storing the "on history item confirmed" callback function.
      See Also:

    • setOnItemSelected

      public final void setOnItemSelected(Consumer<T> onItemSelected)
      Sets the value of the onItemSelected property.
      Property description:
      Returns the property representing the callback function to be executed when a history item within the list view is either clicked directly or selected via the ENTER key press. This property enables setting a custom callback function that will be invoked with the text of the clicked or selected history item as the argument.
      Parameters:
      onItemSelected - the value for the onItemSelected property
      See Also:

    • isPopupShowing

      public final boolean isPopupShowing()
      Gets the value of the popupShowing property.
      Property description:
      Indicates whether the history popup is showing. This is a read-only property.
      Returns:
      the value of the popupShowing property
      See Also:

    • historyManagerProperty

      public final javafx.beans.property.ObjectProperty<HistoryManager<T>> historyManagerProperty()
      The history manager that is used for persisting the history of the button.

      If its value is null, clicking the button will not display the history popup.

      If its value is not null, clicking the button will display a popup showing the items previously stored for this button.

      Returns:
      the property representing the history manager
      See Also:

    • setHistoryManager

      public final void setHistoryManager(HistoryManager<T> historyManager)
      Sets the value of the historyManager property.
      Property description:
      The history manager that is used for persisting the history of the button.

      If its value is null, clicking the button will not display the history popup.

      If its value is not null, clicking the button will display a popup showing the items previously stored for this button.

      Parameters:
      historyManager - the value for the historyManager property
      See Also:

    • getHistoryManager

      public final HistoryManager<T> getHistoryManager()
      Gets the value of the historyManager property.
      Property description:
      The history manager that is used for persisting the history of the button.

      If its value is null, clicking the button will not display the history popup.

      If its value is not null, clicking the button will display a popup showing the items previously stored for this button.

      Returns:
      the value of the historyManager property
      See Also:

    • ownerProperty

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> ownerProperty()
      The (optional) "owner" of a history button can be a textfield where the button is shown inside the field.
      Returns:
      the owning node, e.g. a text field.
      See Also:

    • getOwner

      public final javafx.scene.Node getOwner()
      Gets the value of the owner property.
      Property description:
      The (optional) "owner" of a history button can be a textfield where the button is shown inside the field.
      Returns:
      the value of the owner property
      See Also:

    • setOwner

      public final void setOwner(javafx.scene.Node owner)
      Sets the value of the owner property.
      Property description:
      The (optional) "owner" of a history button can be a textfield where the button is shown inside the field.
      Parameters:
      owner - the value for the owner property
      See Also:

    • getListDecorationLeft

      public final javafx.scene.Node getListDecorationLeft()
      Gets the value of the listDecorationLeft property.
      Property description:
      The list used by the popup to show previously used items can be easily decorated by specifying nodes for its left, right, top, and / or bottom sides. This property stores an optional node for the left side.
      Returns:
      the value of the listDecorationLeft property
      See Also:

    • listDecorationLeftProperty

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> listDecorationLeftProperty()
      The list used by the popup to show previously used items can be easily decorated by specifying nodes for its left, right, top, and / or bottom sides. This property stores an optional node for the left side.
      Returns:
      the node shown to the left of the list view
      See Also:

    • setListDecorationLeft

      public final void setListDecorationLeft(javafx.scene.Node listDecorationLeft)
      Sets the value of the listDecorationLeft property.
      Property description:
      The list used by the popup to show previously used items can be easily decorated by specifying nodes for its left, right, top, and / or bottom sides. This property stores an optional node for the left side.
      Parameters:
      listDecorationLeft - the value for the listDecorationLeft property
      See Also:

    • getListDecorationRight

      public final javafx.scene.Node getListDecorationRight()
      Gets the value of the listDecorationRight property.
      Property description:
      The list used by the popup to show previously used items can be easily decorated by specifying nodes for its left, right, top, and / or bottom sides. This property stores an optional node for the right side.
      Returns:
      the value of the listDecorationRight property
      See Also:

    • listDecorationRightProperty

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> listDecorationRightProperty()
      The list used by the popup to show previously used items can be easily decorated by specifying nodes for its left, right, top, and / or bottom sides. This property stores an optional node for the right side.
      Returns:
      the node shown to the right of the list view
      See Also:

    • setListDecorationRight

      public final void setListDecorationRight(javafx.scene.Node listDecorationRight)
      Sets the value of the listDecorationRight property.
      Property description:
      The list used by the popup to show previously used items can be easily decorated by specifying nodes for its left, right, top, and / or bottom sides. This property stores an optional node for the right side.
      Parameters:
      listDecorationRight - the value for the listDecorationRight property
      See Also:

    • getListDecorationTop

      public final javafx.scene.Node getListDecorationTop()
      Gets the value of the listDecorationTop property.
      Property description:
      The list used by the popup to show previously used items can be easily decorated by specifying nodes for its left, right, top, and / or bottom sides. This property stores an optional node for the top side.
      Returns:
      the value of the listDecorationTop property
      See Also:

    • listDecorationTopProperty

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> listDecorationTopProperty()
      The list used by the popup to show previously used items can be easily decorated by specifying nodes for its left, right, top, and / or bottom sides. This property stores an optional node for the top side.
      Returns:
      the node shown at the top of the list view
      See Also:

    • setListDecorationTop

      public final void setListDecorationTop(javafx.scene.Node listDecorationTop)
      Sets the value of the listDecorationTop property.
      Property description:
      The list used by the popup to show previously used items can be easily decorated by specifying nodes for its left, right, top, and / or bottom sides. This property stores an optional node for the top side.
      Parameters:
      listDecorationTop - the value for the listDecorationTop property
      See Also:

    • getListDecorationBottom

      public final javafx.scene.Node getListDecorationBottom()
      Gets the value of the listDecorationBottom property.
      Property description:
      The list used by the popup to show previously used items can be easily decorated by specifying nodes for its left, right, top, and / or bottom sides. This property stores an optional node for the bottom side.
      Returns:
      the value of the listDecorationBottom property
      See Also:

    • listDecorationBottomProperty

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> listDecorationBottomProperty()
      The list used by the popup to show previously used items can be easily decorated by specifying nodes for its left, right, top, and / or bottom sides. This property stores an optional node for the bottom side.
      Returns:
      the node shown on the bottom of the list view
      See Also:

    • setListDecorationBottom

      public final void setListDecorationBottom(javafx.scene.Node listDecorationBottom)
      Sets the value of the listDecorationBottom property.
      Property description:
      The list used by the popup to show previously used items can be easily decorated by specifying nodes for its left, right, top, and / or bottom sides. This property stores an optional node for the bottom side.
      Parameters:
      listDecorationBottom - the value for the listDecorationBottom property
      See Also:

    • getCellFactory

      public final javafx.util.Callback<javafx.scene.control.ListView<T>, javafx.scene.control.ListCell<T>> getCellFactory()
      Gets the value of the cellFactory property.
      Property description:
      The cell factory for the history popup list view.
      Returns:
      the value of the cellFactory property
      See Also:

    • cellFactoryProperty

      public final javafx.beans.property.ObjectProperty<javafx.util.Callback<javafx.scene.control.ListView<T>, javafx.scene.control.ListCell<T>>> cellFactoryProperty()
      The cell factory for the history popup list view.
      Returns:
      the cell factory
      See Also:

    • setCellFactory

      public final void setCellFactory(javafx.util.Callback<javafx.scene.control.ListView<T>, javafx.scene.control.ListCell<T>> cellFactory)
      Sets the value of the cellFactory property.
      Property description:
      The cell factory for the history popup list view.
      Parameters:
      cellFactory - the value for the cellFactory property
      See Also:

    • popupShowingProperty

      public final javafx.beans.property.ReadOnlyBooleanProperty popupShowingProperty()
      Indicates whether the history popup is showing. This is a read-only property.
      Returns:
      true if the history popup is showing, false otherwise
      See Also: