Modifier and Type	Class and Description
public static class	AutoCompletionBinding.AutoCompletionEvent<TE> Represents an Event which is fired after an auto completion.
private class	AutoCompletionBinding.FetchSuggestionsTask This task is responsible to fetch suggestions asynchronous by using the current defined suggestionProvider
public static interface	AutoCompletionBinding.ISuggestionRequest Represents a suggestion fetch request

Modifier and Type	Field and Description
private final AutoCompletePopup<T>	autoCompletionPopup
private final Node	completionTarget * Private fields * *
private long	delay
pack-priv final EventHandlerManager	eventHandlerManager * EventTarget Implementation * *
private boolean	ignoreInputChanges
private ObjectProperty<EventHandler<AutoCompletionBinding.AutoCompletionEvent<T>>>	onAutoCompleted
private Callback<AutoCompletionBinding.ISuggestionRequest, Collection<T>>	suggestionProvider
private AutoCompletionBinding<T>.FetchSuggestionsTask	suggestionsTask
private final Object	suggestionsTaskLock

Access	Constructor and Description
protected	AutoCompletionBinding(Node The target node to which auto-completion shall be added completionTarget, Callback<AutoCompletionBinding.ISuggestionRequest, Collection<T>> The strategy to retrieve suggestions suggestionProvider, StringConverter<T> The converter to be used to convert suggestions to strings converter) Creates a new AutoCompletionBinding

Method Summary

Modifier and Type	Method and Description
public < the specific event class of the handler E extends Event> void	addEventHandler(EventType<E> the type of the events to receive by the handler eventType, EventHandler<? super E> the handler to register eventHandler) Overrides default javafx.event.EventTarget.addEventHandler. Registers an event handler to this EventTarget.
public EventDispatchChain	buildEventDispatchChain(EventDispatchChain tail) Implements javafx.event.EventTarget.buildEventDispatchChain. Construct an event dispatch chain for this target.
protected abstract void	completeUserInput(T completion) Complete the current user-input with the provided completion.
public abstract void	dispose() Disposes the binding.
protected void	fireAutoCompletion(T completion)
public AutoCompletePopup<T>	Returns: the `AutoCompletePopup` used by this binding getAutoCompletionPopup() Get the `AutoCompletePopup` used by this binding.
public Node	Returns: the target node for auto completion getCompletionTarget() Gets the target node for auto completion
public final double	Returns: the max width of the popup. getMaxWidth() Return the max width of the popup.
public final double	Returns: the min width of the popup. getMinWidth() Return the min width of the popup.
public final EventHandler<AutoCompletionBinding.AutoCompletionEvent<T>>	getOnAutoCompleted()
public final double	Returns: the pref width of the popup. getPrefWidth() Return the pref width of the popup.
public final int	Returns: the maximum number of rows to be visible in the popup when it is showing. getVisibleRowCount() Return the maximum number of rows to be visible in the popup when it is showing.
protected void	hidePopup() Hide the auto completion targets
private boolean	isIgnoreInputChanges() Shall changes to the user input be ignored?
public final DoubleProperty	maxWidthProperty() Return the property associated with the max width.
public final DoubleProperty	minWidthProperty() Return the property associated with the min width.
public final ObjectProperty<EventHandler<AutoCompletionBinding.AutoCompletionEvent<T>>>	onAutoCompletedProperty()
private final void	onUserInputChanged(final String userText) Occurs when the user text has changed and the suggestions require an update
public final DoubleProperty	prefWidthProperty() Return the property associated with the pref width.
public < the specific event class of the handler E extends Event> void	removeEventHandler(EventType<E> the event type from which to unregister eventType, EventHandler<? super E> the handler to unregister eventHandler) Overrides default javafx.event.EventTarget.removeEventHandler. Unregisters a previously registered event handler from this EventTarget.
private void	selectFirstSuggestion(AutoCompletePopup<?> autoCompletionPopup) Selects the first suggestion (if any), so the user can choose it by pressing enter immediately.
public final void	setDelay(long delay) Sets the delay in ms between a key press and the suggestion popup being displayed.
public void	setHideOnEscape(boolean value) Specifies whether the PopupWindow should be hidden when an unhandled escape key is pressed while the popup has focus.
private void	setIgnoreInputChanges(boolean state) If IgnoreInputChanges is set to true, all changes to the user input are ignored.
public final void	setMaxWidth(double value) Sets the maxWidth of the popup.
public final void	setMinWidth(double value) Sets the minWidth of the popup.
public final void	setOnAutoCompleted(EventHandler<AutoCompletionBinding.AutoCompletionEvent<T>> value) Set a event handler which is invoked after an auto completion.
public final void	setPrefWidth(double value) Sets the prefWidth of the popup.
public final void	setUserInput(String userText) Set the current text the user has entered
public final void	setVisibleRowCount(int value) Set the maximum number of rows to be visible in the popup when it is showing.
protected void	showPopup() Show the auto completion popup
public final IntegerProperty	Returns: an property representing the maximum number of rows to be visible in the popup when it is showing. visibleRowCountProperty() Return an property representing the maximum number of rows to be visible in the popup when it is showing.

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

