FileDocCategorySizeDatePackage
AreaEval.javaAPI DocApache Poi 3.0.13192Sun Mar 11 12:59:28 GMT 2007org.apache.poi.hssf.record.formula.eval

AreaEval

public interface AreaEval implements ValueEval
author
Amol S. Deshmukh < amolweb at ya hoo dot com >

Fields Summary
Constructors Summary
Methods Summary
public booleancontains(int row, short col)
returns true if the cell at row and col specified as absolute indexes in the sheet is contained in this area.

param
row
param
col
return

public booleancontainsColumn(short col)
returns true if the specified col is in range

param
col
return

public booleancontainsRow(int row)
returns true if the specified row is in range

param
row
return

public shortgetFirstColumn()
returns the 0-based index of the first col in this area.

return

public intgetFirstRow()
returns the 0-based index of the first row in this area.

return

public shortgetLastColumn()
returns the 0-based index of the last col in this area.

return

public intgetLastRow()
returns the 0-based index of the last row in this area.

return

public org.apache.poi.hssf.record.formula.eval.ValueEvalgetValueAt(int row, short col)
returns the ValueEval from the values array at the specified row and col index. The specified indexes should be absolute indexes in the sheet and not relative indexes within the area. Also, if contains(row, col) evaluates to true, a null value will bre returned.

param
row
param
col
return

public org.apache.poi.hssf.record.formula.eval.ValueEval[]getValues()
The array of values in this area. Although the area maybe 1D (ie. isRow() or isColumn() returns true) or 2D the returned array is 1D.

return

public booleanisColumn()
returns true if the Area's start and end col indexes are same. This result of this method should agree with getFirstColumn() == getLastColumn().

return

public booleanisRow()
returns true if the Area's start and end row indexes are same. This result of this method should agree with getFirstRow() == getLastRow().

return