Top Description Inners Fields Constructors Methods
impl.org.controlsfx.skin

public Class AutoCompletePopup<T>

extends PopupControl
Class Inheritance
Imports
java.util.UUID, javafx.beans.property.IntegerProperty, .ObjectProperty, .ObjectPropertyBase, .SimpleIntegerProperty, javafx.collections.FXCollections, .ObservableList, javafx.event.Event, .EventHandler, .EventType, javafx.geometry.NodeOrientation, javafx.scene.Node, javafx.scene.control.PopupControl, .Skin, javafx.stage.Window, javafx.util.StringConverter
The auto-complete-popup provides an list of available suggestions in order to complete current user input.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
AutoCompletePopup.SuggestionEvent<TE>

Represents an Event which is fired when the user has selected a suggestion for auto-complete

Field Summary

Modifier and TypeField and Description
private StringConverter<T>
converter

public static final String
DEFAULT_STYLE_CLASS

* Stylesheet Handling * *

private ObjectProperty<EventHandler<AutoCompletePopup.SuggestionEvent<T>>>
onSuggestion

private final ObservableList<T>
suggestions

* Private fields * *

private IntegerProperty
visibleRowCount

The maximum number of rows to be visible in the popup when it is showing.

Inherited from javafx.scene.control.PopupControl:
bridgeUSE_COMPUTED_SIZEUSE_PREF_SIZE

Constructor Summary

AccessConstructor and Description
public
AutoCompletePopup()

Creates a new AutoCompletePopup

Method Summary

Modifier and TypeMethod and Description
protected Skin<?>
createDefaultSkin()

Overrides javafx.scene.control.PopupControl.createDefaultSkin.

Create a new instance of the default skin for this control.

public StringConverter<T>
getConverter()

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

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

public ObservableList<T>
getSuggestions()

Get the suggestions presented by this AutoCompletePopup

public final int
getVisibleRowCount()

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

* Properties * *

public void
setConverter(StringConverter<T> converter)

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

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

public final void
setVisibleRowCount(int value)

public void
show(Node node)

Show this popup right below the given Node

public final IntegerProperty
visibleRowCountProperty()

Inherited from javafx.scene.control.PopupControl:
getClassCssMetaDatagetCssMetaDatagetIdgetMaxHeightgetMaxWidthgetMinHeightgetMinWidthgetPrefHeightgetPrefWidthgetPseudoClassStatesgetSkingetStylegetStyleableNodegetStyleableParentgetStyleClassgetTypeSelectoridPropertymaxHeightmaxHeightPropertymaxWidthmaxWidthPropertyminHeightminHeightPropertyminWidthminWidthPropertyprefHeightprefHeightPropertyprefWidthprefWidthPropertypseudoClassStateChangedsetIdsetMaxHeightsetMaxSizesetMaxWidthsetMinHeightsetMinSizesetMinWidthsetPrefHeightsetPrefSizesetPrefWidthsetSkinsetStyleskinPropertystyleProperty

Field Detail

converterback to summary
private StringConverter<T> converter
DEFAULT_STYLE_CLASSback to summary
public static final String DEFAULT_STYLE_CLASS

* Stylesheet Handling * *

onSuggestionback to summary
private ObjectProperty<EventHandler<AutoCompletePopup.SuggestionEvent<T>>> onSuggestion
suggestionsback to summary
private final ObservableList<T> suggestions

* Private fields * *

visibleRowCountback to summary
private IntegerProperty visibleRowCount

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.

Constructor Detail

AutoCompletePopupback to summary
public AutoCompletePopup()

Creates a new AutoCompletePopup

Method Detail

createDefaultSkinback 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
getConverterback to summary
public StringConverter<T> getConverter()

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

getOnSuggestionback to summary
public final EventHandler<AutoCompletePopup.SuggestionEvent<T>> getOnSuggestion()
getSuggestionsback to summary
public ObservableList<T> getSuggestions()

Get the suggestions presented by this AutoCompletePopup

getVisibleRowCountback to summary
public final int getVisibleRowCount()
onSuggestionPropertyback to summary
public final ObjectProperty<EventHandler<AutoCompletePopup.SuggestionEvent<T>>> onSuggestionProperty()

* Properties * *

setConverterback to summary
public void setConverter(StringConverter<T> converter)

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

setOnSuggestionback to summary
public final void setOnSuggestion(EventHandler<AutoCompletePopup.SuggestionEvent<T>> value)
setVisibleRowCountback to summary
public final void setVisibleRowCount(int value)
showback to summary
public void show(Node node)

Show this popup right below the given Node

visibleRowCountPropertyback to summary
public final IntegerProperty visibleRowCountProperty()
impl.org.controlsfx.skin back to summary

public Class AutoCompletePopup.SuggestionEvent<TE>

extends Event
Class Inheritance
Annotations
@SuppressWarnings:serial
Represents an Event which is fired when the user has selected a suggestion for auto-complete

Field Summary

Modifier and TypeField and Description
public static final EventType<AutoCompletePopup.SuggestionEvent<?>>
SUGGESTION

private final TE
suggestion

Inherited from javafx.event.Event:
ANYconsumedeventTypeNULL_SOURCE_TARGETtarget

Constructor Summary

AccessConstructor and Description
public
SuggestionEvent(TE suggestion)

Method Summary

Modifier and TypeMethod and Description
public TE
getSuggestion()

Returns the suggestion which was chosen by the user

Inherited from javafx.event.Event:
cloneconsumecopyForfireEventgetEventTypegetTargetisConsumed

Field Detail

SUGGESTIONback to summary
public static final EventType<AutoCompletePopup.SuggestionEvent<?>> SUGGESTION
suggestionback to summary
private final TE suggestion

Constructor Detail

SuggestionEventback to summary
public SuggestionEvent(TE suggestion)

Method Detail

getSuggestionback to summary
public TE getSuggestion()

Returns the suggestion which was chosen by the user