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

Class NumericFilter<M,V extends Number & Comparable<V>>

java.lang.Object

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

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

Type Parameters:

M - the model in the store and in each grid row

V - the numeric type in the column to filter

All Implemented Interfaces:

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

public class NumericFilter<M,V extends Number & Comparable<V>>
extends Filter<M,V>

Filter class for numeric fields. by default, converts data to double before comparing, but this behavior can be change by overriding equals(Number, Number) and greaterThan(Number, Number). See Filter for more information.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	NumericFilter.DefaultNumericFilterMessages The default locale-sensitive messages used by this class.
static interface	NumericFilter.NumericFilterMessages The locale-sensitive messages used by this class.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
List<FilterConfig>	getFilterConfig() Returns a list of filter configurations.
NumericFilter.NumericFilterMessages	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.
int	getWidth() Returns the width used for the range sub-menu.
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.
void	setEqualValue(V value) Sets the equal value.
void	setFilterConfig(List<FilterConfig> configs) Sets the filters values using the given filter configs.
void	setGreaterThanValue(V value) Sets the greater than value.
void	setLessThanValue(V value) Sets the less than value.
void	setMessages(NumericFilter.NumericFilterMessages messages)
void	setValue(List<FilterConfig> values)
void	setWidth(int width) Sets the width to use for the range sub-menu (defaults to 125).

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

NumericFilter

public NumericFilter(ValueProvider<? super M,V> valueProvider,
             NumberPropertyEditor<V> propertyEditor)

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

Parameters:

valueProvider - the value provider

propertyEditor - property editor for numeric type <V>

Method Detail

setLessThanValue

public void setLessThanValue(V value)

Sets the less than value.

Parameters:

value - the value

setGreaterThanValue

public void setGreaterThanValue(V value)

Sets the greater than value.

Parameters:

value - the value

setEqualValue

public void setEqualValue(V value)

Sets the equal value.

Parameters:

value - the equal value

setValue

public void setValue(List<FilterConfig> values)

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 extends Number & Comparable<V>>

Returns:

a list of filter configurations

getMessages

public NumericFilter.NumericFilterMessages 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,V extends Number & Comparable<V>>

Returns:

the filter value

getWidth

public int getWidth()

Returns the width used for the range sub-menu.

Returns:

the width used for the range sub-menu

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

setMessages

public void setMessages(NumericFilter.NumericFilterMessages messages)

setWidth

public void setWidth(int width)

Sets the width to use for the range sub-menu (defaults to 125).

Parameters:

width - the width used for the range sub-menu.

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 extends Number & Comparable<V>>

Parameters:

configs - the list of filter configurations