io.keikai.api.model

Interface CellData

All Known Implementing Classes:

CellDataImpl

public interface CellData

This interface provides access to "data" part of a cell including type, text, and value.

Since:

3.0.0

Author:

dennis

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CellData.CellType The cell type

Method Summary

Modifier and Type	Method and Description
Boolean	getBooleanValue()
int	getColumn()
Date	getDateValue()
Double	getDoubleValue()
String	getEditText()
String	getFormatText()
String	getFormulaValue()
CellData.CellType	getResultType() Gets the cell result type.
String	getRichText()
int	getRow()
String	getStringValue()
CellData.CellType	getType() Gets the cell type. If the cell is a formula then you are possible getting the CellData.CellType.FORMULA or CellData.CellType.ERROR. You could use getResultType() to get result type for a cell or a formula-cell.
Object	getValue()
boolean	isBlank()
boolean	isFormula()
void	setEditText(String editText) Sets the edit text, for example, "123" is number, "2012/1/1" is date, "=SUM(A1:B1)" is formula
void	setRichText(String html) Sets the rich text in html format.
void	setValue(Object value) Sets the data object, it should be a String, Number, Date or Boolean
boolean	validateEditText(String editText) Validates the edit text if this cell has validation constraint

Method Detail

getRow

int getRow()

Returns:

the row index

getColumn

int getColumn()

Returns:

column index

getType

CellData.CellType getType()

Gets the cell type.
If the cell is a formula then you are possible getting the CellData.CellType.FORMULA or CellData.CellType.ERROR.
You could use getResultType() to get result type for a cell or a formula-cell.

Returns:

cell type

getResultType

CellData.CellType getResultType()

Gets the cell result type.

Returns:

cell result type

getValue

Object getValue()

Returns:

the data object, it is String, Number, Boolean

getDoubleValue

Double getDoubleValue()

Returns:

the double data object of this cell

getDateValue

Date getDateValue()

Returns:

the date data object of this cell

getStringValue

String getStringValue()

Returns:

the string object of this cell

getFormulaValue

String getFormulaValue()

Returns:

the string object that represent the formula of this cell

getBooleanValue

Boolean getBooleanValue()

Returns:

the boolean object of this cell

getFormatText

String getFormatText()

Returns:

the formatted text string

getEditText

String getEditText()

Returns:

the edit text

isBlank

boolean isBlank()

Returns:

true if it is a blank cell

isFormula

boolean isFormula()

Returns:

true if it is a formula cell

setValue

void setValue(Object value)

Sets the data object, it should be a String, Number, Date or Boolean

Parameters:

value - the data object

setEditText

void setEditText(String editText)

Sets the edit text, for example, "123" is number, "2012/1/1" is date, "=SUM(A1:B1)" is formula

Parameters:

editText -

Throws:

IllegalFormulaException

validateEditText

boolean validateEditText(String editText)

Validates the edit text if this cell has validation constraint

Parameters:

editText - the edit text

Returns:

false if the editText can't pass the validation

setRichText

void setRichText(String html)

Sets the rich text in html format.

Since:

3.6.0

getRichText

String getRichText()

Returns:

rich text in html format; null if not a rich text.

Since:

3.6.0