AutoFilter (Keikai Spreadsheet Build 5.0.0 API)

All Known Implementing Classes:

HSSFAutoFilter, XSSFAutoFilter
```
public interface AutoFilter
```
Represents autofiltering for the specified worksheet.
Filtering data is a quick and easy way to find and work with a subset of data in a range of cells or table. For example, you can filter to see only the values that you specify, filter to see the top or bottom values, or filter to quickly see duplicate values.
TODO YK: For now (Aug 2010) POI only supports setting a basic autofilter on a range of cells. In future, when we support more auto-filter functions like custom criteria, sort, etc. we will add corresponding methods to this interface.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`FILTEROP_ABOVE_AVERAGE`
`static int`	`FILTEROP_AND` Apply a filter against a list of values
`static int`	`FILTEROP_BELOW_AVERAGE`
`static int`	`FILTEROP_BOTOOM10PERCENT`
`static int`	`FILTEROP_BOTTOM10`
`static int`	`FILTEROP_CELL_COLOR`
`static int`	`FILTEROP_FONT_COLOR`
`static int`	`FILTEROP_LAST_MONTH`
`static int`	`FILTEROP_LAST_QUARTER`
`static int`	`FILTEROP_LAST_WEEK`
`static int`	`FILTEROP_LAST_YEAR`
`static int`	`FILTEROP_M1`
`static int`	`FILTEROP_M10`
`static int`	`FILTEROP_M11`
`static int`	`FILTEROP_M12`
`static int`	`FILTEROP_M2`
`static int`	`FILTEROP_M3`
`static int`	`FILTEROP_M4`
`static int`	`FILTEROP_M5`
`static int`	`FILTEROP_M6`
`static int`	`FILTEROP_M7`
`static int`	`FILTEROP_M8`
`static int`	`FILTEROP_M9`
`static int`	`FILTEROP_NEXT_MONTH`
`static int`	`FILTEROP_NEXT_QUARTER`
`static int`	`FILTEROP_NEXT_WEEK`
`static int`	`FILTEROP_NEXT_YEAR`
`static int`	`FILTEROP_OR`
`static int`	`FILTEROP_Q1`
`static int`	`FILTEROP_Q2`
`static int`	`FILTEROP_Q3`
`static int`	`FILTEROP_Q4`
`static int`	`FILTEROP_THIS_MONTH`
`static int`	`FILTEROP_THIS_QUARTER`
`static int`	`FILTEROP_THIS_WEEK`
`static int`	`FILTEROP_THIS_YEAR`
`static int`	`FILTEROP_TODAY`
`static int`	`FILTEROP_TOMORROW`
`static int`	`FILTEROP_TOP10`
`static int`	`FILTEROP_TOP10PERCENT`
`static int`	`FILTEROP_VALUES`
`static int`	`FILTEROP_YEAR_TO_DATE`
`static int`	`FILTEROP_YESTERDAY`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`FilterColumn`	`getFilterColumn(int col)` 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.
`CellRangeAddress`	`getRangeAddress()` Returns the filtered Range.

- Field Detail
  - FILTEROP_AND
```
static final int FILTEROP_AND
```
    Apply a filter against a list of values
    Example:
    AutoFilter filter = sheet.setAutoFilter(CellRangeAddress.valueOf("A1:F200")); filter.applyFilter(0, "apache", "poi", "java", "api");
    See Also:
    
    Constant Field Values
  - FILTEROP_BOTTOM10
```
static final int FILTEROP_BOTTOM10
```
    See Also:
    
    Constant Field Values
  - FILTEROP_BOTOOM10PERCENT
```
static final int FILTEROP_BOTOOM10PERCENT
```
    See Also:
    
    Constant Field Values
  - FILTEROP_OR
```
static final int FILTEROP_OR
```
    See Also:
    
    Constant Field Values
  - FILTEROP_TOP10
```
static final int FILTEROP_TOP10
```
    See Also:
    
    Constant Field Values
  - FILTEROP_TOP10PERCENT
```
static final int FILTEROP_TOP10PERCENT
```
    See Also:
    
    Constant Field Values
  - FILTEROP_VALUES
```
static final int FILTEROP_VALUES
```
    See Also:
    
    Constant Field Values
  - FILTEROP_CELL_COLOR
```
static final int FILTEROP_CELL_COLOR
```
    See Also:
    
    Constant Field Values
  - FILTEROP_FONT_COLOR
```
static final int FILTEROP_FONT_COLOR
```
    See Also:
    
    Constant Field Values
  - FILTEROP_ABOVE_AVERAGE
```
static final int FILTEROP_ABOVE_AVERAGE
```
    See Also:
    
    Constant Field Values
  - FILTEROP_BELOW_AVERAGE
```
static final int FILTEROP_BELOW_AVERAGE
```
    See Also:
    
    Constant Field Values
  - FILTEROP_TOMORROW
```
static final int FILTEROP_TOMORROW
```
    See Also:
    
    Constant Field Values
  - FILTEROP_TODAY
```
static final int FILTEROP_TODAY
```
    See Also:
    
    Constant Field Values
  - FILTEROP_YESTERDAY
```
static final int FILTEROP_YESTERDAY
```
    See Also:
    
    Constant Field Values
  - FILTEROP_NEXT_WEEK
```
static final int FILTEROP_NEXT_WEEK
```
    See Also:
    
    Constant Field Values
  - FILTEROP_THIS_WEEK
```
static final int FILTEROP_THIS_WEEK
```
    See Also:
    
    Constant Field Values
  - FILTEROP_LAST_WEEK
