Properties
Methods
Events
Config Options
Direct Link
| Package: | Ext.ux.grid.filter |
| Defined In: | Filter.js |
| Class: | Filter |
| Subclasses: | BooleanFilter, DateFilter, ListFilter, NumericFilter, StringFilter |
| Extends: | Object |
| Config Options | Defined By | |
|---|---|---|
| active : Boolean Indicates the initial status of the filter (defaults to false). | Filter | |
| active : Boolean Indicates the initial status of the filter (defaults to false). | Filter | |
| dataIndex : String The Ext.data.Store dataIndex of the field this filter represents.
The dataIndex does not actually have to exist in th... The Ext.data.Store dataIndex of the field this filter represents.
The dataIndex does not actually have to exist in the store. | Filter | |
| dataIndex : String The Ext.data.Store dataIndex of the field this filter represents.
The dataIndex does not actually have to exist in th... The Ext.data.Store dataIndex of the field this filter represents.
The dataIndex does not actually have to exist in the store. | Filter | |
| updateBuffer : Number Number of milliseconds to wait after user interaction to fire an update. Only supported
by filters: 'list', 'numeric... Number of milliseconds to wait after user interaction to fire an update. Only supported
by filters: 'list', 'numeric', and 'string'. Defaults to 500. | Filter | |
| updateBuffer : Number Number of milliseconds to wait after user interaction to fire an update. Only supported
by filters: 'list', 'numeric... Number of milliseconds to wait after user interaction to fire an update. Only supported
by filters: 'list', 'numeric', and 'string'. Defaults to 500. | Filter | |
| Property | Defined By | |
|---|---|---|
| active : Boolean True if this filter is active. Use setActive() to alter after configuration. | Filter | |
| active : Boolean True if this filter is active. Use setActive() to alter after configuration. | Filter | |
| getSerialArgs : Object Template method to be implemented by all subclasses that is to
get and return serialized filter data for transmission... Template method to be implemented by all subclasses that is to
get and return serialized filter data for transmission to the server.
Defaults to Ext.emptyFn. | Filter | |
| getSerialArgs : Object Template method to be implemented by all subclasses that is to
get and return serialized filter data for transmission... Template method to be implemented by all subclasses that is to
get and return serialized filter data for transmission to the server.
Defaults to Ext.emptyFn. | Filter | |
| init : Object Template method to be implemented by all subclasses that is to
initialize the filter and install required menu items.... Template method to be implemented by all subclasses that is to
initialize the filter and install required menu items.
Defaults to Ext.emptyFn. | Filter | |
| init : Object Template method to be implemented by all subclasses that is to
initialize the filter and install required menu items.... Template method to be implemented by all subclasses that is to
initialize the filter and install required menu items.
Defaults to Ext.emptyFn. | Filter | |
| menu : Ext.menu.Menu The filter configuration menu that will be installed into the filter submenu of a column menu. | Filter | |
| menu : Ext.menu.Menu The filter configuration menu that will be installed into the filter submenu of a column menu. | Filter | |
| Method | Defined By | |
|---|---|---|
| destroy()
:
void Destroys this filter by purging any event listeners, and removing any menus. Destroys this filter by purging any event listeners, and removing any menus. Parameters:
| Filter | |
| getValue()
:
Object Template method to be implemented by all subclasses that is to
get and return the value of the filter.
Defaults to Ex... Template method to be implemented by all subclasses that is to
get and return the value of the filter.
Defaults to Ext.emptyFn. Parameters:
| Filter | |
| isActivatable()
:
Boolean Template method to be implemented by all subclasses that is to
return true if the filter has enough configuration inf... Template method to be implemented by all subclasses that is to
return true if the filter has enough configuration information to be activated.
Defaults to return true. Parameters:
| Filter | |
| serialize()
:
Object/Array Returns the serialized filter data for transmission to the server
and fires the 'serialize' event. Returns the serialized filter data for transmission to the server
and fires the 'serialize' event. Parameters:
| Filter | |
setActive( Boolean active, Boolean suppressEvent )
:
voidSets the status of the filter and fires the appropriate events. Sets the status of the filter and fires the appropriate events. Parameters:
| Filter | |
setValue( Object data )
:
voidTemplate method to be implemented by all subclasses that is to
set the value of the filter and fire the 'update' even... Template method to be implemented by all subclasses that is to
set the value of the filter and fire the 'update' event.
Defaults to Ext.emptyFn. Parameters:
| Filter | |
validateRecord( Ext.data.Record record )
:
BooleanTemplate method to be implemented by all subclasses that is to
validates the provided Ext.data.Record against the fil... Template method to be implemented by all subclasses that is to
validates the provided Ext.data.Record against the filters configuration.
Defaults to return true. Parameters:
| Filter | |
| Event | Defined By | |
|---|---|---|
activate :
( Ext.ux.grid.filter.Filter this )
Fires when an inactive filter becomes active Fires when an inactive filter becomes active Listeners will be called with the following arguments:
| Filter | |
activate :
( Ext.ux.grid.filter.Filter this )
Fires when an inactive filter becomes active Fires when an inactive filter becomes active Listeners will be called with the following arguments:
| Filter | |
deactivate :
( Ext.ux.grid.filter.Filter this )
Fires when an active filter becomes inactive Fires when an active filter becomes inactive Listeners will be called with the following arguments:
| Filter | |
deactivate :
( Ext.ux.grid.filter.Filter this )
Fires when an active filter becomes inactive Fires when an active filter becomes inactive Listeners will be called with the following arguments:
| Filter | |
serialize :
( Array/Object data, Ext.ux.grid.filter.Filter filter )
Fires after the serialization process. Use this to attach additional parameters to serialization
data before it is en... Fires after the serialization process. Use this to attach additional parameters to serialization
data before it is encoded and sent to the server. Listeners will be called with the following arguments:
| Filter | |
serialize :
( Array/Object data, Ext.ux.grid.filter.Filter filter )
Fires after the serialization process. Use this to attach additional parameters to serialization
data before it is en... Fires after the serialization process. Use this to attach additional parameters to serialization
data before it is encoded and sent to the server. Listeners will be called with the following arguments:
| Filter | |
update :
( Ext.ux.grid.filter.Filter this )
Fires when a filter configuration has changed Fires when a filter configuration has changed Listeners will be called with the following arguments:
| Filter | |
update :
( Ext.ux.grid.filter.Filter this )
Fires when a filter configuration has changed Fires when a filter configuration has changed Listeners will be called with the following arguments:
| Filter | |