org.zkoss.poi.ss.formula

Interface TwoDEval

All Superinterfaces:

ValueEval

All Known Subinterfaces:

AreaEval

All Known Implementing Classes:

AreaEvalBase, ArrayEval, LazyAreaEval

public interface TwoDEval
extends ValueEval

Common interface of AreaEval and org.zkoss.poi.hssf.record.formula.eval.AreaEvalBase

Author:

Josh Micich

Method Summary

Modifier and Type	Method and Description
TwoDEval	getColumn(int columnIndex)
int	getHeight()
ValueEval	getNonEmptyCellValues()
TwoDEval	getRow(int rowIndex)
ValueEval	getValue(int rowIndex, int columnIndex)
int	getWidth()
boolean	isColumn()
boolean	isFiltered()
boolean	isHidden(int rowIndex, int columnIndex)
boolean	isRow()
boolean	isRowHidden(int rowIndex)
boolean	isSubTotal(int rowIndex, int columnIndex)

Method Detail

getValue

ValueEval getValue(int rowIndex,
                   int columnIndex)

Parameters:

rowIndex - relative row index (zero based)

columnIndex - relative column index (zero based)

Returns:

element at the specified row and column position

getNonEmptyCellValues

ValueEval getNonEmptyCellValues()

getWidth

int getWidth()

getHeight

int getHeight()

isRow

boolean isRow()

Returns:

true if the area has just a single row, this also includes the trivial case when the area has just a single cell.

isColumn

boolean isColumn()

Returns:

true if the area has just a single column, this also includes the trivial case when the area has just a single cell.

getRow

TwoDEval getRow(int rowIndex)

Parameters:

rowIndex - relative row index (zero based)

Returns:

a single row TwoDEval

getColumn

TwoDEval getColumn(int columnIndex)

Parameters:

columnIndex - relative column index (zero based)

Returns:

a single column TwoDEval

isSubTotal

boolean isSubTotal(int rowIndex,
                   int columnIndex)

Returns:

true if the cell at row and col is a subtotal

isHidden

boolean isHidden(int rowIndex,
                 int columnIndex)

Returns:

true if the cell at row and col is hidden

Since:

3.9.7

isRowHidden

boolean isRowHidden(int rowIndex)

Parameters:

rowIndex -

Returns:

true if the row is hidden

See Also:

Subtotal

isFiltered

boolean isFiltered()

Returns:

true if the sheet of the area exists any auto filter or table filter which is applied.

See Also:

Subtotal