ag.ion.bion.officelayer.text
Interface ITextTable

All Superinterfaces:

ICloneServiceProvider, ITextComponent, ITextContent

All Known Implementing Classes:

TextTable

public interface ITextTable
extends ITextContent, ICloneServiceProvider

Table in a text document.

Field Summary

static int	MAX_CELLS_IN_TABLE Maximum number of cells in a table.
static int	MAX_COLUMNS_IN_TABLE The function getCellRangeByPosition of the interface XCellRange works not properly.

Method Summary

void	addColumn(int count) Adds column(s) to the table.
void	addColumn(int index, int count) Adds column(s) before or after submitted index to the table.
void	addColumn(int index, int count, boolean after) Adds column(s) at submitted index the table.
void	addRow(int count) Adds row(s) to the table.
void	addRow(int index, int count) Adds row(s) at submitted index to the table.
ITextTableCell	getCell(int columnIndex, int rowIndex) Returns cell with the submitted column and row index.
ITextTableCell	getCell(java.lang.String name) Returns cell with the submitted name.
ITextTableCellRange	getCellRange(int fistColumnIndex, int firstRowIndex, int lastColumnIndex, int lastRowIndex) Returns cell range on the basis submitted index informations.
ITextTableCellRange	getCellRange(java.lang.String cellRangeName) Returns cell range on the basis of the submitted cell range name.
ITextTableCell[]	getCellsWithFormula() Returns all cells with formulas.
ITextTableColumn	getColumn(int index) Returns a column at submitted index the table.
int	getColumnCount() Returns number of available columns.
ITextTableColumn[]	getColumns() Returns all columns of a table.
java.lang.String	getName() Returns name of the table.
ITextTableProperties	getProperties() Returns properties of the text table.
ITextTablePropertyStore	getPropertyStore() Returns the property store of the table.
ITextTableRow	getRow(int index) Returns text table row.
int	getRowCount() Returns number of available rows.
ITextTableRow[]	getRows() Returns text table row.
short	getTableEndPageNumber() Returns the page number where the table ends, returns -1 if page number could not be determined.
short	getTableStartPageNumber() Returns the page number where the table starts, returns -1 if page number could not be determined.
ITextRange	getTextRange() Returns text range of the text table.
com.sun.star.text.XTextContent	getXTextContent() Returns OpenOffice.org XTextContent interface.
com.sun.star.text.XTextTable	getXTextTable() Returns OpenOffice.org XTextTable interface.
void	markTable() Marks the table.
void	remove() Removes the table.
void	removeRow(int index) Removes a specified row.
void	removeRows(int index, int count) Removes rows.
void	setHeaderRows(int headerRows) Sets the number of header rows to apply header style for.
void	spreadColumnsEvenly() Spread all columns evenly.
void	spreadColumnsEvenly(int startIndex, int endIndex) Spread columns in range evenly.

Methods inherited from interface ag.ion.bion.officelayer.text.ITextComponent

getTextDocument

Methods inherited from interface ag.ion.bion.officelayer.clone.ICloneServiceProvider

getCloneService

Field Detail

MAX_CELLS_IN_TABLE

static final int MAX_CELLS_IN_TABLE

Maximum number of cells in a table.

See Also:

Constant Field Values

MAX_COLUMNS_IN_TABLE

static final int MAX_COLUMNS_IN_TABLE

The function getCellRangeByPosition of the interface XCellRange works not properly. A column index over 51 causes a dead lock in OpenOffice.org. Therefore we do not support tables which have more than 52 columns.

See Also:

Constant Field Values

Method Detail

getXTextContent

com.sun.star.text.XTextContent getXTextContent()

Returns OpenOffice.org XTextContent interface.

Specified by:

getXTextContent in interface ITextContent

Returns:

OpenOffice.org XTextContent interface

getXTextTable

com.sun.star.text.XTextTable getXTextTable()

Returns OpenOffice.org XTextTable interface.

Returns:

OpenOffice.org XTextTable interface

getTextRange

ITextRange getTextRange()
                        throws java.lang.Exception

Returns text range of the text table.

Returns:

text range of the text table

Throws:

java.lang.Exception

getProperties

ITextTableProperties getProperties()

Returns properties of the text table.

Returns:

properties of the text table

getName

java.lang.String getName()

Returns name of the table.

Returns:

name of the table

addRow

void addRow(int count)
            throws TextException

Adds row(s) to the table.

Parameters:

count - number of rows to be added

Throws:

TextException - if the row(s) can not be added

addRow

void addRow(int index,
            int count)
            throws TextException

Adds row(s) at submitted index to the table.

Parameters:

index - index to be used

count - number of rows to be added

Throws:

TextException - if the row(s) can not be added

