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.

Field Summary

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

menu

Constructor Summary

Constructors

Constructor and Description
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

Modifier and Type	Method and Description
protected List<V>	convertValuesFromString(String values)
protected String	convertValueToString()
List<FilterConfig>	getFilterConfig() Returns a list of filter configurations.
ListStore<V>	getStore() Returns the list store.
protected Class<V>	getType()
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.
boolean	isUseStoreKeys() Returns true if store keys are being used.
protected void	onCheckChange(CheckChangeEvent<CheckMenuItem> event)
void	setFilterConfig(List<FilterConfig> configs) Sets the filters values using the given filter configs.
void	setUseStoreKeys(boolean useStoreKeys) True to serialize values using the store key rather than toString on the model value (defaults to false).
void	setValue(List<V> values) Sets the value of this filter.
protected boolean	validateModel(M model) Template method to be implemented by all subclasses that is to validates the provided Model against the filters configuration.

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

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

Methods inherited from class java.lang.Object

clone, equals, finalize, 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 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 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.

Overrides:

isActivatable in class Filter<M,V>

Returns:

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

isUseStoreKeys

public boolean isUseStoreKeys()

Returns true if store keys are being used.

Returns:

true to use store keys

setFilterConfig

public void setFilterConfig(List<FilterConfig> configs)

Description copied from class: Filter

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

Overrides:

setFilterConfig in class Filter<M,V>

Parameters:

configs - the list of filter configurations

setUseStoreKeys

public void setUseStoreKeys(boolean useStoreKeys)

True to serialize values using the store key rather than toString on the model value (defaults to false).

Parameters:

useStoreKeys - true to use store keys, false to use model as a string

setValue

public void setValue(List<V> values)

Sets the value of this filter. In order for the filter to be applied, Filter.setActive(boolean, boolean) must be called when setting filter value programmatically.

Parameters:

values - the values

convertValuesFromString

protected List<V> convertValuesFromString(String values)

convertValueToString

protected String convertValueToString()

getType

protected Class<V> getType()

Specified by:

getType in class Filter<M,V>

onCheckChange

protected void onCheckChange(CheckChangeEvent<CheckMenuItem> event)

validateModel

protected boolean validateModel(M model)

Description copied from class: Filter

Template method to be implemented by all subclasses that is to validates the provided Model against the filters configuration. Defaults to return true.

Overrides:

validateModel in class Filter<M,V>

Parameters:

model - the model

Returns:

true if valid