ca.odell.glazedlists.swing
Class TextComponentMatcherEditor<E>
- MatcherEditor<E>
public class TextComponentMatcherEditor<E>
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 on the
JTextComponent for
non-live filtering. If a
JTextComponent is given on construction, it
is also watched for changes of its Document and the Document used by this
MatcherEditor is updated to reflect the latest Document behind the text
component.
If this MatcherEditor must be garbage collected before the underlying
Document, or JTextComponent, the listeners can be unregistered by calling
dispose().
TextComponentMatcherEditor(Document document, E> textFilterator)- Creates a TextMatcherEditor bound to the given
document
with the given textFilterator.
|
TextComponentMatcherEditor(JTextComponent textComponent, E> textFilterator, boolean live)- Creates a TextMatcherEditor bound to the
Document backing the
given textComponent with the given
textFilterator.
|
TextComponentMatcherEditor(JTextComponent textComponent, TextFilterator textFilterator)- Creates a TextMatcherEditor bound to the
Document backing the
given textComponent with the given
textFilterator.
|
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.
|
addMatcherEditorListener, fireChanged, fireChangedMatcher, fireConstrained, fireMatchAll, fireMatchNone, fireRelaxed, getMatcher, isCurrentlyMatchingAll, isCurrentlyMatchingNone, removeMatcherEditorListener |
TextComponentMatcherEditor
public TextComponentMatcherEditor(Document document,
E> textFilterator) Creates a TextMatcherEditor bound to the given document
with the given textFilterator.
document - the Document that is the source of text filter
valuestextFilterator - 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,
E> textFilterator,
boolean live) Creates a TextMatcherEditor bound to the Document backing the
given textComponent with the given
textFilterator.
textComponent - the text component backed by the Document
that is the source of text filter valuestextFilterator - 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 JTextComponent. Note that non-live filtering is only
supported if textComponent is a JTextField.
TextComponentMatcherEditor
public TextComponentMatcherEditor(JTextComponent textComponent,
TextFilterator textFilterator) Creates a TextMatcherEditor bound to the Document backing the
given textComponent with the given
textFilterator.
textComponent - the text component backed by the Document
that is the source of text filter valuestextFilterator - an object capable of producing Strings from the
objects being filtered. If textFilterator is
null then all filtered objects are expected to
implement TextFilterable.
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.
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.
live - true to filter by the keystroke or false
to filter only when Enter is pressed
within the JTextComponent. Note that non-live filtering is only
supported if textComponent is a JTextField.
Glazed Lists, Copyright © 2003 publicobject.com, O'Dell Engineering.
Documentation build by pbuilder at 2009-07-14 22:05