org.simpleods

Class TableCell

java.lang.Object

org.simpleods.TableCell

public class TableCell
extends java.lang.Object

Author:

Martin Schulz
Copyright 2008-2013 Martin Schulz
This file TableCell.java is part of SimpleODS.

Field Summary

Fields

Modifier and Type	Field and Description
static int	STYLE_CURRENCY
static int	STYLE_DATE
static int	STYLE_FLOAT
static int	STYLE_PERCENTAGE
static int	STYLE_STRING

Constructor Summary

Constructors

Constructor and Description
TableCell(int valuetype, java.lang.String value) A table cell.

Method Summary

Methods

Modifier and Type	Method and Description
int	getColumnsSpanned()
java.lang.String	getCurrency() Return the currently set currency value.
java.lang.String	getDateValue()
int	getRowsSpanned()
java.lang.String	getStyle()
java.lang.String	getText() Get the text within this cell.
java.lang.String	getValue()
int	getValueType()
void	setColumnsSpanned(int n) To merge cells, set the number of columns that should be merged.
void	setCurrency(java.lang.String currency) Set the currency value and table cell style to STYLE_CURRENCY.
void	setDateValue(java.util.Calendar cal) Set the date value for a cell with TableCell.STYLE_DATE.
void	setRowsSpanned(int n) To merge cells, set the number of rows that should be merged.
void	setStyle(java.lang.String style)
void	setText(java.lang.String text)
void	setValue(java.lang.String value)
void	setValueType(int valueType) Set the type of the value for this cell.
java.lang.String	toXML() Write the XML format for this object.

Methods inherited from class java.lang.Object

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

Field Detail

STYLE_STRING

public static final int STYLE_STRING

See Also:

Constant Field Values

STYLE_FLOAT

public static final int STYLE_FLOAT

See Also:

Constant Field Values

STYLE_PERCENTAGE

public static final int STYLE_PERCENTAGE

See Also:

Constant Field Values

STYLE_CURRENCY

public static final int STYLE_CURRENCY

See Also:

Constant Field Values

STYLE_DATE

public static final int STYLE_DATE

See Also:

Constant Field Values

Constructor Detail

TableCell

public TableCell(int valuetype,
         java.lang.String value)

A table cell.

Parameters:

valuetype - The value type for this cell.

value - The String content for this cell.

Method Detail

getValueType

public int getValueType()

setValueType

public void setValueType(int valueType)

Set the type of the value for this cell.

Parameters:

valueType - - TableCell.STYLE_STRING,TableCell.STYLE_FLOAT,TableCell.STYLE_PERCENTAGE,TableCell.STYLE_CURRENCY or TableCell.STYLE_DATE

getText

public java.lang.String getText()

Get the text within this cell.

Returns:

A String with the text

setText

public void setText(java.lang.String text)

getCurrency

public java.lang.String getCurrency()

Return the currently set currency value.
There is no check if this is really a table cell with style STYLE_CURRENCY.

Returns:

The currency value

setCurrency

public void setCurrency(java.lang.String currency)

Set the currency value and table cell style to STYLE_CURRENCY.

Parameters:

currency - The currency value

getValue

public java.lang.String getValue()

setValue

public void setValue(java.lang.String value)

getDateValue

public java.lang.String getDateValue()

Returns:

The date value set by setDateValue() or an empty string if nothing was set.

setDateValue

public void setDateValue(java.util.Calendar cal)

Set the date value for a cell with TableCell.STYLE_DATE.

Parameters:

cal - - A Calendar object with the date to be used

getStyle

public java.lang.String getStyle()

setStyle

public void setStyle(java.lang.String style)

getColumnsSpanned

public int getColumnsSpanned()

Returns:

The number of columns that this cell spans overs.

setColumnsSpanned

public void setColumnsSpanned(int n)

To merge cells, set the number of columns that should be merged.

Parameters:

n - - The number of cells to be merged

getRowsSpanned

public int getRowsSpanned()

Returns:

The number of rows that this cell spans overs.

setRowsSpanned

public void setRowsSpanned(int n)

To merge cells, set the number of rows that should be merged.

Parameters:

n - - The number of rows to be merged

toXML

public java.lang.String toXML()

Write the XML format for this object.
This is used while writing the ODS file.

Returns:

The XML string for this object.