getRowCount

int getRowCount()

Returns number of available rows.

Returns:

number of available rows.

addColumn

void addColumn(int count)
               throws TextException

Adds column(s) to the table.

Parameters:

count - number of columns to be added

Throws:

TextException - if the column(s) can not be added

addColumn

void addColumn(int index,
               int count,
               boolean after)
               throws TextException

Adds column(s) at submitted index the table.

Parameters:

index - index to be used

count - number of columns to be added

after - true, if the rows shoud be addes after submitted index

Throws:

TextException - if the column(s) can not be added

addColumn

void addColumn(int index,
               int count)
               throws TextException

Adds column(s) before or after submitted index to the table.

Parameters:

index - index to be used

count - number of columns to be added

Throws:

TextException - if the column(s) can not be added

getColumn

ITextTableColumn getColumn(int index)
                           throws TextException

Returns a column at submitted index the table.

Parameters:

index - index to be used

Returns:

column of a table

Throws:

TextException - if any error occurs

getColumns

ITextTableColumn[] getColumns()
                              throws TextException

Returns all columns of a table.

Returns:

columns of a table

Throws:

TextException - if any error occurs

getColumnCount

int getColumnCount()

Returns number of available columns.

Returns:

number of available columns

spreadColumnsEvenly

void spreadColumnsEvenly()
                         throws TextException

Spread all columns evenly.

Throws:

TextException - if necessary properties are not available

spreadColumnsEvenly

void spreadColumnsEvenly(int startIndex,
                         int endIndex)
                         throws TextException

Spread columns in range evenly.

Parameters:

startIndex - index of the first column in range

endIndex - index of the last column in range

Throws:

TextException - if necessary properties are not available

getCell

ITextTableCell getCell(java.lang.String name)
                       throws TextException

Returns cell with the submitted name.

Parameters:

name - name of the cell

Returns:

cell with the submitted name

Throws:

TextException - if the cell is not available

getCellsWithFormula

ITextTableCell[] getCellsWithFormula()

Returns all cells with formulas.

Returns:

cells with formulas

getCell

ITextTableCell getCell(int columnIndex,
                       int rowIndex)
                       throws TextException

Returns cell with the submitted column and row index.

Parameters:

columnIndex - column index of the cell

rowIndex - row index of the cell

Returns:

cell with the submitted column and row index

Throws:

TextException - if the cell is not available

getCellRange

ITextTableCellRange getCellRange(int fistColumnIndex,
                                 int firstRowIndex,
                                 int lastColumnIndex,
                                 int lastRowIndex)
                                 throws TextException

Returns cell range on the basis submitted index informations.

Parameters:

fistColumnIndex - index of first column inside the range

firstRowIndex - index of first row inside the range

lastColumnIndex - index of last column inside the range

lastRowIndex - index of last row inside the range

Returns:

cell range on the basis submitted index informations

Throws:

TextException - if the cell range is not available

getCellRange

ITextTableCellRange getCellRange(java.lang.String cellRangeName)
                                 throws TextException

Returns cell range on the basis of the submitted cell range name.

Parameters:

cellRangeName - name of the cell range

Returns:

cell range on the basis of the submitted cell range name

Throws:

TextException - if the cell range is not available

getRows

ITextTableRow[] getRows()

Returns text table row.

Returns:

text table row

getRow

ITextTableRow getRow(int index)

Returns text table row.

Parameters:

index - the row index

Returns:

text table row

getPropertyStore

ITextTablePropertyStore getPropertyStore()
                                         throws TextException

Returns the property store of the table.

Throws:

TextException

removeRow

void removeRow(int index)
               throws TextException

Removes a specified row.

Parameters:

index - index of the row

Throws:

TextException - if the row could not removed

removeRows

void removeRows(int index,
                int count)
                throws TextException

Removes rows.

Parameters:

index - index of the first row

count - number of rows to remove

Throws:

TextException - if the rows could not removed

remove

void remove()
            throws TextException

Removes the table.

Throws:

TextException - if the table could not be removed.

getTableStartPageNumber

short getTableStartPageNumber()

Returns the page number where the table starts, returns -1 if page number could not be determined.

Returns:

the page number where the table starts, returns -1 if page number could not be determined

getTableEndPageNumber

short getTableEndPageNumber()

Returns the page number where the table ends, returns -1 if page number could not be determined.

Returns:

the page number where the table ends, returns -1 if page number could not be determined

setHeaderRows

void setHeaderRows(int headerRows)
                   throws TextException

Sets the number of header rows to apply header style for. NOTE: Table must already be inserted before calling this method.

Parameters:

headerRows - number of header rows

Throws:

TextException - if the header rows could not be set

markTable

void markTable()

Marks the table.