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

Class GridFilters<M>

java.lang.Object

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

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

Type Parameters:

M - the model type

All Implemented Interfaces:

ComponentPlugin<Grid<M>>

public class GridFilters<M>
extends AbstractGridFilters<M>

Applies filters to the rows in a grid. For more information, see AbstractGridFilters.

Nested Class Summary

Nested classes/interfaces inherited from class com.sencha.gxt.widget.core.client.grid.filters.AbstractGridFilters

AbstractGridFilters.DefaultGridFilterMessages, AbstractGridFilters.GridFilterMessages, AbstractGridFilters.GridFiltersAppearance

Field Summary

Fields inherited from class com.sencha.gxt.widget.core.client.grid.filters.AbstractGridFilters

columnModel, currentFilter, grid, loader, store

Constructor Summary

Constructors

Constructor and Description
GridFilters() Creates grid filters that are applied locally.
GridFilters(AbstractGridFilters.GridFiltersAppearance appearance) Creates grid filters that are applied locally.
GridFilters(Loader<? extends FilterPagingLoadConfig,?> loader) Creates grid filters to be applied remotely.
GridFilters(Loader<? extends FilterPagingLoadConfig,?> loader, AbstractGridFilters.GridFiltersAppearance appearance) Creates grid filters to be applied remotely.

Method Summary

Modifier and Type	Method and Description
protected Store<M>	getStore() Returns the store used by the grid filters.
boolean	isLocal() Returns true if the grid filters are to be applied locally.
void	setLocal(boolean local) True to use Store filter functions (local filtering) instead of the default server side filtering (defaults to false).

Methods inherited from class com.sencha.gxt.widget.core.client.grid.filters.AbstractGridFilters

addFilter, bindColumnModel, bindStore, buildQuery, cleanParams, clearFilters, getAppearance, getFilter, getFilterData, getLoader, getMenuFilter, getMessages, getModelFilter, handleBeforeLoad, handleLoad, initPlugin, isAutoReload, onCheckChange, onContextMenu, onStateChange, reload, removeAll, removeFilter, setAutoReload, setUpdateBuffer, updateColumnHeadings

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GridFilters

public GridFilters()

Creates grid filters that are applied locally. See AbstractGridFilters.AbstractGridFilters() for more information.

GridFilters

public GridFilters(Loader<? extends FilterPagingLoadConfig,?> loader)

Creates grid filters to be applied remotely. See AbstractGridFilters.AbstractGridFilters(Loader) for more information.

Parameters:

loader - the remote loader

GridFilters

public GridFilters(AbstractGridFilters.GridFiltersAppearance appearance)

Creates grid filters that are applied locally. See AbstractGridFilters.AbstractGridFilters() for more information.

Parameters:

appearance - the filters appearance

GridFilters

public GridFilters(Loader<? extends FilterPagingLoadConfig,?> loader,
                   AbstractGridFilters.GridFiltersAppearance appearance)

Creates grid filters to be applied remotely. See AbstractGridFilters.AbstractGridFilters(Loader) for more information.

Parameters:

loader - the remote loader

appearance - the filters appearance

Method Detail

isLocal

public boolean isLocal()

Description copied from class: AbstractGridFilters

Returns true if the grid filters are to be applied locally.

Overrides:

isLocal in class AbstractGridFilters<M>

Returns:

true if the grid filters are to be applied locally

setLocal

public void setLocal(boolean local)

Description copied from class: AbstractGridFilters

True to use Store filter functions (local filtering) instead of the default server side filtering (defaults to false).

Overrides:

setLocal in class AbstractGridFilters<M>

Parameters:

local - true for local

getStore

protected Store<M> getStore()

Description copied from class: AbstractGridFilters

Returns the store used by the grid filters.

Specified by:

getStore in class AbstractGridFilters<M>

Returns:

the store used by the grid filters