|Modifier and Type||Method and Description|
Optional notification fired when the user performs a filter using the
HandlerRegistration addFilterEditorSubmitHandler(FilterEditorSubmitHandler handler)
Filter Editor. Useful for applying additional criteria not available in the filterEditor. Note that it is often easiest to do this with the
SearchFormattribute, which requires no code.
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.
to cancel the default behavior - you must cancel the default behavior if your
code is going to call
setCriteria() or any other API that
affects the criteria applied to the grid.
criteria parameter contains the current criteria applied to the
grid including edits the user has just made using the Filter Editor and those applied
advanced filtering dialog. A call to
getFilterEditorCriteria() does not include the
advanced filtering criteria.
If you wish to access the
criteria applied to the grid without picking
up any edits to the Filter Editor, use
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
autoFetchTextMatchStyleis picked up
DSRequest request = new DSRequest(); request.setTextMatchStyle(grid.getAutoFetchTextMatchStyle()); grid.filterData(grid.getFilterEditorCriteria(), null, request);
handler- the filterEditorSubmit handler
HandlerRegistrationused to remove this handler