com.extjs.gxt.ui.client.widget.grid.filters
Class StringFilter

java.lang.Object
  extended by com.extjs.gxt.ui.client.event.BaseObservable
      extended by com.extjs.gxt.ui.client.widget.grid.filters.Filter
          extended by com.extjs.gxt.ui.client.widget.grid.filters.StringFilter
All Implemented Interfaces:
Observable

public class StringFilter
extends Filter


Nested Class Summary
static class StringFilter.StringFilterMessages
           
 
Nested classes/interfaces inherited from class com.extjs.gxt.ui.client.widget.grid.filters.Filter
Filter.FilterMessages
 
Field Summary
 
Fields inherited from class com.extjs.gxt.ui.client.widget.grid.filters.Filter
dataIndex, menu
 
Constructor Summary
StringFilter(java.lang.String dataIndex)
           
 
Method Summary
 StringFilter.StringFilterMessages getMessages()
           
 java.util.List<FilterConfig> getSerialArgs()
          Template method to be implemented by all subclasses that is to get and return serialized filter data for transmission to the server.
 java.lang.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 field width.
 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.
protected  void onFieldKeyUp(FieldEvent fe)
           
 void setMessages(Filter.FilterMessages messages)
           
 void setValue(java.lang.Object value)
          Template method to be implemented by all subclasses that is to set the value of the filter and fire the 'Update' event.
 void setWidth(int width)
          Sets the field width (defaults to 125).
 boolean validateModel(ModelData 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.extjs.gxt.ui.client.widget.grid.filters.Filter
fireUpdate, getDataIndex, getMenu, getModelValue, getUpdateBuffer, isActive, serialize, setActive, setUpdateBuffer
 
Methods inherited from class com.extjs.gxt.ui.client.event.BaseObservable
addListener, callListener, fireEvent, fireEvent, getFiresEvents, getListeners, hasActiveEvent, hasListeners, hasListeners, removeAllListeners, removeListener, setFiresEvents
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StringFilter

public StringFilter(java.lang.String dataIndex)
Method Detail

getMessages

public StringFilter.StringFilterMessages getMessages()
Overrides:
getMessages in class Filter

getSerialArgs

public java.util.List<FilterConfig> getSerialArgs()
Description copied from class: Filter
Template method to be implemented by all subclasses that is to get and return serialized filter data for transmission to the server.

Specified by:
getSerialArgs in class Filter

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

getWidth

public int getWidth()
Returns the field width.

Returns:
the field width

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
Returns:
true if if the filter has enough configuration information to be activated

setMessages

public void setMessages(Filter.FilterMessages messages)
Overrides:
setMessages in class Filter

setValue

public void setValue(java.lang.Object value)
Description copied from class: Filter
Template method to be implemented by all subclasses that is to set the value of the filter and fire the 'Update' event.

Specified by:
setValue in class Filter
Parameters:
value - the filter value

setWidth

public void setWidth(int width)
Sets the field width (defaults to 125).

Parameters:
width - the field width

validateModel

public boolean validateModel(ModelData 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
Parameters:
model - the model
Returns:
true if valid

onFieldKeyUp

protected void onFieldKeyUp(FieldEvent fe)