Top Description Methods

org.apache.poi.ss.formula

public Interface TwoDEval

Known Direct Subinterfaces: org.apache.poi.ss.formula.eval.AreaEval, org.apache.poi.ss.formula.ThreeDEval
Imports: org.apache.poi.ss.formula.eval.AreaEval, .ValueEval, org.apache.poi.ss.formula.functions.Subtotal

Common interface of AreaEval and org.apache.poi.ss.formula.eval.AreaEvalBase, for 2D (row+column) evaluations

Method Summary

Modifier and Type	Method and Description
public TwoDEval	Returns: a single column TwoDEval getColumn(int relative column index (zero based) columnIndex)
public int	getHeight()
public TwoDEval	Returns: a single row TwoDEval getRow(int relative row index (zero based) rowIndex)
public ValueEval	Returns: element at the specified row and column position getValue(int relative row index (zero based) rowIndex, int relative column index (zero based) columnIndex)
public int	getWidth()
public boolean	Returns: `true` if the area has just a single column, this also includes the trivial case when the area has just a single cell. isColumn()
public default boolean	Returns: `true` if the area has just a single row, this also includes the trivial case when the area has just a single cell. isRow()
public boolean	Returns: true if the row is hidden isRowHidden(int rowIndex)
public boolean	Returns: true if the cell at row and col is a subtotal isSubTotal(int rowIndex, int columnIndex)

Method Detail

getColumn	back to summary
public TwoDEval getColumn(int columnIndex) Parameters columnIndex:int relative column index (zero based) Returns:TwoDEval a single column TwoDEval

getHeight	back to summary
public int getHeight()

getRow	back to summary
public TwoDEval getRow(int rowIndex) Parameters rowIndex:int relative row index (zero based) Returns:TwoDEval a single row TwoDEval

getValue	back to summary
public ValueEval getValue(int rowIndex, int columnIndex) Parameters rowIndex:int relative row index (zero based) columnIndex:int relative column index (zero based) Returns:ValueEval element at the specified row and column position

getWidth	back to summary
public int getWidth()

isColumn	back to summary
public boolean isColumn() Returns:boolean `true` if the area has just a single column, this also includes the trivial case when the area has just a single cell.

isRow	back to summary
public default boolean isRow() Returns:boolean `true` if the area has just a single row, this also includes the trivial case when the area has just a single cell.

isRowHidden	back to summary
public boolean isRowHidden(int rowIndex) Returns:boolean true if the row is hidden See Also `Subtotal`

isSubTotal	back to summary
public boolean isSubTotal(int rowIndex, int columnIndex) Returns:boolean true if the cell at row and col is a subtotal