Top Description Methods
org.apache.poi.ss.formula.eval

public Interface AreaEval

extends TwoDEval, ThreeDEval
Known Direct Implementers
org.apache.poi.ss.formula.eval.AreaEvalBase
Imports
org.apache.poi.ss.formula.ThreeDEval, .TwoDEval
Evaluation of 2D (Row+Column) and 3D (Sheet+Row+Column) areas

Method Summary

Modifier and TypeMethod and Description
public 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.

public boolean
containsColumn(int col)

returns true if the specified col is in range

public boolean
containsRow(int row)

returns true if the specified row is in range

public ValueEval

Returns:

the ValueEval from within this area at the specified row and col index. Never null (possibly BlankEval). The specified indexes should be absolute indexes in the sheet and not relative indexes within the area.
getAbsoluteValue(int row, int col)

public int
getFirstColumn()

returns the 0-based index of the first col in this area.

public int
getFirstRow()

returns the 0-based index of the first row in this area.

public int
getHeight()

Redeclares org.apache.poi.ss.formula.TwoDEval.getHeight.

public int
getLastColumn()

returns the 0-based index of the last col in this area.

public int
getLastRow()

returns the 0-based index of the last row in this area.

public ValueEval

Returns:

the ValueEval from within this area at the specified relativeRowIndex and relativeColumnIndex. Never null (possibly BlankEval). The specified indexes should relative to the top left corner of this area.
getRelativeValue(int relativeRowIndex, int relativeColumnIndex)

public int
getWidth()

Redeclares org.apache.poi.ss.formula.TwoDEval.getWidth.

public AreaEval
offset(int relFirstRowIx, int relLastRowIx, int relFirstColIx, int relLastColIx)

Creates an AreaEval offset by a relative amount from the upper left cell of this area

Inherited from org.apache.poi.ss.formula.ThreeDEval:
getValue
Inherited from org.apache.poi.ss.formula.TwoDEval:
getColumngetRowgetValueisColumnisRowisRowHiddenisSubTotal

Method Detail

containsback to summary
public 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.

containsColumnback to summary
public boolean containsColumn(int col)

returns true if the specified col is in range

containsRowback to summary
public boolean containsRow(int row)

returns true if the specified row is in range

getAbsoluteValueback to summary
public ValueEval getAbsoluteValue(int row, int col)
Returns:ValueEval

the ValueEval from within this area at the specified row and col index. Never null (possibly BlankEval). The specified indexes should be absolute indexes in the sheet and not relative indexes within the area.

getFirstColumnback to summary
public int getFirstColumn()

returns the 0-based index of the first col in this area.

getFirstRowback to summary
public int getFirstRow()

returns the 0-based index of the first row in this area.

getHeightback to summary
public int getHeight()

Redeclares org.apache.poi.ss.formula.TwoDEval.getHeight.

Annotations
@Override
getLastColumnback to summary
public int getLastColumn()

returns the 0-based index of the last col in this area.

getLastRowback to summary
public int getLastRow()

returns the 0-based index of the last row in this area.

getRelativeValueback to summary
public ValueEval getRelativeValue(int relativeRowIndex, int relativeColumnIndex)
Returns:ValueEval

the ValueEval from within this area at the specified relativeRowIndex and relativeColumnIndex. Never null (possibly BlankEval). The specified indexes should relative to the top left corner of this area.

getWidthback to summary
public int getWidth()

Redeclares org.apache.poi.ss.formula.TwoDEval.getWidth.

Annotations
@Override
offsetback to summary
public AreaEval offset(int relFirstRowIx, int relLastRowIx, int relFirstColIx, int relLastColIx)

Creates an AreaEval offset by a relative amount from the upper left cell of this area