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

java.lang.Object
  com.sencha.gxt.widget.core.client.grid.filters.Filter<M,V>
      com.sencha.gxt.widget.core.client.grid.filters.ListFilter<M,V>

Type Parameters:

M - the model type

V - the ListStore type

All Implemented Interfaces:

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

public class ListFilter<M,V>
extends Filter<M,V>

Filters using the items in a ListStore. See Filter for more information.

Constructor Summary

ListFilter(ValueProvider<? super M,V> valueProvider, ListStore<V> store)
Creates a list filter for the specified value provider, matching the items in the specified list store.

Method Summary

java.util.List<FilterConfig>	getFilterConfig() Returns a list of filter configurations.
ListStore<V>	getStore() Returns the list store.
java.lang.Object	getValue() Template method to be implemented by all subclasses that is to get and return the value of the filter.
boolean	isActivatable() Template method to be implemented by all subclasses that is to return true if the filter has enough configuration information to be activated.

Methods inherited from class com.sencha.gxt.widget.core.client.grid.filters.Filter

addActivateHandler, addDeactivateHandler, addUpdateHandler, getHandler, getMenu, getUpdateBuffer, getValueProvider, isActive, setActive, setHandler, setUpdateBuffer

Methods inherited from class java.lang.Object

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

Constructor Detail

ListFilter

public ListFilter(ValueProvider<? super M,V> valueProvider,
                  ListStore<V> store)

Creates a list filter for the specified value provider, matching the items in the specified list store. See Filter.Filter(ValueProvider) for more information.

Parameters:

valueProvider - the value provider

store - contains the items to match

Method Detail

getFilterConfig

public java.util.List<FilterConfig> getFilterConfig()

Description copied from class: Filter

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.

Specified by:

getFilterConfig in class Filter<M,V>

Returns:

a list of filter configurations

getStore

public ListStore<V> getStore()

Returns the list store.

Returns:

the list store

getValue

public java.lang.Object getValue()

Description copied from class: Filter

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

Specified by:

getValue in class Filter<M,V>

isActivatable

public boolean isActivatable()

Description copied from class: Filter

Template method to be implemented by all subclasses that is to return true if the filter has enough configuration information to be activated.

Returns:

true if if the filter has enough configuration information to be activated