org.controlsfx.control.textfield

Class AutoCompletionBinding<T>

java.lang.Object

org.controlsfx.control.textfield.AutoCompletionBinding<T>

Type Parameters:

T - Model-Type of the suggestions

All Implemented Interfaces:

EventTarget

public abstract class AutoCompletionBinding<T>
extends Object
implements EventTarget

The AutoCompletionBinding is the abstract base class of all auto-completion bindings. This class is the core logic for the auto-completion feature but highly customizable.

To use the autocompletion functionality, refer to the TextFields class.

See Also:

TextFields

Property Summary

Type	Property and Description
ObjectProperty<EventHandler<AutoCompletionBinding.AutoCompletionEvent<T>>>	onAutoCompleted

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AutoCompletionBinding.AutoCompletionEvent<TE> Represents an Event which is fired after an auto completion.
static interface	AutoCompletionBinding.ISuggestionRequest Represents a suggestion fetch request

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AutoCompletionBinding(Node completionTarget, Callback<AutoCompletionBinding.ISuggestionRequest,Collection<T>> suggestionProvider, StringConverter<T> converter) Creates a new AutoCompletionBinding

Method Summary

Modifier and Type	Method and Description
<E extends Event> void	addEventHandler(EventType<E> eventType, EventHandler<E> eventHandler) Registers an event handler to this EventTarget.
EventDispatchChain	buildEventDispatchChain(EventDispatchChain tail)
protected abstract void	completeUserInput(T completion) Complete the current user-input with the provided completion.
abstract void	dispose() Disposes the binding.
protected void	fireAutoCompletion(T completion)
Node	getCompletionTarget() Gets the target node for auto completion
EventHandler<AutoCompletionBinding.AutoCompletionEvent<T>>	getOnAutoCompleted() Gets the value of the property onAutoCompleted.
protected void	hidePopup() Hide the auto completion targets
ObjectProperty<EventHandler<AutoCompletionBinding.AutoCompletionEvent<T>>>	onAutoCompletedProperty()
<E extends Event> void	removeEventHandler(EventType<E> eventType, EventHandler<E> eventHandler) Unregisters a previously registered event handler from this EventTarget.
void	setOnAutoCompleted(EventHandler<AutoCompletionBinding.AutoCompletionEvent<T>> value) Set a event handler which is invoked after an auto completion.
void	setUserInput(String userText) Set the current text the user has entered
protected void	showPopup() Show the auto completion popup

Methods inherited from class java.lang.Object

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

Property Detail

onAutoCompleted

public final ObjectProperty<EventHandler<AutoCompletionBinding.AutoCompletionEvent<T>>> onAutoCompletedProperty

See Also:

getOnAutoCompleted(), setOnAutoCompleted(EventHandler)

Constructor Detail

AutoCompletionBinding

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

Creates a new AutoCompletionBinding

Parameters:

completionTarget - The target node to which auto-completion shall be added

suggestionProvider - The strategy to retrieve suggestions

converter - The converter to be used to convert suggestions to strings

Method Detail

setUserInput

public final void setUserInput(String userText)

Set the current text the user has entered

Parameters:

userText -

getCompletionTarget

public Node getCompletionTarget()

Gets the target node for auto completion

Returns:

dispose

public abstract void dispose()

Disposes the binding.

completeUserInput

protected abstract void completeUserInput(T completion)

Complete the current user-input with the provided completion. Sub-classes have to provide a concrete implementation.

Parameters:

completion -

showPopup

protected void showPopup()

Show the auto completion popup

hidePopup

protected void hidePopup()

Hide the auto completion targets

fireAutoCompletion

protected void fireAutoCompletion(T completion)

setOnAutoCompleted

public final void setOnAutoCompleted(EventHandler<AutoCompletionBinding.AutoCompletionEvent<T>> value)

Set a event handler which is invoked after an auto completion.

Parameters:

value -

getOnAutoCompleted

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

Gets the value of the property onAutoCompleted.

onAutoCompletedProperty

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

See Also:

getOnAutoCompleted(), setOnAutoCompleted(EventHandler)

addEventHandler

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

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.

Type Parameters:

E - the specific event class of the handler

Parameters:

eventType - the type of the events to receive by the handler

eventHandler - the handler to register

Throws:

NullPointerException - if the event type or handler is null

removeEventHandler

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

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.

Type Parameters:

E - the specific event class of the handler

Parameters:

eventType - the event type from which to unregister

eventHandler - the handler to unregister

Throws:

NullPointerException - if the event type or handler is null

buildEventDispatchChain

public EventDispatchChain buildEventDispatchChain(EventDispatchChain tail)

Specified by:

buildEventDispatchChain in interface EventTarget