Field Detail

autoCompletionPopup	back to summary
private final AutoCompletePopup<T> autoCompletionPopup

completionTarget	back to summary
private final Node completionTarget * Private fields * *

delay	back to summary
private long delay

eventHandlerManager	back to summary
pack-priv final EventHandlerManager eventHandlerManager * EventTarget Implementation * *

ignoreInputChanges	back to summary
private boolean ignoreInputChanges

onAutoCompleted	back to summary
private ObjectProperty<EventHandler<AutoCompletionBinding.AutoCompletionEvent<T>>> onAutoCompleted

suggestionProvider	back to summary
private Callback<AutoCompletionBinding.ISuggestionRequest, Collection<T>> suggestionProvider

suggestionsTask	back to summary
private AutoCompletionBinding<T>.FetchSuggestionsTask suggestionsTask

suggestionsTaskLock	back to summary
private final Object suggestionsTaskLock

Constructor Detail

AutoCompletionBinding	back to summary
protected AutoCompletionBinding(Node completionTarget, Callback<AutoCompletionBinding.ISuggestionRequest, Collection<T>> suggestionProvider, StringConverter<T> converter) Creates a new AutoCompletionBinding Parameters completionTarget:Node The target node to which auto-completion shall be added suggestionProvider:Callback<AutoCompletionBinding.ISuggestionRequest, Collection<T>> The strategy to retrieve suggestions converter:StringConverter<T> The converter to be used to convert suggestions to strings

AutoCompletionBinding

back to summary

protected AutoCompletionBinding(Node completionTarget, Callback<AutoCompletionBinding.ISuggestionRequest, Collection<T>> suggestionProvider, StringConverter<T> converter)

Creates a new AutoCompletionBinding

Parameters

completionTarget:Node: The target node to which auto-completion shall be added
suggestionProvider:Callback<AutoCompletionBinding.ISuggestionRequest, Collection<T>>: The strategy to retrieve suggestions
converter:StringConverter<T>: The converter to be used to convert suggestions to strings

Method Detail

addEventHandler back to summary

addEventHandler	back to summary
public <E extends Event> void addEventHandler(EventType<E> eventType, EventHandler<? super E> eventHandler) Overrides default javafx.event.EventTarget.addEventHandler. Registers an event handler to this EventTarget. The handler is called when the menu item receives an `Event` of the specified type during the bubbling phase of event delivery. Parameters <E> the specific event class of the handler eventType:EventType<E> the type of the events to receive by the handler eventHandler:EventHandler<? super E> the handler to register Exceptions NullPointerException: if the event type or handler is null

public <E extends Event> void addEventHandler(EventType<E> eventType, EventHandler<? super E> eventHandler)

Overrides default javafx.event.EventTarget.addEventHandler.

Registers an event handler to this EventTarget. The handler is called when the menu item receives an Event of the specified type during the bubbling phase of event delivery.

Parameters

<E>: the specific event class of the handler
eventType:EventType<E>: the type of the events to receive by the handler
eventHandler:EventHandler<? super E>: the handler to register

Exceptions

NullPointerException:: if the event type or handler is null

buildEventDispatchChain back to summary

