ca.odell.glazedlists.swing
Class TextComponentMatcherEditor

java.lang.Object
  ca.odell.glazedlists.matchers.AbstractMatcherEditor
      ca.odell.glazedlists.matchers.TextMatcherEditor
          ca.odell.glazedlists.swing.TextComponentMatcherEditor

All Implemented Interfaces:

MatcherEditor

public class TextComponentMatcherEditor
extends TextMatcherEditor

A MatcherEditor that matches Objects that contain the filter text located within a Document. This TextMatcherEditor is directly coupled with a Document and fires MatcherEditor changes in response to Document changes. This matcher is fully concrete and is expected to be used by Swing applications.

The TextComponentMatcherEditor constructors require that either a Document or a JTextComponent (from which a Document is extracted) be specified.

The MatcherEditor registers itself as a DocumentListener on the given Document, or ActionListener for non-live filtering. If this MatcherEditor must be garbage collected before the underlying Document, or JTextField, the listener can be unregistered by calling dispose().

Author:

James Lemieux

Nested Class Summary

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

MatcherEditor.Event, MatcherEditor.Listener

Field Summary

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

currentMatcher

Constructor Summary

TextComponentMatcherEditor(Document document, TextFilterator textFilterator)
Creates a TextMatcherEditor bound to the given document with the given textFilterator.

TextComponentMatcherEditor(JTextComponent textComponent, TextFilterator textFilterator)
Creates a TextMatcherEditor bound to the Document backing the given textComponent with the given textFilterator.

TextComponentMatcherEditor(JTextComponent textComponent, TextFilterator textFilterator, boolean live)
Creates a TextMatcherEditor bound to the Document backing the given textComponent with the given textFilterator.

Method Summary

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.
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

getFilterator, setFilterText

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

addMatcherEditorListener, fireChanged, fireChangedMatcher, fireConstrained, fireMatchAll, fireMatchNone, fireRelaxed, getMatcher, removeMatcherEditorListener

Methods inherited from class java.lang.Object

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

Constructor Detail

TextComponentMatcherEditor

public TextComponentMatcherEditor(JTextComponent textComponent,
                                  TextFilterator textFilterator)

Creates a TextMatcherEditor bound to the Document backing the given textComponent with the given textFilterator.

Parameters:

textComponent - the text component backed by the Document 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.

TextComponentMatcherEditor

public TextComponentMatcherEditor(JTextComponent textComponent,
                                  TextFilterator textFilterator,
                                  boolean live)

Creates a TextMatcherEditor bound to the Document backing the given textComponent with the given textFilterator.

Parameters:

textComponent - the text component backed by the Document 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 the keystroke or false to filter only when Enter is pressed within the JTextField. Note that non-live filtering is only supported if textComponent is a JTextField.

Throws:

IllegalArgumentException - if the textComponent does is not a JTextField and non-live filtering is specified.

TextComponentMatcherEditor

public TextComponentMatcherEditor(Document document,
                                  TextFilterator textFilterator)

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

Parameters:

document - the Document 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.

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 the keystroke or false to filter only when Enter is pressed within the JTextField. Note that non-live filtering is only supported if textComponent is a JTextField.

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.