Package org.apache.poi.ss.formula.eval
Interface AreaEval
- All Superinterfaces:
SheetRange,ThreeDEval,TwoDEval,ValueEval
- All Known Implementing Classes:
AreaEvalBase,CacheAreaEval
Evaluation of 2D (Row+Column) and 3D (Sheet+Row+Column) areas
-
Method Summary
Modifier and TypeMethodDescriptionbooleancontains(int row, int col) returns true if the cell at row and col specified as absolute indexes in the sheet is contained in this area.booleancontainsColumn(int col) returns true if the specified col is in rangebooleancontainsRow(int row) returns true if the specified row is in rangegetAbsoluteValue(int row, int col) intreturns the 0-based index of the first col in this area.intreturns the 0-based index of the first row in this area.intintreturns the 0-based index of the last col in this area.intreturns the 0-based index of the last row in this area.getRelativeValue(int relativeRowIndex, int relativeColumnIndex) intgetWidth()offset(int relFirstRowIx, int relLastRowIx, int relFirstColIx, int relLastColIx) Creates anAreaEvaloffset by a relative amount from from the upper left cell of this areaMethods inherited from interface org.apache.poi.ss.formula.SheetRange
getFirstSheetIndex, getLastSheetIndexMethods inherited from interface org.apache.poi.ss.formula.ThreeDEval
getValue
-
Method Details
-
getFirstRow
int getFirstRow()returns the 0-based index of the first row in this area. -
getLastRow
int getLastRow()returns the 0-based index of the last row in this area. -
getFirstColumn
int getFirstColumn()returns the 0-based index of the first col in this area. -
getLastColumn
int getLastColumn()returns the 0-based index of the last col in this area. -
getAbsoluteValue
- Returns:
- the ValueEval from within this area at the specified row and col index. Never
null(possiblyBlankEval). The specified indexes should be absolute indexes in the sheet and not relative indexes within the area.
-
contains
boolean contains(int row, int col) returns true if the cell at row and col specified as absolute indexes in the sheet is contained in this area.- Parameters:
row-col-
-
containsColumn
boolean containsColumn(int col) returns true if the specified col is in range- Parameters:
col-
-
containsRow
boolean containsRow(int row) returns true if the specified row is in range- Parameters:
row-
-
getWidth
int getWidth() -
getHeight
int getHeight() -
getRelativeValue
- Returns:
- the ValueEval from within this area at the specified relativeRowIndex and
relativeColumnIndex. Never
null(possiblyBlankEval). The specified indexes should relative to the top left corner of this area.
-
offset
Creates anAreaEvaloffset by a relative amount from from the upper left cell of this area
-