org.simpleods

Class Table

java.lang.Object

org.simpleods.Table

public class Table
extends java.lang.Object

Author:

Martin Schulz
Copyright 2008-2013 Martin Schulz
This file Table.java is part of SimpleODS.
0.5.1 Changed all 'throw Exception' to 'throw SimpleOdsException'

Constructor Summary

Constructors

Constructor and Description
Table(java.lang.String sName)

Method Summary

Methods

Modifier and Type	Method and Description
TableCell	getCell(int nRow, int nCol) Get a TableCell, if no TableCell was present at this nRow,nCol, create a new one with a default of TableCell.STYLE_STRING and a content of "".
ObjectQueue	getColumnStyles()
java.lang.String[]	getConfig()
int	getLastCol()
int	getLastRow()
java.lang.String	getName() Get the name of this table.
ObjectQueue	getRows()
java.lang.String	getStyle() Get the current TableStyle
boolean	setCell(int nRow, int nCol, int valuetype, java.lang.String value) Set the value of a cell.
boolean	setCell(int nRow, int nCol, int valuetype, java.lang.String value, TableStyle ts) Set the value of a cell.
boolean	setCellStyle(int nRow, int nCol, TableStyle ts) Set the cell style for the specified cell.
void	setColumnStyle(int nCol, TableStyle ts) Set the style of a column.
void	setName(java.lang.String name) Set the name of this table.
void	setStyle(java.lang.String style) Set a new TableStyle
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

Constructor Detail

Table

public Table(java.lang.String sName)

Method Detail

getConfig

public java.lang.String[] getConfig()

Returns:

The complete configuration information of this table in a string array

getLastRow

public int getLastRow()

getLastCol

public int getLastCol()

getRows

public ObjectQueue getRows()

getColumnStyles

public ObjectQueue getColumnStyles()

getStyle

public java.lang.String getStyle()

Get the current TableStyle

Returns:

The current TableStlye

setStyle

public void setStyle(java.lang.String style)

Set a new TableStyle

Parameters:

style - The new TableStlye to be used

getName

public java.lang.String getName()

Get the name of this table.

Returns:

The name of this table.

setName

public void setName(java.lang.String name)

Set the name of this table.

Parameters:

name - The name of this table.

setCell

public boolean setCell(int nRow,
              int nCol,
              int valuetype,
              java.lang.String value)
                throws SimpleOdsException

Set the value of a cell.

Parameters:

nRow - The row (maximal 65536)

nCol - The column (maximal 256)

valuetype - The type of the value, TableCell.STYLE_STRING,TableCell.STYLE_FLOAT or TableCell.STYLE_PERCENTAGE

value - The value to be set

Returns:

true

Throws:

SimpleOdsException - Thrown when nRow or nCol have wrong values.

setCell

public boolean setCell(int nRow,
              int nCol,
              int valuetype,
              java.lang.String value,
              TableStyle ts)
                throws SimpleOdsException

Set the value of a cell.

Parameters:

nRow - The row (maximal 65536)

nCol - The column (maximal 256)

valuetype - The type of the value, TableCell.STYLE_STRING,TableCell.STYLE_FLOAT or TableCell.STYLE_PERCENTAGE

value - The value to be set

ts - The TableStyle to be used for this cell.

Returns:

true

Throws:

SimpleOdsException - Thrown when nRow or nCol have wrong values.

getCell

public TableCell getCell(int nRow,
                int nCol)

Get a TableCell, if no TableCell was present at this nRow,nCol, create a new one with a default of TableCell.STYLE_STRING and a content of "".

Parameters:

nRow - The row (maximal 65536)

nCol - The column (maximal 256)

Returns:

The TableCell for this position, maybe a new TableCell

setColumnStyle

public void setColumnStyle(int nCol,
                  TableStyle ts)
                    throws SimpleOdsException

Set the style of a column.

Parameters:

nCol - The column number

ts - The style to be used, make sure the style is of type TableStyle.STYLEFAMILY_TABLECOLUMN

Throws:

SimpleOdsException - Thrown if nCol has an invalid value.

setCellStyle

public boolean setCellStyle(int nRow,
                   int nCol,
                   TableStyle ts)
                     throws SimpleOdsException

Set the cell style for the specified cell.

Parameters:

nRow - The row number

nCol - The column number

ts - The TableStyle to be used

Returns:

TRUE The cell style was set

Throws:

SimpleOdsException - when nRow or nCol have wrong values

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.