io.keikai.model

Interface SAutoFilter

All Known Implementing Classes:

AbstractAutoFilterAdv, AutoFilterImpl

public interface SAutoFilter

Contains autofilter's setting.

Since:

3.5.0

Author:

Dennis

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SAutoFilter.FilterOp
static interface	SAutoFilter.NFilterColumn A filter column contains information for filtering, e.g.

Method Summary

Modifier and Type	Method and Description
void	clearFilterColumn(int index)
void	clearFilterColumns()
SAutoFilter.NFilterColumn	getFilterColumn(int index, boolean create) Returns the column filter information of the specified column; null if the column is not filtered.
Collection<SAutoFilter.NFilterColumn>	getFilterColumns() Return filter setting of each filtered column.
CellRegion	getRegion() Returns the filtered Region.
boolean	isFiltered()

Method Detail

getRegion

CellRegion getRegion()

Returns the filtered Region.

getFilterColumns

Collection<SAutoFilter.NFilterColumn> getFilterColumns()

Return filter setting of each filtered column.

getFilterColumn

SAutoFilter.NFilterColumn getFilterColumn(int index,
                                          boolean create)

Returns the column filter information of the specified column; null if the column is not filtered.

Parameters:

index - the nth column (1st column in the filter range is 0)

Returns:

the column filter information of the specified column; null if the column is not filtered.

clearFilterColumn

void clearFilterColumn(int index)

clearFilterColumns

void clearFilterColumns()

isFiltered

boolean isFiltered()