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

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.ListFilter
All Implemented Interfaces:
Observable

public class ListFilter
extends Filter


Nested Class Summary
 
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
ListFilter(java.lang.String dataIndex, ListStore store)
           
 
Method Summary
 java.lang.String getDisplayProperty()
          Returns the display property.
 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.
 ListStore getStore()
          Returns the list store.
 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.
protected  void onCheckChange(MenuEvent be)
           
 void setDisplayProperty(java.lang.String displayProperty)
           
 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.
 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, getMessages, getModelValue, getUpdateBuffer, isActive, serialize, setActive, setMessages, 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

ListFilter

public ListFilter(java.lang.String dataIndex,
                  ListStore store)
Method Detail

getDisplayProperty

public java.lang.String getDisplayProperty()
Returns the display property.

Returns:
the display property

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

getStore

public ListStore getStore()
Returns the list store.

Returns:
the list store

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

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

setDisplayProperty

public void setDisplayProperty(java.lang.String displayProperty)

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

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

onCheckChange

protected void onCheckChange(MenuEvent be)