|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.extjs.gxt.ui.client.widget.grid.filters.AbstractGridFilters
public abstract class AbstractGridFilters
Nested Class Summary | |
---|---|
static class |
AbstractGridFilters.GridFiltersMessages
|
Field Summary | |
---|---|
protected Grid<ModelData> |
grid
|
Constructor Summary | |
---|---|
AbstractGridFilters()
|
Method Summary | |
---|---|
void |
addFilter(Filter filter)
Adds the given filter. |
protected void |
bindStore(Store<ModelData> store)
|
java.util.List<FilterConfig> |
buildQuery(java.util.List<Filter> filters)
Function to take the active filters data and build it into a query. |
void |
cleanParams(FilterPagingLoadConfig config)
Removes filter related query parameters from the provided object. |
void |
clearFilters()
Turns all filters off. |
Filter |
getFilter(java.lang.String dataIndex)
|
java.util.List<Filter> |
getFilterData()
Returns a list of the currently active filters. |
protected abstract Loader<?> |
getLoader(Store<ModelData> store)
|
protected Filter |
getMenuFilter(MenuEvent me)
|
AbstractGridFilters.GridFiltersMessages |
getMessages()
|
protected StoreFilter<ModelData> |
getModelFilter()
|
protected abstract Store<ModelData> |
getStore()
|
int |
getUpdateBuffer()
Returns the number of milliseconds to defer store updates. |
void |
init(Component component)
Initializes the plugin when the component is created. |
boolean |
isAutoReload()
Returns true if auto load is enabled. |
protected boolean |
isLocal()
Returns true if local filtering is enabled. |
protected void |
onBeforeCheck(MenuEvent me)
|
protected void |
onBeforeLoad(LoadEvent le)
|
protected void |
onCheckChange(MenuEvent me)
|
protected void |
onContextMenu(GridEvent<?> be)
|
protected void |
onLoad(LoadEvent le)
|
protected void |
onReconfigure()
|
protected void |
onStateChange(Filter filter)
|
protected void |
reload()
|
void |
removeAll()
Removes all filters. |
void |
removeFilter(Filter filter)
Removes the given filter. |
void |
setAutoReload(boolean autoLoad)
Tree to reload the datasource when a filter change happens (defaults to true). |
protected void |
setLocal(boolean local)
True to use Store filter functions (local filtering) instead of the default server side filtering (defaults to false). |
void |
setMessages(AbstractGridFilters.GridFiltersMessages messages)
|
void |
setUpdateBuffer(int updateBuffer)
Number of milliseconds to defer store updates since the last filter change (defaults to 500). |
void |
updateColumnHeadings()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected Grid<ModelData> grid
Constructor Detail |
---|
public AbstractGridFilters()
Method Detail |
---|
public void addFilter(Filter filter)
filter
- the filter to be addedpublic java.util.List<FilterConfig> buildQuery(java.util.List<Filter> filters)
filters
- the active filters
public void cleanParams(FilterPagingLoadConfig config)
config
- the load configpublic void clearFilters()
removeAll()
).
public Filter getFilter(java.lang.String dataIndex)
public java.util.List<Filter> getFilterData()
public AbstractGridFilters.GridFiltersMessages getMessages()
public int getUpdateBuffer()
public void init(Component component)
ComponentPlugin
init
in interface ComponentPlugin
component
- the source componentpublic boolean isAutoReload()
public void removeAll()
public void removeFilter(Filter filter)
filter
- the filter to be removedpublic void setAutoReload(boolean autoLoad)
autoLoad
- true to enable auto reloadpublic void setMessages(AbstractGridFilters.GridFiltersMessages messages)
public void setUpdateBuffer(int updateBuffer)
updateBuffer
- the buffer in millisecondspublic void updateColumnHeadings()
protected void bindStore(Store<ModelData> store)
protected abstract Loader<?> getLoader(Store<ModelData> store)
protected Filter getMenuFilter(MenuEvent me)
protected StoreFilter<ModelData> getModelFilter()
protected abstract Store<ModelData> getStore()
protected boolean isLocal()
protected void onBeforeCheck(MenuEvent me)
protected void onBeforeLoad(LoadEvent le)
protected void onCheckChange(MenuEvent me)
protected void onContextMenu(GridEvent<?> be)
protected void onLoad(LoadEvent le)
protected void onReconfigure()
protected void onStateChange(Filter filter)
protected void reload()
protected void setLocal(boolean local)
local
- true for local
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |