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

Class BooleanFilter<M>

java.lang.Object

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

com.sencha.gxt.widget.core.client.grid.filters.BooleanFilter<M>

Type Parameters:

M - the model type

All Implemented Interfaces:

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

public class BooleanFilter<M>
extends Filter<M,Boolean>

A boolean filter. See Filter for more information.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BooleanFilter.BooleanFilterMessages The locale-sensitive messages used by this class.
class	BooleanFilter.DefaultBooleanFilterMessages The default locale-sensitive messages used by this class.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
List<FilterConfig>	getFilterConfig() Returns a list of filter configurations.
BooleanFilter.BooleanFilterMessages	getMessages() Returns the locale-sensitive messages used by this class.
Object	getValue() Template method to be implemented by all subclasses that is to get and return the value of the filter.
boolean	isActive() Returns true if the filter is active.
void	setFilterConfig(List<FilterConfig> configs) Sets the filters values using the given filter configs.
void	setMessages(BooleanFilter.BooleanFilterMessages messages) Sets the local-sensitive messages used by this class.
void	setValue(boolean value) Sets the value of this filter.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

BooleanFilter

public BooleanFilter(ValueProvider<? super M,Boolean> valueProvider)

Creates a boolean filter for the specified value provider. See Filter.Filter(ValueProvider) for more information.

Parameters:

valueProvider - the value provider

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,Boolean>

Returns:

a list of filter configurations

getMessages

public BooleanFilter.BooleanFilterMessages getMessages()

Returns the locale-sensitive messages used by this class.

Returns:

the local-sensitive messages used by this class.

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,Boolean>

isActive

public boolean isActive()

Description copied from class: Filter

Returns true if the filter is active.

Overrides:

isActive in class Filter<M,Boolean>

Returns:

the active state

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,Boolean>

Parameters:

configs - the list of filter configurations

setMessages

public void setMessages(BooleanFilter.BooleanFilterMessages messages)

Sets the local-sensitive messages used by this class.

Parameters:

messages - the locale sensitive messages used by this class.

setValue

public void setValue(boolean value)

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:

value - the value