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

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

Type Parameters:

M - the model type

All Implemented Interfaces:

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

public class StringFilter<M>
extends Filter<M,java.lang.String>

A string filter. See Filter for more information.

Nested Class Summary

class	StringFilter.DefaultStringFilterMessages The default locale-sensitive messages used by this class.
static interface	StringFilter.StringFilterMessages The locale-sensitive messages used by this class.

Constructor Summary

StringFilter(ValueProvider<? super M,java.lang.String> valueProvider)
Creates a string filter for the specified value provider.

Method Summary

java.util.List<FilterConfig>	getFilterConfig() Returns a list of filter configurations.
StringFilter.StringFilterMessages	getMessages() Returns the locale-sensitive messages used by this class.
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.
void	setMessages(StringFilter.StringFilterMessages messages) Sets the local-sensitive messages used by this class.

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

StringFilter

public StringFilter(ValueProvider<? super M,java.lang.String> valueProvider)

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

Parameters:

valueProvider - the value provider

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,java.lang.String>

Returns:

a list of filter configurations

getMessages

public StringFilter.StringFilterMessages getMessages()

Returns the locale-sensitive messages used by this class.

Returns:

the local-sensitive messages used by this class.

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,java.lang.String>

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(StringFilter.StringFilterMessages messages)

Sets the local-sensitive messages used by this class.

Parameters:

messages - the locale sensitive messages used by this class.