Module org.controlsfx.controls

Package impl.org.controlsfx.skin

Class AutoCompletePopup<T>

java.lang.Object

javafx.stage.Window

javafx.stage.PopupWindow

javafx.scene.control.PopupControl

impl.org.controlsfx.skin.AutoCompletePopup<T>

All Implemented Interfaces:

Styleable, EventTarget, Skinnable

public class AutoCompletePopup<T>
extends PopupControl

The auto-complete-popup provides an list of available suggestions in order to complete current user input.

Property Summary

Properties

Type	Property	Description
final ObjectProperty<EventHandler<AutoCompletePopup.SuggestionEvent<T>>>	onSuggestion	* Properties * *
final IntegerProperty	visibleRowCount	The maximum number of rows to be visible in the popup when it is showing.

Properties inherited from class javafx.scene.control.PopupControl

id, maxHeight, maxWidth, minHeight, minWidth, prefHeight, prefWidth, skin, style

Properties inherited from class javafx.stage.PopupWindow

anchorLocation, anchorX, anchorY, autoFix, autoHide, consumeAutoHidingEvents, hideOnEscape, onAutoHide, ownerNode, ownerWindow

Properties inherited from class javafx.stage.Window

eventDispatcher, focused, forceIntegerRenderScale, height, onCloseRequest, onHidden, onHiding, onShowing, onShown, opacity, outputScaleX, outputScaleY, renderScaleX, renderScaleY, scene, showing, width, x, y

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AutoCompletePopup.SuggestionEvent<TE>	Represents an Event which is fired when the user has selected a suggestion for auto-complete

Nested classes/interfaces inherited from class javafx.scene.control.PopupControl

PopupControl.CSSBridge

Nested classes/interfaces inherited from class javafx.stage.PopupWindow

PopupWindow.AnchorLocation

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_STYLE_CLASS	* Stylesheet Handling * *

Fields inherited from class javafx.scene.control.PopupControl

bridge, USE_COMPUTED_SIZE, USE_PREF_SIZE

Constructor Summary

Constructors

Constructor	Description
AutoCompletePopup()	Creates a new AutoCompletePopup

Method Summary

Modifier and Type	Method	Description
protected Skin<?>	createDefaultSkin()
StringConverter<T>	getConverter()	Get the string converter used to turn a generic suggestion into a string
final EventHandler<AutoCompletePopup.SuggestionEvent<T>>	getOnSuggestion()	Gets the value of the property onSuggestion.
ObservableList<T>	getSuggestions()	Get the suggestions presented by this AutoCompletePopup
final int	getVisibleRowCount()	Gets the value of the property visibleRowCount.
final ObjectProperty<EventHandler<AutoCompletePopup.SuggestionEvent<T>>>	onSuggestionProperty()	* Properties * *
void	setConverter(StringConverter<T> converter)	Set the string converter used to turn a generic suggestion into a string
final void	setOnSuggestion(EventHandler<AutoCompletePopup.SuggestionEvent<T>> value)	Sets the value of the property onSuggestion.
final void	setVisibleRowCount(int value)	Sets the value of the property visibleRowCount.
void	show(Node node)	Show this popup right below the given Node
final IntegerProperty	visibleRowCountProperty()	The maximum number of rows to be visible in the popup when it is showing.

Methods inherited from class javafx.scene.control.PopupControl

getClassCssMetaData, getCssMetaData, getId, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getPrefHeight, getPrefWidth, getPseudoClassStates, getSkin, getStyle, getStyleableNode, getStyleableParent, getStyleClass, getTypeSelector, idProperty, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, pseudoClassStateChanged, setId, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setPrefHeight, setPrefSize, setPrefWidth, setSkin, setStyle, skinProperty, styleProperty

Methods inherited from class javafx.stage.PopupWindow

anchorLocationProperty, anchorXProperty, anchorYProperty, autoFixProperty, autoHideProperty, consumeAutoHidingEventsProperty, getAnchorLocation, getAnchorX, getAnchorY, getConsumeAutoHidingEvents, getOnAutoHide, getOwnerNode, getOwnerWindow, hide, hideOnEscapeProperty, isAutoFix, isAutoHide, isHideOnEscape, onAutoHideProperty, ownerNodeProperty, ownerWindowProperty, setAnchorLocation, setAnchorX, setAnchorY, setAutoFix, setAutoHide, setConsumeAutoHidingEvents, setHideOnEscape, setOnAutoHide, setScene, show, show, show

