Package com.vaadin.flow.component.spreadsheet

Interface SpreadsheetFilter

All Superinterfaces:

Serializable

All Known Implementing Classes:

ItemFilter

public interface SpreadsheetFilter
extends Serializable

Interface for filter components that can be added to a SpreadsheetFilterTable. Filtering is done by simply hiding the table's rows that are filtered.

Add / remove filters from table with SpreadsheetFilterTable.registerFilter(PopupButton, SpreadsheetFilter) and SpreadsheetFilterTable.unRegisterFilter(PopupButton, SpreadsheetFilter)

When a filter been has updated (by server side or user actions), SpreadsheetFilterTable.onFiltersUpdated() should be called.

Author:

Vaadin Ltd.

Method Summary

Modifier and Type	Method	Description
void	clearFilter()	Clear the filtering options.
Set<Integer>	getFilteredRows()	Returns the rows that should be filtered by this filter.

Method Detail

clearFilter

void clearFilter()

Clear the filtering options. After this method the getFilteredRows() for this filter should return an empty set.

getFilteredRows

Set<Integer> getFilteredRows()

Returns the rows that should be filtered by this filter. In other words the returned set of rows will be hidden from the table.

Returns:

Row indexes of the filtered rows, 0-based