com.jidesoft.filter
Class AbstractValueFilter<E>

java.lang.Object
  com.jidesoft.filter.AbstractFilter<E>
      com.jidesoft.filter.AbstractValueFilter<E>

All Implemented Interfaces:

Filter<E>, ObjectGrouperSupport, ValueFilter<E>, Serializable, Cloneable, Iterable<E>

Direct Known Subclasses:

AbstractMutableValueFilter

public abstract class AbstractValueFilter<E>
extends AbstractFilter<E>
implements ValueFilter<E>

This class provides a skeletal implementation of the Filter interface to minimize the effort required to implement this interface.

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.jidesoft.filter.Filter

ALL, CUSTOM, NULL, SEPARATOR

Constructor Summary

AbstractValueFilter()

Method Summary

void	addValueFilterListener(ValueFilterListener<E> listener) Add a listener to the list that's notified each time a change to the filter occurs.
void	addWeakFilterListener(ValueFilterListener<E> listener) Add a listener to the list that's notified each time a change to the filter occurs.
boolean	isEnabled() Checks if the filter is enabled.
protected void	notifyFilteredChanged(ValueFilterEvent<E> event)
void	removeFilterListener(ValueFilterListener<E> listener) Remove a listener to the list that's notified each time a change to the filter occurs.
void	removeFilterListeners() Remove all listeners to the list that's notified each time a change to the selection occurs.
void	setEnabled(boolean enabled) Sets the filter enabled or disabled.

Methods inherited from class com.jidesoft.filter.AbstractFilter

addFilterListener, clone, fireFilterChanged, fireFilterContentChanged, fireFilterDisabled, fireFilterEnabled, fireFilterNameChanged, getConditionString, getFilterFactory, getFilterFactoryName, getFilterListeners, getName, getObjectGrouper, getObjectGrouperName, getPreference, isFilterValid, removeFilterListener, setFilterFactory, setFilterFactoryName, setName, setObjectGrouper, setObjectGrouperName, setPreference, stricterThan

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.jidesoft.filter.ValueFilter

getFilteredCount, isActive, isOnlyValueFiltered, isValueFiltered, isValueFiltered

Methods inherited from interface java.lang.Iterable

iterator

Methods inherited from interface com.jidesoft.filter.Filter

addFilterListener, clone, getFilterFactory, getFilterFactoryName, getName, getPreference, removeFilterListener, setFilterFactory, setFilterFactoryName, setName, setPreference, stricterThan

Constructor Detail

AbstractValueFilter

public AbstractValueFilter()

Method Detail

isEnabled

public boolean isEnabled()

Description copied from interface: Filter

Checks if the filter is enabled. If a filter is not enabled, isValueFiltered() will never be called.

Specified by:

isEnabled in interface Filter<E>

Overrides:

isEnabled in class AbstractFilter<E>

Returns:

true if the filter is enabled. Otherwise false.

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: Filter

Sets the filter enabled or disabled.

Specified by:

setEnabled in interface Filter<E>

Overrides:

setEnabled in class AbstractFilter<E>

Parameters:

enabled - true to enabled the filter; false to disable it.

addValueFilterListener

public void addValueFilterListener(ValueFilterListener<E> listener)

Description copied from interface: ValueFilter

Add a listener to the list that's notified each time a change to the filter occurs.

Specified by:

addValueFilterListener in interface ValueFilter<E>

Parameters:

listener - the SelectionListener

addWeakFilterListener

public void addWeakFilterListener(ValueFilterListener<E> listener)

Description copied from interface: ValueFilter

Add a listener to the list that's notified each time a change to the filter occurs. The listener will automatically be disposed of should no other object have a reference to it.

Specified by:

addWeakFilterListener in interface ValueFilter<E>

Parameters:

listener - the SelectionListener

removeFilterListener

public void removeFilterListener(ValueFilterListener<E> listener)

Description copied from interface: ValueFilter

Remove a listener to the list that's notified each time a change to the filter occurs.

Specified by:

removeFilterListener in interface ValueFilter<E>

Parameters:

listener - the SelectionListener

removeFilterListeners

public void removeFilterListeners()

Description copied from interface: ValueFilter

Remove all listeners to the list that's notified each time a change to the selection occurs.

Specified by:

removeFilterListeners in interface ValueFilter<E>

notifyFilteredChanged

protected void notifyFilteredChanged(ValueFilterEvent<E> event)