public interface FilterEditorSubmitHandler
extends com.google.gwt.event.shared.EventHandler
| Modifier and Type | Method and Description |
|---|---|
void |
onFilterEditorSubmit(FilterEditorSubmitEvent event)
Optional notification fired when the user performs a filter using the
Filter Editor. |
void onFilterEditorSubmit(FilterEditorSubmitEvent event)
Filter Editor. May fire as criteria values are
being edited if
filterOnKeypress is true, otherwise will fire when
the user clicks the filter
button or presses the Enter key while focus is in the Filter Editor.
Use event.cancel()
to cancel the default behavior - you must cancel the default behavior if your
code is going to call filterData(), setCriteria() or any other API that
affects the criteria applied to the grid.
The criteria parameter contains the current criteria applied to the
grid including edits the user has just made using the Filter Editor. This matches
what is returned if you call getFilterEditorCriteria().
If you wish to access the criteria applied to the grid without picking
up any edits to the Filter Editor, use getCriteria()
instead.
Developers may wish to perform a filter using the Filter Editor values from code running outside the standard filterEditorSubmit flow. For example, if you wanted a confirmation dialog to be shown before filtering was performed, you would cancel the default behavior as described above, but then need to replicate the default behavior once the user confirms that they want to proceed. To replicate the default behavior, just call:
grid.filterData(grid.getFilterEditorCriteria());or, to ensure the specified
autoFetchTextMatchStyle is picked up
DSRequest request = new DSRequest();
request.setTextMatchStyle(grid.getAutoFetchTextMatchStyle());
grid.filterData(grid.getFilterEditorCriteria(), null,
request);
event - the event