Class ecm.widget.listView.modules.FilterData
Extends
ecm.widget.listView.modules._Module.
This content list module provides filter capability using the gridx module Filter. This module allows the
user to type in their filter in the filter text box. This module will then filter the grid on any of the
filterable columns containing this input value.
If showFilterButton is true, then this module also displays the filter builder button which allows the
user to build their filter using a filter dialog. The filter builder capability is provided by the
FilterBar gridx module.
Defined in: <ecm\widget\listView\modules\FilterData.js>.
Constructor Summary
Constructor Attributes | Constructor Name and Description |
---|---|
Field Summary
Field Attributes | Field Name and Description |
---|---|
The time (in ms) delay before applying the filter after each key stroke in the filter box.
|
|
Boolean indicating if the filtering should be case sensitive.
|
|
Boolean indicates if the filter button should show.
|
Method Summary
Method Attributes | Method Name and Description |
---|---|
Clears the filter.
|
|
destroy()
Destroy.
|
|
See GridX API documentation for details.
|
|
preload()
Preload listens to events.
|
|
Shows the filter dialog.
|
Field Detail
delay
The time (in ms) delay before applying the filter after each key stroke in the filter box.
isCaseSensitive
Boolean indicating if the filtering should be case sensitive.
- Since:
- 2.0.3
showFilterButton
Boolean indicates if the filter button should show. If the filter button shows, then the FilterBar gridx
module will be added to the list of grid modules.
Method Detail
clearFilter()
Clears the filter.
destroy()
Destroy.
getAPIPath()
See GridX API documentation for details.
preload()
Preload listens to events.
showFilterDialog()
Shows the filter dialog.