buildEventDispatchChain	back to summary
public EventDispatchChain buildEventDispatchChain(EventDispatchChain tail) Implements javafx.event.EventTarget.buildEventDispatchChain. Doc from javafx.event.EventTarget.buildEventDispatchChain. Construct an event dispatch chain for this target. The event dispatch chain contains event dispatchers which might be interested in processing of events targeted at this `EventTarget`. This event target is not automatically added to the chain, so if it wants to process events, it needs to add an `EventDispatcher` for itself to the chain. In the case the event target is part of some hierarchy, the chain for it is usually built from event dispatchers collected from the root of the hierarchy to the event target. The event dispatch chain is constructed by modifications to the provided initial event dispatch chain. The returned chain should have the initial chain at its end so the dispatchers should be prepended to the initial chain. The caller shouldn't assume that the initial chain remains unchanged nor that the returned value will reference a different chain. Annotations @Override

public EventDispatchChain buildEventDispatchChain(EventDispatchChain tail)

Implements javafx.event.EventTarget.buildEventDispatchChain.

Doc from javafx.event.EventTarget.buildEventDispatchChain.

Construct an event dispatch chain for this target. The event dispatch chain contains event dispatchers which might be interested in processing of events targeted at this EventTarget. This event target is not automatically added to the chain, so if it wants to process events, it needs to add an EventDispatcher for itself to the chain.

In the case the event target is part of some hierarchy, the chain for it is usually built from event dispatchers collected from the root of the hierarchy to the event target.

The event dispatch chain is constructed by modifications to the provided initial event dispatch chain. The returned chain should have the initial chain at its end so the dispatchers should be prepended to the initial chain.

The caller shouldn't assume that the initial chain remains unchanged nor that the returned value will reference a different chain.

Annotations

@Override

completeUserInput	back to summary
protected abstract void completeUserInput(T completion) Complete the current user-input with the provided completion. Sub-classes have to provide a concrete implementation.

dispose	back to summary
public abstract void dispose() Disposes the binding.

fireAutoCompletion	back to summary
protected void fireAutoCompletion(T completion)

getAutoCompletionPopup back to summary

getAutoCompletionPopup	back to summary
public AutoCompletePopup<T> getAutoCompletionPopup() Get the `AutoCompletePopup` used by this binding. Note that this gives access to the internal API and should be used with great care (and in the expectation that things may break in the future). All relevant methods of the popup are already exposed in this class. The only reason this is exposed is to allow custom skins for the popup. Returns:AutoCompletePopup<T> the `AutoCompletePopup` used by this binding

public AutoCompletePopup<T> getAutoCompletionPopup()

Get the AutoCompletePopup used by this binding. Note that this gives access to the internal API and should be used with great care (and in the expectation that things may break in the future). All relevant methods of the popup are already exposed in this class.

The only reason this is exposed is to allow custom skins for the popup.

Returns:AutoCompletePopup<T>: the AutoCompletePopup used by this binding

getCompletionTarget	back to summary
public Node getCompletionTarget() Gets the target node for auto completion Returns:Node the target node for auto completion

getCompletionTarget

back to summary

public Node getCompletionTarget()

Gets the target node for auto completion

Returns:Node: the target node for auto completion

getMaxWidth	back to summary
public final double getMaxWidth() Return the max width of the popup. Returns:double the max width of the popup.

getMaxWidth

back to summary

public final double getMaxWidth()

Return the max width of the popup.

Returns:double: the max width of the popup.

getMinWidth	back to summary
public final double getMinWidth() Return the min width of the popup. Returns:double the min width of the popup.

getMinWidth

back to summary

public final double getMinWidth()

Return the min width of the popup.

Returns:double: the min width of the popup.

getOnAutoCompleted	back to summary
public final EventHandler<AutoCompletionBinding.AutoCompletionEvent<T>> getOnAutoCompleted()

getPrefWidth	back to summary
public final double getPrefWidth() Return the pref width of the popup. Returns:double the pref width of the popup.

getPrefWidth

back to summary

public final double getPrefWidth()

Return the pref width of the popup.

Returns:double: the pref width of the popup.

getVisibleRowCount	back to summary
public final int getVisibleRowCount() Return the maximum number of rows to be visible in the popup when it is showing. Returns:int the maximum number of rows to be visible in the popup when it is showing.

getVisibleRowCount

back to summary

public final int getVisibleRowCount()

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

Returns:int: the maximum number of rows to be visible in the popup when it is showing.

hidePopup	back to summary
protected void hidePopup() Hide the auto completion targets

isIgnoreInputChanges	back to summary
private boolean isIgnoreInputChanges() Shall changes to the user input be ignored?

maxWidthProperty	back to summary
public final DoubleProperty maxWidthProperty() Return the property associated with the max width.

minWidthProperty	back to summary
public final DoubleProperty minWidthProperty() Return the property associated with the min width.

onAutoCompletedProperty	back to summary
public final ObjectProperty<EventHandler<AutoCompletionBinding.AutoCompletionEvent<T>>> onAutoCompletedProperty()

onUserInputChanged	back to summary
private final void onUserInputChanged(final String userText) Occurs when the user text has changed and the suggestions require an update

prefWidthProperty	back to summary
public final DoubleProperty prefWidthProperty() Return the property associated with the pref width.

removeEventHandler	back to summary
public <E extends Event> void removeEventHandler(EventType<E> eventType, EventHandler<? super E> eventHandler) Overrides default javafx.event.EventTarget.removeEventHandler. Unregisters a previously registered event handler from this EventTarget. One handler might have been registered for different event types, so the caller needs to specify the particular event type from which to unregister the handler. Parameters <E> the specific event class of the handler eventType:EventType<E> the event type from which to unregister eventHandler:EventHandler<? super E> the handler to unregister Exceptions NullPointerException: if the event type or handler is null

removeEventHandler

back to summary

public <E extends Event> void removeEventHandler(EventType<E> eventType, EventHandler<? super E> eventHandler)

Overrides default javafx.event.EventTarget.removeEventHandler.

Unregisters a previously registered event handler from this EventTarget. One handler might have been registered for different event types, so the caller needs to specify the particular event type from which to unregister the handler.

Parameters

<E>: the specific event class of the handler
eventType:EventType<E>: the event type from which to unregister
eventHandler:EventHandler<? super E>: the handler to unregister

Exceptions

NullPointerException:: if the event type or handler is null

selectFirstSuggestion	back to summary
private void selectFirstSuggestion(AutoCompletePopup<?> autoCompletionPopup) Selects the first suggestion (if any), so the user can choose it by pressing enter immediately.

setDelay	back to summary
public final void setDelay(long delay) Sets the delay in ms between a key press and the suggestion popup being displayed.

setHideOnEscape	back to summary
public void setHideOnEscape(boolean value) Specifies whether the PopupWindow should be hidden when an unhandled escape key is pressed while the popup has focus.

setIgnoreInputChanges	back to summary
private void setIgnoreInputChanges(boolean state) If IgnoreInputChanges is set to true, all changes to the user input are ignored. This is primary used to avoid self triggering while auto completing.

setMaxWidth	back to summary
public final void setMaxWidth(double value) Sets the maxWidth of the popup.

setMinWidth	back to summary
public final void setMinWidth(double value) Sets the minWidth of the popup.

setOnAutoCompleted	back to summary
public final void setOnAutoCompleted(EventHandler<AutoCompletionBinding.AutoCompletionEvent<T>> value) Set a event handler which is invoked after an auto completion.

setPrefWidth	back to summary
public final void setPrefWidth(double value) Sets the prefWidth of the popup.

setUserInput	back to summary
public final void setUserInput(String userText) Set the current text the user has entered

setVisibleRowCount	back to summary
public final void setVisibleRowCount(int value) Set the maximum number of rows to be visible in the popup when it is showing.

showPopup	back to summary
protected void showPopup() Show the auto completion popup

visibleRowCountProperty	back to summary
public final IntegerProperty visibleRowCountProperty() Return an property representing the maximum number of rows to be visible in the popup when it is showing. Returns:IntegerProperty an property representing the maximum number of rows to be visible in the popup when it is showing.

visibleRowCountProperty

back to summary

public final IntegerProperty visibleRowCountProperty()

Return an property representing the maximum number of rows to be visible in the popup when it is showing.

Returns:IntegerProperty: an property representing the maximum number of rows to be visible in the popup when it is showing.

org.controlsfx.control.textfield back to summary

public Class AutoCompletionBinding.AutoCompletionEvent<TE>

