CellFilter
Inheritance: java.lang.Object
public class CellFilter
Provides an option to limit the scope of a CellColumnRedaction to a worksheet and a column.
Learn more
- More details about spreadsheet redactions: Spreadsheet redactions
Constructors
| Constructor | Description |
|---|---|
| CellFilter() | Initializes a new instance. |
Fields
| Field | Description |
|---|---|
| NoIndex | Represents a default value for filter, which is -1. |
Methods
| Method | Description |
|---|---|
| getWorkSheetName() | Gets a worksheet name (if applicable). |
| setWorkSheetName(String value) | Sets a worksheet name (if applicable). |
| getWorkSheetIndex() | Gets a worksheet index (zero-based). |
| setWorkSheetIndex(int value) | Sets a worksheet index (zero-based). |
| hasWorkSheetIndex() | Gets a value indicating whether the WorkSheetIndex is set or not. |
| getColumnIndex() | Gets a column index (zero-based). |
| setColumnIndex(int value) | Sets a column index (zero-based). |
CellFilter()
public CellFilter()
Initializes a new instance.
NoIndex
public static final int NoIndex
Represents a default value for filter, which is -1.
getWorkSheetName()
public final String getWorkSheetName()
Gets a worksheet name (if applicable).
Returns: java.lang.String - A worksheet name (if applicable).
setWorkSheetName(String value)
public final void setWorkSheetName(String value)
Sets a worksheet name (if applicable).
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | A worksheet name (if applicable). |
getWorkSheetIndex()
public final int getWorkSheetIndex()
Gets a worksheet index (zero-based).
Returns: int - A worksheet index (zero-based).
setWorkSheetIndex(int value)
public final void setWorkSheetIndex(int value)
Sets a worksheet index (zero-based).
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | A worksheet index (zero-based). |
hasWorkSheetIndex()
public final boolean hasWorkSheetIndex()
Gets a value indicating whether the WorkSheetIndex is set or not.
Returns: boolean - A value indicating whether the WorkSheetIndex is set or not.
getColumnIndex()
public final int getColumnIndex()
Gets a column index (zero-based).
Returns: int - A column index (zero-based).
setColumnIndex(int value)
public final void setColumnIndex(int value)
Sets a column index (zero-based).
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | A column index (zero-based). |