Modifier and Type	Class and Description
public class	HistoryButton.HistoryPopup The popup used by the `HistoryButton` to display a list view with the previously used items.
public class	HistoryButton.HistoryPopupSkin The skin used for the `HistoryPopup`.

Modifier and Type	Field and Description
private ObjectProperty<Callback<ListView<T>, ListCell<T>>>	cellFactory
private static final String	DEFAULT_STYLE_CLASS Hides javafx.scene.control.Button.DEFAULT_STYLE_CLASS.
private static final PseudoClass	DISABLED_POPUP_PSEUDO_CLASS
private ObjectProperty<HistoryManager<T>>	historyManager
private final ObjectProperty<Node>	listDecorationBottom
private final ObjectProperty<Node>	listDecorationLeft
private final ObjectProperty<Node>	listDecorationRight
private final ObjectProperty<Node>	listDecorationTop
private ObjectProperty<Consumer<T>>	onItemSelected
private ObjectProperty<Node>	owner
private final ObjectProperty<Node>	placeholder
private HistoryButton<T>.HistoryPopup	popup
private static final PseudoClass	POPUP_SHOWING_PSEUDO_CLASS
private final ReadOnlyBooleanWrapper	popupShowing

Access	Constructor and Description
public	HistoryButton() Creates a new instance of the history button.
public	HistoryButton(Node the owner of the button, used for focus management. 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 and Description
public final ObjectProperty<Callback<ListView<T>, ListCell<T>>>	Returns: the cell factory cellFactoryProperty() The cell factory for the history popup list view.
public final Callback<ListView<T>, ListCell<T>>	getCellFactory()
public final HistoryManager<T>	getHistoryManager()
public final Node	getListDecorationBottom()
public final Node	getListDecorationLeft()
public final Node	getListDecorationRight()
public final Node	getListDecorationTop()
public final Consumer<T>	getOnItemSelected()
public final Node	getOwner()
public final Node	getPlaceholder()
public void	hidePopup() Hides the popup that is showing the history items.
public final ObjectProperty<HistoryManager<T>>	Returns: the property representing the history manager historyManagerProperty() The history manager that is used for persisting the history of the button.
public final boolean	isPopupShowing()
public final ObjectProperty<Node>	Returns: the node shown on the bottom of the list view 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.
public final ObjectProperty<Node>	Returns: the node shown to the left of the list view 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.
public final ObjectProperty<Node>	Returns: the node shown to the right of the list view 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.
public final ObjectProperty<Node>	Returns: the node shown at the top of the list view 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.
public final ObjectProperty<Consumer<T>>	Returns: the property storing the "on history item confirmed" callback function. 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.
public final ObjectProperty<Node>	Returns: the owning node, e.g. a text field. ownerProperty() The (optional) "owner" of a history button can be a textfield where the button is shown inside the field.
public final ObjectProperty<Node>	Returns: the property representing the history placeholder node placeholderProperty() Returns the property representing the history placeholder node.
public final ReadOnlyBooleanProperty	Returns: true if the history popup is showing, false otherwise popupShowingProperty() Indicates whether the history popup is showing.
public final void	setCellFactory(Callback<ListView<T>, ListCell<T>> cellFactory)
public final void	setHistoryManager(HistoryManager<T> historyManager)
public final void	setListDecorationBottom(Node listDecorationBottom)
public final void	setListDecorationLeft(Node listDecorationLeft)
public final void	setListDecorationRight(Node listDecorationRight)
public final void	setListDecorationTop(Node listDecorationTop)
public final void	setOnItemSelected(Consumer<T> onItemSelected)
public final void	setOwner(Node owner)
public final void	setPlaceholder(Node placeholder)
public void	showPopup() Shows the popup that includes the list view with the items stored by the history manager.

Inherited from javafx.scene.control.Button:: cancelButtonProperty createDefaultSkin defaultButtonProperty fire isCancelButton isDefaultButton setCancelButton setDefaultButton

Field Detail

cellFactory	back to summary
private ObjectProperty<Callback<ListView<T>, ListCell<T>>> cellFactory

DEFAULT_STYLE_CLASS	back to summary
private static final String DEFAULT_STYLE_CLASS Hides javafx.scene.control.Button.DEFAULT_STYLE_CLASS.

DISABLED_POPUP_PSEUDO_CLASS	back to summary
private static final PseudoClass DISABLED_POPUP_PSEUDO_CLASS

historyManager	back to summary
private ObjectProperty<HistoryManager<T>> historyManager

listDecorationBottom	back to summary
private final ObjectProperty<Node> listDecorationBottom

listDecorationLeft	back to summary
private final ObjectProperty<Node> listDecorationLeft

listDecorationRight	back to summary
private final ObjectProperty<Node> listDecorationRight

listDecorationTop	back to summary
private final ObjectProperty<Node> listDecorationTop

onItemSelected	back to summary
private ObjectProperty<Consumer<T>> onItemSelected

owner	back to summary
private ObjectProperty<Node> owner

placeholder	back to summary
private final ObjectProperty<Node> placeholder

popup	back to summary
private HistoryButton<T>.HistoryPopup popup

POPUP_SHOWING_PSEUDO_CLASS	back to summary
private static final PseudoClass POPUP_SHOWING_PSEUDO_CLASS

popupShowing	back to summary
private final ReadOnlyBooleanWrapper popupShowing

Constructor Detail

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

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

HistoryButton

back to summary

public HistoryButton(Node owner)

Creates a new instance of the history button where the button will be used in combination with the given node.

Parameters

owner:Node: the owner of the button, used for focus management.

Method Detail

cellFactoryProperty	back to summary
public final ObjectProperty<Callback<ListView<T>, ListCell<T>>> cellFactoryProperty() The cell factory for the history popup list view. Returns:ObjectProperty<Callback<ListView<T>, ListCell<T>>> the cell factory

cellFactoryProperty

back to summary

public final ObjectProperty<Callback<ListView<T>, ListCell<T>>> cellFactoryProperty()

The cell factory for the history popup list view.

Returns:ObjectProperty<Callback<ListView<T>, ListCell<T>>>: the cell factory

getCellFactory	back to summary
public final Callback<ListView<T>, ListCell<T>> getCellFactory()

getHistoryManager	back to summary
public final HistoryManager<T> getHistoryManager()

getListDecorationBottom	back to summary
public final Node getListDecorationBottom()

getListDecorationLeft	back to summary
public final Node getListDecorationLeft()

getListDecorationRight	back to summary
public final Node getListDecorationRight()

getListDecorationTop	back to summary
public final Node getListDecorationTop()

getOnItemSelected	back to summary
public final Consumer<T> getOnItemSelected()

getOwner	back to summary
public final Node getOwner()

getPlaceholder	back to summary
public final Node getPlaceholder()

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

historyManagerProperty	back to summary
public final 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:ObjectProperty<HistoryManager<T>> the property representing the history manager

historyManagerProperty

back to summary

public final 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:ObjectProperty<HistoryManager<T>>: the property representing the history manager

isPopupShowing	back to summary
public final boolean isPopupShowing()

listDecorationBottomProperty	back to summary
public final ObjectProperty<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:ObjectProperty<Node> the node shown on the bottom of the list view

listDecorationBottomProperty

back to summary

public final ObjectProperty<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:ObjectProperty<Node>: the node shown on the bottom of the list view

listDecorationLeftProperty	back to summary
public final ObjectProperty<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:ObjectProperty<Node> the node shown to the left of the list view

listDecorationLeftProperty

back to summary

public final ObjectProperty<Node> listDecorationLeftProperty()

Returns:ObjectProperty<Node>: the node shown to the left of the list view

listDecorationRightProperty	back to summary
public final ObjectProperty<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:ObjectProperty<Node> the node shown to the right of the list view

listDecorationRightProperty

back to summary

public final ObjectProperty<Node> listDecorationRightProperty()

Returns:ObjectProperty<Node>: the node shown to the right of the list view

listDecorationTopProperty	back to summary
public final ObjectProperty<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:ObjectProperty<Node> the node shown at the top of the list view

listDecorationTopProperty

back to summary

public final ObjectProperty<Node> listDecorationTopProperty()

Returns:ObjectProperty<Node>: the node shown at the top of the list view

onItemSelectedProperty	back to summary
public final 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:ObjectProperty<Consumer<T>> the property storing the "on history item confirmed" callback function.

onItemSelectedProperty

back to summary

public final 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:ObjectProperty<Consumer<T>>: the property storing the "on history item confirmed" callback function.

ownerProperty	back to summary
public final ObjectProperty<Node> ownerProperty() The (optional) "owner" of a history button can be a textfield where the button is shown inside the field. Returns:ObjectProperty<Node> the owning node, e.g. a text field.

ownerProperty

back to summary

public final ObjectProperty<Node> ownerProperty()

The (optional) "owner" of a history button can be a textfield where the button is shown inside the field.

Returns:ObjectProperty<Node>: the owning node, e.g. a text field.

placeholderProperty	back to summary
public final ObjectProperty<Node> placeholderProperty() Returns the property representing the history placeholder node. Returns:ObjectProperty<Node> the property representing the history placeholder node

placeholderProperty

back to summary

public final ObjectProperty<Node> placeholderProperty()

Returns the property representing the history placeholder node.

Returns:ObjectProperty<Node>: the property representing the history placeholder node

popupShowingProperty	back to summary
public final ReadOnlyBooleanProperty popupShowingProperty() Indicates whether the history popup is showing. This is a read-only property. Returns:ReadOnlyBooleanProperty true if the history popup is showing, false otherwise

popupShowingProperty

back to summary

public final ReadOnlyBooleanProperty popupShowingProperty()

Indicates whether the history popup is showing. This is a read-only property.

Returns:ReadOnlyBooleanProperty: true if the history popup is showing, false otherwise

setCellFactory	back to summary
public final void setCellFactory(Callback<ListView<T>, ListCell<T>> cellFactory)

setHistoryManager	back to summary
public final void setHistoryManager(HistoryManager<T> historyManager)

setListDecorationBottom	back to summary
public final void setListDecorationBottom(Node listDecorationBottom)

setListDecorationLeft	back to summary
public final void setListDecorationLeft(Node listDecorationLeft)

setListDecorationRight	back to summary
public final void setListDecorationRight(Node listDecorationRight)

setListDecorationTop	back to summary
public final void setListDecorationTop(Node listDecorationTop)

setOnItemSelected	back to summary
public final void setOnItemSelected(Consumer<T> onItemSelected)

setOwner	back to summary
public final void setOwner(Node owner)

setPlaceholder	back to summary
public final void setPlaceholder(Node placeholder)

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

com.dlsc.gemsfx back to summary

public Class HistoryButton.HistoryPopup

Class Inheritance

extends CustomPopupControl

java.lang.Object
javafx.stage.Window
javafx.stage.PopupWindow
javafx.scene.control.PopupControl
com.dlsc.gemsfx.CustomPopupControl
com.dlsc.gemsfx.HistoryButton.HistoryPopup

The popup used by the HistoryButton to display a list view with the previously used items.

Field Summary

Modifier and Type	Field and Description
public static final String	DEFAULT_STYLE_CLASS

Constructor Summary

Access	Constructor and Description
public	HistoryPopup()

Method Summary

Modifier and Type	Method and Description
protected Skin<?>	createDefaultSkin() Overrides javafx.scene.control.PopupControl.createDefaultSkin. Create a new instance of the default skin for this control.

Inherited from com.dlsc.gemsfx.CustomPopupControl:: show

Field Detail

DEFAULT_STYLE_CLASS	back to summary
public static final String DEFAULT_STYLE_CLASS

Constructor Detail

HistoryPopup	back to summary
public HistoryPopup()

Method Detail

createDefaultSkin back to summary

protected Skin<?> createDefaultSkin()

Overrides javafx.scene.control.PopupControl.createDefaultSkin.

Doc from javafx.scene.control.PopupControl.createDefaultSkin.

Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS -fx-skin or set explicitly in a sub-class with setSkin(...).

Annotations

@Override

com.dlsc.gemsfx back to summary

public Class HistoryButton.HistoryPopupSkin

Class Inheritance

extends Object
implements Skin<HistoryButton<T>.HistoryPopup>

java.lang.Object
com.dlsc.gemsfx.HistoryButton.HistoryPopupSkin

All Implemented Interfaces

javafx.scene.control.Skin

The skin used for the HistoryPopup.

Field Summary

Modifier and Type	Field and Description
private final HistoryButton<T>.HistoryPopup	popup
private final BorderPane	root

Constructor Summary

Access	Constructor and Description
public	HistoryPopupSkin(HistoryButton<T>.HistoryPopup popup)

Method Summary

Modifier and Type	Method and Description
private ListView<T>	createListView()
public void	dispose() Implements javafx.scene.control.Skin.dispose. Called when a previously installed skin is about to be removed from its associated control.
public Node	getNode() Implements javafx.scene.control.Skin.getNode. Gets the Node which represents this Skin.
public HistoryButton<T>.HistoryPopup	getSkinnable() Implements javafx.scene.control.Skin.getSkinnable. Gets the Skinnable to which this Skin is assigned.
private void	handleItemSelection(ListView<T> listView)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

root	back to summary
private final BorderPane root

Constructor Detail

HistoryPopupSkin	back to summary
public HistoryPopupSkin(HistoryButton<T>.HistoryPopup popup)

Method Detail

createListView	back to summary
private ListView<T> createListView()

dispose back to summary

public void dispose()

Implements javafx.scene.control.Skin.dispose.

Doc from javafx.scene.control.Skin.dispose.

Called when a previously installed skin is about to be removed from its associated control. This allows the skin to do clean up, like removing listeners and bindings, and undo any changes to the control's properties. After this method completes, getSkinnable() and getNode() should return null.

Calling dispose() more than once has no effect.

Annotations

@Override

getNode back to summary

public Node getNode()

Implements javafx.scene.control.Skin.getNode.

Doc from javafx.scene.control.Skin.getNode.

Gets the Node which represents this Skin. This must never be null, except after a call to dispose(), and must never change except when changing to null.

Annotations

@Override

getSkinnable back to summary

public HistoryButton<T>.HistoryPopup getSkinnable()

Implements javafx.scene.control.Skin.getSkinnable.

Doc from javafx.scene.control.Skin.getSkinnable.

Gets the Skinnable to which this Skin is assigned. A Skin must be created for one and only one Skinnable. This value will only ever go from a non-null to null value when the Skin is removed from the Skinnable, and only as a consequence of a call to dispose().

The caller who constructs a Skinnable must also construct a Skin and properly establish the relationship between the Control and its Skin.

Annotations

@Override

handleItemSelection	back to summary
private void handleItemSelection(ListView<T> listView)

public Class HistoryButton<T>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class HistoryButton.HistoryPopup

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class HistoryButton.HistoryPopupSkin

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail