ca.odell.glazedlists.javafx

Class TextInputControlMatcherEditor<E>

java.lang.Object

ca.odell.glazedlists.matchers.AbstractMatcherEditorListenerSupport<E>

ca.odell.glazedlists.matchers.AbstractMatcherEditor<E>

ca.odell.glazedlists.matchers.TextMatcherEditor<E>

ca.odell.glazedlists.javafx.TextInputControlMatcherEditor<E>

All Implemented Interfaces:

MatcherEditor<E>

public class TextInputControlMatcherEditor<E>
extends TextMatcherEditor<E>

A MatcherEditor that matches Objects that contain the filter text located within the text-property of a TextInputControl. This matcher is fully concrete and is expected to be used by JavaFx applications.

The TextInputControlMatcherEditor constructors require that a TextInputControl and TextFilterator be specified.

The MatcherEditor registers itself as a ChangeListener on the text-property of the text control for live-filtering. For non-live filtering, the text control must be of type TextField, because the matcher editor then registers as EventHandler on the action-property of the text field. If this MatcherEditor must be garbage collected before the underlying TextInputControl, the listeners can be unregistered by calling dispose().

Author:

Holger Brands

Nested Class Summary

Nested classes/interfaces inherited from interface ca.odell.glazedlists.matchers.MatcherEditor

MatcherEditor.Event<E>, MatcherEditor.Listener<E>

Field Summary

Fields inherited from class ca.odell.glazedlists.matchers.TextMatcherEditor

CONTAINS, EXACT, IDENTICAL_STRATEGY, NORMALIZED_STRATEGY, REGULAR_EXPRESSION, STARTS_WITH

Constructor Summary

Constructors

Constructor and Description
TextInputControlMatcherEditor(javafx.scene.control.TextInputControl textControl, TextFilterator<? super E> textFilterator) Creates a TextMatcherEditor bound to the TextInputControl with the given textFilterator.
TextInputControlMatcherEditor(javafx.scene.control.TextInputControl textControl, TextFilterator<? super E> textFilterator, boolean live) Creates a TextMatcherEditor bound to the TextInputControl with the given textFilterator.

Method Summary

Modifier and Type	Method and Description
void	dispose() A cleanup method which stops this MatcherEditor from listening to changes on the underlying Document, thus freeing the MatcherEditor or Document to be garbage collected.
javafx.scene.control.TextInputControl	getTextControl()
boolean	isLive() Whether filtering occurs by the keystroke or not.
void	setLive(boolean live) Toggle between filtering by the keystroke and not.

Methods inherited from class ca.odell.glazedlists.matchers.TextMatcherEditor

getCurrentTextMatcher, getFilterator, getMode, getStrategy, setFilterator, setFilterText, setMode, setStrategy, setTextMatcher

Methods inherited from class ca.odell.glazedlists.matchers.AbstractMatcherEditor

fireChanged, fireConstrained, fireMatchAll, fireMatchNone, fireRelaxed, getMatcher, isCurrentlyMatchingAll, isCurrentlyMatchingNone

Methods inherited from class ca.odell.glazedlists.matchers.AbstractMatcherEditorListenerSupport

addMatcherEditorListener, createChangedEvent, createConstrainedEvent, createMatchAllEvent, createMatchNoneEvent, createRelaxedEvent, fireChangedMatcher, removeMatcherEditorListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.odell.glazedlists.matchers.MatcherEditor

fromMatcher

Constructor Detail

TextInputControlMatcherEditor

public TextInputControlMatcherEditor(javafx.scene.control.TextInputControl textControl,
                                     TextFilterator<? super E> textFilterator)

Creates a TextMatcherEditor bound to the TextInputControl with the given textFilterator.

Parameters:

textControl - the text component that is the source of text filter values

textFilterator - an object capable of producing Strings from the objects being filtered. If textFilterator is null then all filtered objects are expected to implement TextFilterable.

TextInputControlMatcherEditor

public TextInputControlMatcherEditor(javafx.scene.control.TextInputControl textControl,
                                     TextFilterator<? super E> textFilterator,
                                     boolean live)

Creates a TextMatcherEditor bound to the TextInputControl with the given textFilterator.

Parameters:

textControl - the text component that is the source of text filter values

textFilterator - an object capable of producing Strings from the objects being filtered. If textFilterator is null then all filtered objects are expected to implement TextFilterable.

live - true to filter by a change to the text property of the textinput control . Note that non-live filtering is only supported if textControl is a TextField.

Throws:

java.lang.IllegalArgumentException - if the textControl is not a TextField and non-live filtering is specified.

Method Detail

isLive

public boolean isLive()

Whether filtering occurs by the keystroke or not.

setLive

public void setLive(boolean live)

Toggle between filtering by the keystroke and not.

Parameters:

live - true to filter by keystroke (change of the text property) or false to filter only when ENTER is pressed within the TextField (action event). Note that non-live filtering is only supported if textControl is a TextField.

getTextControl

public javafx.scene.control.TextInputControl getTextControl()

Returns:

the test input control this matcher editor is connected to.

dispose

public void dispose()

A cleanup method which stops this MatcherEditor from listening to changes on the underlying Document, thus freeing the MatcherEditor or Document to be garbage collected.