org.formulacompiler.spreadsheet
Interface Spreadsheet.Cell

All Superinterfaces:
Describable, Spreadsheet.Range
Enclosing interface:
Spreadsheet

public static interface Spreadsheet.Cell
extends Spreadsheet.Range

Returns information about a spreadsheet cell.

This interface is an API only. Do not implement it yourself.

Author:
peo

Method Summary
 int getColumnIndex()
          Returns the cell index (0 based) within the row.
 java.lang.Object getConstantValue()
          Returns the constant value of the cell, as defined in the spreadsheet.
 java.lang.String getErrorText()
          Returns the error text of the cell, as defined in the spreadsheet.
 java.lang.String getExpressionText()
          Returns the expression text of the cell, as parsed from the spreadsheet by AFC.
 Spreadsheet.Row getRow()
          Returns the row this cell is part of.
 java.lang.Object getValue()
          Returns the value of the cell, as saved in the spreadsheet.
 
Methods inherited from interface org.formulacompiler.spreadsheet.Spreadsheet.Range
cells, contains, getBottomRight, getTopLeft
 
Methods inherited from interface org.formulacompiler.compiler.Describable
describe, toString
 

Method Detail

getRow

Spreadsheet.Row getRow()
Returns the row this cell is part of.


getColumnIndex

int getColumnIndex()
Returns the cell index (0 based) within the row.


getConstantValue

java.lang.Object getConstantValue()
Returns the constant value of the cell, as defined in the spreadsheet.

Returns:
the value, or null if the cell is empty, an error value, or computed by a formula.
See Also:
getValue()

getErrorText

java.lang.String getErrorText()
Returns the error text of the cell, as defined in the spreadsheet.

Returns:
the text, or null if the cell is not an error cell, or computed by a formula.
See Also:
getValue()

getValue

java.lang.Object getValue()
Returns the value of the cell, as saved in the spreadsheet.

Returns:
the value, or null if the cell is empty.
See Also:
getConstantValue()

getExpressionText

java.lang.String getExpressionText()
                                   throws SpreadsheetException
Returns the expression text of the cell, as parsed from the spreadsheet by AFC.

Returns:
the text of the parsed expression, or null if the cell is empty or constant.
Throws:
SpreadsheetException