com.github.jferard.fastods

Class TableRowImpl

java.lang.Object

com.github.jferard.fastods.TableRowImpl

All Implemented Interfaces:

TableRow

public class TableRowImpl
extends Object
implements TableRow

9.1.3 table:table-row

Author:

Julien Férard, Martin Schulz

Method Summary

Modifier and Type	Method and Description
void	addValidationToContainer(Validation validation)
static void	appendXMLToTable(TableRowImpl row, XMLUtil xmlUtil, Appendable appendable) Append the XML corresponding to a given row to the appendable
void	appendXMLToTable(XMLUtil util, Appendable appendable) Write the XML dataStyles for this object.
void	coverRightCells(int colIndex, int n) Cover the cells to the right of a given index.
TableCellStyle	findDefaultCellStyle(int columnIndex) Find the default cell style for a column
int	getColumnCount()
TableCell	getOrCreateCell(int colIndex) Get the cell at given index.
RowCellWalker	getWalker() Deprecated.
boolean	isCovered(int colIndex)
void	removeRowStyle() Remove the default row style
int	rowIndex()
void	set(int colIndex, WritableTableCell cell) Set a custom table cell at a given index.
void	setCellMerge(int colIndex, int rowMerge, int columnMerge) Set the merging of multiple cells to one cell.
void	setColumnsSpanned(int colIndex, int n) Add a span across columns
void	setRowAttribute(String attribute, CharSequence value) Add an attribute to a row
void	setRowDefaultCellStyle(TableCellStyle ts) Set the cell style for the cell of this row to ts.
void	setRowFormat(DataStyles format) Add a format to this TableRow
void	setRowsSpanned(int colIndex, int n) Add a span across rows
void	setRowStyle(TableRowStyle rowStyle) Set the row style

Methods inherited from class java.lang.Object

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

Method Detail

appendXMLToTable

public static void appendXMLToTable(TableRowImpl row,
                                    XMLUtil xmlUtil,
                                    Appendable appendable)
                             throws IOException

Append the XML corresponding to a given row to the appendable

Parameters:

row - a TableRow

xmlUtil - an instance of xml util

appendable - where to append the row XML

Throws:

IOException - if an error occurs

appendXMLToTable

public void appendXMLToTable(XMLUtil util,
                             Appendable appendable)
                      throws IOException

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

Parameters:

util - a util for XML writing

appendable - where to write the XML

Throws:

IOException - If an I/O error occurs

getWalker

@Deprecated
public RowCellWalker getWalker()

Deprecated.

Returns:

a CellWalker on the row

setCellMerge

public void setCellMerge(int colIndex,
                         int rowMerge,
                         int columnMerge)
                  throws IOException

Set the merging of multiple cells to one cell.

Parameters:

colIndex - The column, 0 is the first column

rowMerge - the number of rows to merge

columnMerge - the number of cells to merge

Throws:

IOException - if the cells can't be merged

coverRightCells

public void coverRightCells(int colIndex,
                            int n)

Cover the cells to the right of a given index.

Parameters:

colIndex - the start index

n - the number of cells to cover

setColumnsSpanned

public void setColumnsSpanned(int colIndex,
                              int n)

Add a span across columns

Parameters:

colIndex - the index of the first column

n - the number of columns in the span

Throws:

IllegalArgumentException - if n < 0

setRowFormat

public void setRowFormat(DataStyles format)

Description copied from interface: TableRow

Add a format to this TableRow

Specified by:

setRowFormat in interface TableRow

Parameters:

format - the format

setRowsSpanned

public void setRowsSpanned(int colIndex,
                           int n)
                    throws IOException

Add a span across rows

Parameters:

colIndex - the index of the column

n - the number of rows in the span

Throws:

IOException - if the cells can't be merged

IllegalArgumentException - if n < 0 of this cells is covered

getOrCreateCell

public TableCell getOrCreateCell(int colIndex)

Get the cell at given index. If the cell was not created before, then it is created by this method.

Parameters:

colIndex - the index of the cell in the row

Returns:

a cell

set

public void set(int colIndex,
                WritableTableCell cell)

Set a custom table cell at a given index.

Parameters:

colIndex - the index

cell - the cell

setRowStyle

public void setRowStyle(TableRowStyle rowStyle)

Description copied from interface: TableRow

Set the row style

Specified by:

setRowStyle in interface TableRow

Parameters:

rowStyle - the style

getColumnCount

public int getColumnCount()

Specified by:

getColumnCount in interface TableRow

Returns:

the current column count

isCovered

public boolean isCovered(int colIndex)

Parameters:

colIndex - the index to look for

Returns:

true if the cell at the colIndex is covered by a span

findDefaultCellStyle

public TableCellStyle findDefaultCellStyle(int columnIndex)

Find the default cell style for a column

Parameters:

columnIndex - the column index

Returns:

the style, never null

setRowDefaultCellStyle

public void setRowDefaultCellStyle(TableCellStyle ts)

Description copied from interface: TableRow

Set the cell style for the cell of this row to ts.

Specified by:

setRowDefaultCellStyle in interface TableRow

Parameters:

ts - The table rowStyle to be used

rowIndex

public int rowIndex()

Specified by:

rowIndex in interface TableRow

Returns:

the index of this row in the table

removeRowStyle

public void removeRowStyle()

Description copied from interface: TableRow

Remove the default row style

Specified by:

removeRowStyle in interface TableRow

setRowAttribute

public void setRowAttribute(String attribute,
                            CharSequence value)

Description copied from interface: TableRow

Add an attribute to a row

Specified by:

setRowAttribute in interface TableRow

Parameters:

attribute - the attribute name

value - the value

addValidationToContainer

public void addValidationToContainer(Validation validation)