```
static final int FILTEROP_LAST_WEEK
```
    See Also:
    
    Constant Field Values
  - FILTEROP_NEXT_MONTH
```
static final int FILTEROP_NEXT_MONTH
```
    See Also:
    
    Constant Field Values
  - FILTEROP_THIS_MONTH
```
static final int FILTEROP_THIS_MONTH
```
    See Also:
    
    Constant Field Values
  - FILTEROP_LAST_MONTH
```
static final int FILTEROP_LAST_MONTH
```
    See Also:
    
    Constant Field Values
  - FILTEROP_NEXT_QUARTER
```
static final int FILTEROP_NEXT_QUARTER
```
    See Also:
    
    Constant Field Values
  - FILTEROP_THIS_QUARTER
```
static final int FILTEROP_THIS_QUARTER
```
    See Also:
    
    Constant Field Values
  - FILTEROP_LAST_QUARTER
```
static final int FILTEROP_LAST_QUARTER
```
    See Also:
    
    Constant Field Values
  - FILTEROP_NEXT_YEAR
```
static final int FILTEROP_NEXT_YEAR
```
    See Also:
    
    Constant Field Values
  - FILTEROP_THIS_YEAR
```
static final int FILTEROP_THIS_YEAR
```
    See Also:
    
    Constant Field Values
  - FILTEROP_LAST_YEAR
```
static final int FILTEROP_LAST_YEAR
```
    See Also:
    
    Constant Field Values
  - FILTEROP_YEAR_TO_DATE
```
static final int FILTEROP_YEAR_TO_DATE
```
    See Also:
    
    Constant Field Values
  - FILTEROP_Q1
```
static final int FILTEROP_Q1
```
    See Also:
    
    Constant Field Values
  - FILTEROP_Q2
```
static final int FILTEROP_Q2
```
    See Also:
    
    Constant Field Values
  - FILTEROP_Q3
```
static final int FILTEROP_Q3
```
    See Also:
    
    Constant Field Values
  - FILTEROP_Q4
```
static final int FILTEROP_Q4
```
    See Also:
    
    Constant Field Values
  - FILTEROP_M1
```
static final int FILTEROP_M1
```
    See Also:
    
    Constant Field Values
  - FILTEROP_M2
```
static final int FILTEROP_M2
```
    See Also:
    
    Constant Field Values
  - FILTEROP_M3
```
static final int FILTEROP_M3
```
    See Also:
    
    Constant Field Values
  - FILTEROP_M4
```
static final int FILTEROP_M4
```
    See Also:
    
    Constant Field Values
  - FILTEROP_M5
```
static final int FILTEROP_M5
```
    See Also:
    
    Constant Field Values
  - FILTEROP_M6
```
static final int FILTEROP_M6
```
    See Also:
    
    Constant Field Values
  - FILTEROP_M7
```
static final int FILTEROP_M7
```
    See Also:
    
    Constant Field Values
  - FILTEROP_M8
```
static final int FILTEROP_M8
```
    See Also:
    
    Constant Field Values
  - FILTEROP_M9
```
static final int FILTEROP_M9
```
    See Also:
    
    Constant Field Values
  - FILTEROP_M10
```
static final int FILTEROP_M10
```
    See Also:
    
    Constant Field Values
  - FILTEROP_M11
```
static final int FILTEROP_M11
```
    See Also:
    
    Constant Field Values
  - FILTEROP_M12
```
static final int FILTEROP_M12
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getRangeAddress
```
CellRangeAddress getRangeAddress()
```
    Returns the filtered Range.
  - getFilterColumns
```
List<FilterColumn> getFilterColumns()
```
    Return filter setting of each filtered column.
  - getFilterColumn
```
FilterColumn getFilterColumn(int col)
```
    Returns the column filter information of the specified column; null if the column is not filtered.
    
    Parameters:
    
    col - 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.

Interface AutoFilter

Field Summary

Method Summary

Field Detail

FILTEROP_AND

FILTEROP_BOTTOM10

FILTEROP_BOTOOM10PERCENT

FILTEROP_OR

FILTEROP_TOP10

FILTEROP_TOP10PERCENT

FILTEROP_VALUES

FILTEROP_CELL_COLOR

FILTEROP_FONT_COLOR

FILTEROP_ABOVE_AVERAGE

FILTEROP_BELOW_AVERAGE

FILTEROP_TOMORROW

FILTEROP_TODAY

FILTEROP_YESTERDAY

FILTEROP_NEXT_WEEK

FILTEROP_THIS_WEEK

FILTEROP_LAST_WEEK

FILTEROP_NEXT_MONTH

FILTEROP_THIS_MONTH

FILTEROP_LAST_MONTH

FILTEROP_NEXT_QUARTER

FILTEROP_THIS_QUARTER

FILTEROP_LAST_QUARTER

FILTEROP_NEXT_YEAR

FILTEROP_THIS_YEAR

FILTEROP_LAST_YEAR

FILTEROP_YEAR_TO_DATE

FILTEROP_Q1

FILTEROP_Q2

FILTEROP_Q3

FILTEROP_Q4

FILTEROP_M1

FILTEROP_M2

FILTEROP_M3

FILTEROP_M4

FILTEROP_M5

FILTEROP_M6

FILTEROP_M7

FILTEROP_M8

FILTEROP_M9

FILTEROP_M10

FILTEROP_M11

FILTEROP_M12

Method Detail

getRangeAddress

getFilterColumns

getFilterColumn