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

java.lang.Object
  ca.odell.glazedlists.matchers.AbstractMatcherEditorListenerSupport<E>
      ca.odell.glazedlists.matchers.AbstractMatcherEditor<E>

All Implemented Interfaces:

MatcherEditor<E>

Direct Known Subclasses:

CompositeMatcherEditor, RangeMatcherEditor, TextMatcherEditor, ThresholdMatcherEditor

public abstract class AbstractMatcherEditor<E>
extends AbstractMatcherEditorListenerSupport<E>

Basic building block for MatcherEditor implementations that handles the details of dealing with registered MatcherEditor.Listeners. All MatcherEditor implementations should extend this class for its convenience methods.

Extending classes can fire events to registered listeners using the "fire" methods:

• fireMatchNone()
• fireConstrained(Matcher)
• fireChanged(Matcher)
• fireRelaxed(Matcher)
• fireMatchAll()

Author:

Rob Eden

Nested Class Summary

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

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

Constructor Summary

AbstractMatcherEditor()

Method Summary

protected void	fireChanged(Matcher<E> matcher) Indicates that the filter has changed in an indeterminate way.
protected void	fireConstrained(Matcher<E> matcher) Indicates that the filter has changed to be more restrictive.
protected void	fireMatchAll() Indicates that the filter matches all.
protected void	fireMatchNone() Indicates that the filter matches none.
protected void	fireRelaxed(Matcher<E> matcher) Indicates that the filter has changed to be less restrictive.
Matcher<E>	getMatcher() Return the current Matcher specified by this MatcherEditor.
protected boolean	isCurrentlyMatchingAll() Returns true if the current matcher will match everything.
protected boolean	isCurrentlyMatchingNone() Returns true if the current matcher will match nothing.

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

Constructor Detail

AbstractMatcherEditor

public AbstractMatcherEditor()

Method Detail

getMatcher

public final Matcher<E> getMatcher()

Return the current Matcher specified by this MatcherEditor.

Returns:

a non-null Matcher.

fireMatchAll

protected final void fireMatchAll()

Indicates that the filter matches all.

fireChanged

protected final void fireChanged(Matcher<E> matcher)

Indicates that the filter has changed in an indeterminate way.

fireConstrained

protected final void fireConstrained(Matcher<E> matcher)

Indicates that the filter has changed to be more restrictive. This should only be called if all currently filtered items will remain filtered.

fireRelaxed

protected final void fireRelaxed(Matcher<E> matcher)

Indicates that the filter has changed to be less restrictive. This should only be called if all currently unfiltered items will remain unfiltered.

fireMatchNone

protected final void fireMatchNone()

Indicates that the filter matches none.

isCurrentlyMatchingAll

protected final boolean isCurrentlyMatchingAll()

Returns true if the current matcher will match everything.

isCurrentlyMatchingNone

protected final boolean isCurrentlyMatchingNone()

Returns true if the current matcher will match nothing.