Methods inherited from class javafx.stage.Window

addEventFilter, addEventHandler, buildEventDispatchChain, centerOnScreen, eventDispatcherProperty, fireEvent, focusedProperty, forceIntegerRenderScaleProperty, getEventDispatcher, getHeight, getOnCloseRequest, getOnHidden, getOnHiding, getOnShowing, getOnShown, getOpacity, getOutputScaleX, getOutputScaleY, getProperties, getRenderScaleX, getRenderScaleY, getScene, getUserData, getWidth, getWindows, getX, getY, hasProperties, heightProperty, isFocused, isForceIntegerRenderScale, isShowing, onCloseRequestProperty, onHiddenProperty, onHidingProperty, onShowingProperty, onShownProperty, opacityProperty, outputScaleXProperty, outputScaleYProperty, removeEventFilter, removeEventHandler, renderScaleXProperty, renderScaleYProperty, requestFocus, sceneProperty, setEventDispatcher, setEventHandler, setForceIntegerRenderScale, setHeight, setOnCloseRequest, setOnHidden, setOnHiding, setOnShowing, setOnShown, setOpacity, setRenderScaleX, setRenderScaleY, setUserData, setWidth, setX, setY, show, showingProperty, sizeToScene, widthProperty, xProperty, yProperty

Methods inherited from class java.lang.Object

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

Property Details

visibleRowCount

public final IntegerProperty visibleRowCountProperty

The maximum number of rows to be visible in the popup when it is showing. By default this value is 10, but this can be changed to increase or decrease the height of the popup.

See Also:

• getVisibleRowCount()
• setVisibleRowCount(int)

onSuggestion

public final ObjectProperty<EventHandler<AutoCompletePopup.SuggestionEvent<T>>> onSuggestionProperty

* Properties * *

See Also:

• getOnSuggestion()
• setOnSuggestion(EventHandler)

Field Details

DEFAULT_STYLE_CLASS

public static final String DEFAULT_STYLE_CLASS

* Stylesheet Handling * *

See Also:

• Constant Field Values

Constructor Details

AutoCompletePopup

public AutoCompletePopup()

Creates a new AutoCompletePopup

Method Details

getSuggestions

public ObservableList<T> getSuggestions()

Get the suggestions presented by this AutoCompletePopup

Returns:

show

public void show(Node node)

Show this popup right below the given Node

Parameters:

node -

setConverter

public void setConverter(StringConverter<T> converter)

Set the string converter used to turn a generic suggestion into a string

getConverter

public StringConverter<T> getConverter()

Get the string converter used to turn a generic suggestion into a string

setVisibleRowCount

public final void setVisibleRowCount(int value)

Sets the value of the property visibleRowCount.

Property description:

The maximum number of rows to be visible in the popup when it is showing. By default this value is 10, but this can be changed to increase or decrease the height of the popup.

getVisibleRowCount

public final int getVisibleRowCount()

Gets the value of the property visibleRowCount.

Property description:

The maximum number of rows to be visible in the popup when it is showing. By default this value is 10, but this can be changed to increase or decrease the height of the popup.

visibleRowCountProperty

public final IntegerProperty visibleRowCountProperty()

The maximum number of rows to be visible in the popup when it is showing. By default this value is 10, but this can be changed to increase or decrease the height of the popup.

See Also:

• getVisibleRowCount()
• setVisibleRowCount(int)

onSuggestionProperty

public final ObjectProperty<EventHandler<AutoCompletePopup.SuggestionEvent<T>>> onSuggestionProperty()

* Properties * *

See Also:

• getOnSuggestion()
• setOnSuggestion(EventHandler)

setOnSuggestion

public final void setOnSuggestion(EventHandler<AutoCompletePopup.SuggestionEvent<T>> value)

Sets the value of the property onSuggestion.

Property description:

* Properties * *

getOnSuggestion

public final EventHandler<AutoCompletePopup.SuggestionEvent<T>> getOnSuggestion()

Gets the value of the property onSuggestion.

Property description:

* Properties * *

createDefaultSkin

protected Skin<?> createDefaultSkin()

Overrides:

createDefaultSkin in class PopupControl