org.jopendocument.dom.spreadsheet
Class Cell<D extends ODDocument>

java.lang.Object
  org.jopendocument.dom.ODNode
      org.jopendocument.dom.StyledNode<S,D>
          org.jopendocument.dom.ImmutableDocStyledNode<S,D>
              org.jopendocument.dom.spreadsheet.Cell<D>

Type Parameters:

D - type of document

Direct Known Subclasses:

MutableCell

public class Cell<D extends ODDocument>
extends ImmutableDocStyledNode<S,D>

A cell in a calc document. If you want to change a cell value you must obtain a MutableCell.

Author:

Sylvain

Method Summary

int	getColumnsSpanned()
java.lang.String	getError() Tries to find out if this cell computation resulted in an error.
java.lang.String	getFormula()
int	getRowsSpanned()
java.lang.String	getTextValue() Calls getTextValue(boolean) using getTextValueMode().
java.lang.String	getTextValue(boolean ooMode) Return the text value of this cell.
static boolean	getTextValueMode()
java.lang.Object	getValue()
ODValueType	getValueType()
boolean	isEmpty()
boolean	isValid()
static void	setTextValueMode(boolean ooMode) Set whether getTextValue() parses strings using the standard way or using the OpenOffice.org way.

Methods inherited from class org.jopendocument.dom.ImmutableDocStyledNode

getODDocument

Methods inherited from class org.jopendocument.dom.StyledNode

getPrivateStyle, getStyle, getStyleDesc, getStyleDesc, getStyleStyleDesc, setStyleName, setStyleName

Methods inherited from class org.jopendocument.dom.ODNode

getElement, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

setTextValueMode

public static void setTextValueMode(boolean ooMode)

Set whether getTextValue() parses strings using the standard way or using the OpenOffice.org way.

Parameters:

ooMode - true if strings should be parsed the OO way.

See Also:

getTextValue(boolean)

getTextValueMode

public static boolean getTextValueMode()

getValueType

public final ODValueType getValueType()

getValue

public java.lang.Object getValue()

getTextValue

public java.lang.String getTextValue()

Calls getTextValue(boolean) using getTextValueMode().

Returns:

a string for the content of this cell.

getTextValue

public java.lang.String getTextValue(boolean ooMode)

Return the text value of this cell. This is often the formatted string of a value, e.g. "11 novembre 2009" for a date. This method doesn't just return the text content it also parses XML elements (like paragraphs, tabs and line-breaks). For the differences between the OO way (as of 3.1) and the OpenDocument way see section 5.1.1 White-space Characters of OpenDocument-v1.0-os and OpenDocument-v1.2-part1. In essence OpenOffice never trim strings.

Parameters:

ooMode - whether to use the OO way or the standard way.

Returns:

a string for the content of this cell.

getFormula

public final java.lang.String getFormula()

getError

public java.lang.String getError()

Tries to find out if this cell computation resulted in an error. This method cannot be robust since there's no error attribute in OpenDocument, we must match the value of the cell against a pattern. E.g. whether a cell has '=A0' for formula or '= "#N" & "/A"', this method will return a non-null error.

Returns:

the error or null.

isValid

public boolean isValid()

isEmpty

public final boolean isEmpty()

getColumnsSpanned

public final int getColumnsSpanned()

getRowsSpanned

public final int getRowsSpanned()