org.zkoss.poi.hssf.usermodel

Class HSSFAutoFilter

java.lang.Object

org.zkoss.poi.hssf.usermodel.HSSFAutoFilter

All Implemented Interfaces:

AutoFilter

public final class HSSFAutoFilter
extends Object
implements AutoFilter

Represents autofiltering for the specified worksheet.

Author:

Yegor Kozlov, Peterkuo, dennischen , remove unnecessary implementation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	HSSFAutoFilter.HSSFFilterColumn

Field Summary

Fields inherited from interface org.zkoss.poi.ss.usermodel.AutoFilter

FILTEROP_ABOVE_AVERAGE, FILTEROP_AND, FILTEROP_BELOW_AVERAGE, FILTEROP_BOTOOM10PERCENT, FILTEROP_BOTTOM10, FILTEROP_CELL_COLOR, FILTEROP_FONT_COLOR, FILTEROP_LAST_MONTH, FILTEROP_LAST_QUARTER, FILTEROP_LAST_WEEK, FILTEROP_LAST_YEAR, FILTEROP_M1, FILTEROP_M10, FILTEROP_M11, FILTEROP_M12, FILTEROP_M2, FILTEROP_M3, FILTEROP_M4, FILTEROP_M5, FILTEROP_M6, FILTEROP_M7, FILTEROP_M8, FILTEROP_M9, FILTEROP_NEXT_MONTH, FILTEROP_NEXT_QUARTER, FILTEROP_NEXT_WEEK, FILTEROP_NEXT_YEAR, FILTEROP_OR, FILTEROP_Q1, FILTEROP_Q2, FILTEROP_Q3, FILTEROP_Q4, FILTEROP_THIS_MONTH, FILTEROP_THIS_QUARTER, FILTEROP_THIS_WEEK, FILTEROP_THIS_YEAR, FILTEROP_TODAY, FILTEROP_TOMORROW, FILTEROP_TOP10, FILTEROP_TOP10PERCENT, FILTEROP_VALUES, FILTEROP_YEAR_TO_DATE, FILTEROP_YESTERDAY

Method Summary

Modifier and Type	Method and Description
FilterColumn	getFilterColumn(int colId) Returns the column filter information of the specified column; null if the column is not filtered.
List<FilterColumn>	getFilterColumns() Return filter setting of each filtered column.
FilterColumn	getOrCreateFilterColumn(int colId)
CellRangeAddress	getRangeAddress() Returns the filtered Range.
List<String>	getValuesOfFilter(int column)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getValuesOfFilter

public List<String> getValuesOfFilter(int column)

getRangeAddress

public CellRangeAddress getRangeAddress()

Description copied from interface: AutoFilter

Returns the filtered Range.

Specified by:

getRangeAddress in interface AutoFilter

getFilterColumns

public List<FilterColumn> getFilterColumns()

Description copied from interface: AutoFilter

Return filter setting of each filtered column.

Specified by:

getFilterColumns in interface AutoFilter

getFilterColumn

public FilterColumn getFilterColumn(int colId)

Description copied from interface: AutoFilter

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

Specified by:

getFilterColumn in interface AutoFilter

Parameters:

colId - 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.

getOrCreateFilterColumn

public FilterColumn getOrCreateFilterColumn(int colId)