Class Inheritance

extends Event

java.lang.Object
java.util.EventObject
javafx.event.Event
org.controlsfx.control.textfield.AutoCompletionBinding.AutoCompletionEvent

Annotations

@SuppressWarnings:serial

Represents an Event which is fired after an auto completion.

Field Summary

Modifier and Type	Field and Description
public static final EventType<AutoCompletionBinding.AutoCompletionEvent<?>>	AUTO_COMPLETED The event type that should be listened to by people interested in knowing when an auto completion has been performed.
private final TE	completion

Inherited from javafx.event.Event:: ANY consumed eventType NULL_SOURCE_TARGET target

Constructor Summary

Access	Constructor and Description
public	AutoCompletionEvent(TE completion) Creates a new event that can subsequently be fired.

Method Summary

Modifier and Type	Method and Description
public TE	getCompletion() Returns the chosen completion.

Inherited from javafx.event.Event:: clone consume copyFor fireEvent getEventType getTarget isConsumed

Field Detail

AUTO_COMPLETED	back to summary
public static final EventType<AutoCompletionBinding.AutoCompletionEvent<?>> AUTO_COMPLETED The event type that should be listened to by people interested in knowing when an auto completion has been performed.

completion	back to summary
private final TE completion

Constructor Detail

AutoCompletionEvent	back to summary
public AutoCompletionEvent(TE completion) Creates a new event that can subsequently be fired.

Method Detail

getCompletion	back to summary
public TE getCompletion() Returns the chosen completion.

org.controlsfx.control.textfield back to summary

private Class AutoCompletionBinding.FetchSuggestionsTask

Class Inheritance

extends Task<Void>
implements ISuggestionRequest

java.lang.Object
java.util.concurrent.FutureTask
javafx.concurrent.Task
org.controlsfx.control.textfield.AutoCompletionBinding.FetchSuggestionsTask

All Implemented Interfaces

org.controlsfx.control.textfield.AutoCompletionBinding.ISuggestionRequest

This task is responsible to fetch suggestions asynchronous by using the current defined suggestionProvider

Field Summary

Modifier and Type	Field and Description
private final long	delay
private final String	userText

Constructor Summary

Access	Constructor and Description
public	FetchSuggestionsTask(String userText, long delay)

Method Summary

Modifier and Type	Method and Description
protected Void	call() Implements abstract javafx.concurrent.Task.call. Invoked when the Task is executed, the call method must be overridden and implemented by subclasses.
public String	getUserText() Implements org.controlsfx.control.textfield.AutoCompletionBinding.ISuggestionRequest.getUserText. Get the user text to which suggestions shall be found

Field Detail

delay	back to summary
private final long delay

userText	back to summary
private final String userText

Constructor Detail

FetchSuggestionsTask	back to summary
public FetchSuggestionsTask(String userText, long delay)

Method Detail

call

back to summary

protected Void call() throws Exception

Implements abstract javafx.concurrent.Task.call.

Doc from javafx.concurrent.Task.call.

Invoked when the Task is executed, the call method must be overridden and implemented by subclasses. The call method actually performs the background thread logic. Only the updateProgress, updateMessage, updateValue and updateTitle methods of Task may be called from code within this method. Any other interaction with the Task from the background thread will result in runtime exceptions.

Annotations

@Override

Exceptions

Exception:: an unhandled exception which occurred during the background operation

getUserText

back to summary

public String getUserText()

Implements org.controlsfx.control.textfield.AutoCompletionBinding.ISuggestionRequest.getUserText.

Doc from org.controlsfx.control.textfield.AutoCompletionBinding.ISuggestionRequest.getUserText.

Get the user text to which suggestions shall be found

Annotations

@Override

public abstract Class AutoCompletionBinding<T>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class AutoCompletionBinding.AutoCompletionEvent<TE>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class AutoCompletionBinding.FetchSuggestionsTask

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface AutoCompletionBinding.ISuggestionRequest

Method Summary

Method Detail

Modifier and Type	Method and Description
public String	Returns: `String` containing the user text getUserText() Get the user text to which suggestions shall be found
public boolean	Returns: `true` if the request is canceled, otherwise `false` isCancelled() Is this request canceled?