com.sencha.gxt.widget.core.client.grid.filters

Class Filter<M,V>

java.lang.Object

com.sencha.gxt.widget.core.client.grid.filters.Filter<M,V>

Type Parameters:

M - the model type

V - the filter type

All Implemented Interfaces:

ActivateEvent.HasActivateHandlers<Filter<M,?>>, DeactivateEvent.HasDeactivateHandlers<Filter<M,?>>, UpdateEvent.HasUpdateHandlers

Direct Known Subclasses:

BooleanFilter, DateFilter, ListFilter, NumericFilter, StringFilter

public abstract class Filter<M,V>
extends Object
implements UpdateEvent.HasUpdateHandlers, ActivateEvent.HasActivateHandlers<Filter<M,?>>, DeactivateEvent.HasDeactivateHandlers<Filter<M,?>>

Provides an abstract base class for filters. A filter is applied to an object such as a Grid to reduce the amount of information that is displayed, thus highlighting the information of interest to the user. A filter is generally invoked from a header menu.

Derived classes provide type-specific filter support (e.g. string, number, date, boolean, etc.) and must implement getFilterConfig(), getValue() and getType().

To add a filter to a Grid column, create an instance of a concrete subclass of Filter, passing to the constructor the ValueProvider for the column, then add the filter to a GridFilters using AbstractGridFilters.addFilter(Filter) and invoke AbstractGridFilters.initPlugin(Grid). The filter then appears in the grid header menu item for any column that uses the supplied value provider.

Constructor Summary

Constructors

Constructor and Description
Filter(ValueProvider<? super M,V> valueProvider) Creates a filter for the specified value provider.

Method Summary

Methods

Modifier and Type	Method and Description
HandlerRegistration	addActivateHandler(ActivateEvent.ActivateHandler<Filter<M,?>> handler) Adds a ActivateEvent handler.
HandlerRegistration	addDeactivateHandler(DeactivateEvent.DeactivateHandler<Filter<M,?>> handler) Adds a DeactivateEvent handler.
HandlerRegistration	addUpdateHandler(UpdateEvent.UpdateHandler handler) Adds a UpdateEvent.UpdateHandler handler for UpdateEvent events.
abstract List<FilterConfig>	getFilterConfig() Returns a list of filter configurations.
FilterHandler<V>	getHandler()
Menu	getMenu() Returns the filter's menu.
int	getUpdateBuffer() Returns the update buffer.
abstract Object	getValue() Template method to be implemented by all subclasses that is to get and return the value of the filter.
ValueProvider<? super M,V>	getValueProvider() Returns the value provider that implements the interface to the data model associated with this filter.
boolean	isActive() Returns true if the filter is active.
void	setActive(boolean active, boolean suppressEvent) Sets the status of the filter and fires the appropriate events.
void	setFilterConfig(List<FilterConfig> configs) Sets the filters values using the given filter configs.
void	setHandler(FilterHandler<V> handler) Sets the filter handler for this filter.
void	setUpdateBuffer(int updateBuffer) Number of milliseconds to wait after user interaction to fire an update (defaults to 500).

Methods inherited from class java.lang.Object

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

Constructor Detail

Filter

public Filter(ValueProvider<? super M,V> valueProvider)

Creates a filter for the specified value provider. When used with GridFilters, the filter appears in the grid header menu item for any column that uses the supplied value provider.

Parameters:

valueProvider - the value provider that implements the interface to the data model associated with this filter.

Method Detail

addActivateHandler

public HandlerRegistration addActivateHandler(ActivateEvent.ActivateHandler<Filter<M,?>> handler)

Description copied from interface: ActivateEvent.HasActivateHandlers

Adds a ActivateEvent handler.

Specified by:

addActivateHandler in interface ActivateEvent.HasActivateHandlers<Filter<M,?>>

Parameters:

handler - the handler

Returns:

the registration for the event

addDeactivateHandler

public HandlerRegistration addDeactivateHandler(DeactivateEvent.DeactivateHandler<Filter<M,?>> handler)

Description copied from interface: DeactivateEvent.HasDeactivateHandlers

Adds a DeactivateEvent handler.

Specified by:

addDeactivateHandler in interface DeactivateEvent.HasDeactivateHandlers<Filter<M,?>>

Parameters:

handler - the handler

Returns:

the registration for the event

addUpdateHandler

public HandlerRegistration addUpdateHandler(UpdateEvent.UpdateHandler handler)

Description copied from interface: UpdateEvent.HasUpdateHandlers

Adds a UpdateEvent.UpdateHandler handler for UpdateEvent events.

Specified by:

addUpdateHandler in interface UpdateEvent.HasUpdateHandlers

Parameters:

handler - the handler

Returns:

the registration for the event

getFilterConfig

public abstract List<FilterConfig> getFilterConfig()

Returns a list of filter configurations. Note that a filter may consist of multiple criteria (e.g. "date after" and "date before"). There is a filter configuration for each of these criteria.

Returns:

a list of filter configurations

setFilterConfig

public void setFilterConfig(List<FilterConfig> configs)

Sets the filters values using the given filter configs. The values of the filter can be changed programatically using this method.

Parameters:

configs - the list of filter configurations

getHandler

public FilterHandler<V> getHandler()

getMenu

public Menu getMenu()

Returns the filter's menu.

Returns:

the menu

getUpdateBuffer

public int getUpdateBuffer()

Returns the update buffer.

Returns:

the update buffer in milliseconds

getValue

public abstract Object getValue()

Template method to be implemented by all subclasses that is to get and return the value of the filter.

getValueProvider

public ValueProvider<? super M,V> getValueProvider()

Returns the value provider that implements the interface to the data model associated with this filter.

Returns:

value provider that implements the data model interface for this filter

isActive

public boolean isActive()

Returns true if the filter is active.

Returns:

the active state

setActive

public void setActive(boolean active,
             boolean suppressEvent)

Sets the status of the filter and fires the appropriate events. You can only set it to active if the filter is activatable.

Parameters:

active - the new filter state

suppressEvent - true to prevent events from being fired

setHandler

public void setHandler(FilterHandler<V> handler)

Sets the filter handler for this filter. A filter handler is responsible for converting between a String representation of the filter and its native representation.

Parameters:

handler - for converting between String and native representation of <V>.

setUpdateBuffer

public void setUpdateBuffer(int updateBuffer)

Number of milliseconds to wait after user interaction to fire an update (defaults to 500).

Parameters:

updateBuffer - the update buffer in milliseconds