ag.ion.bion.officelayer.text.table.extended
Interface IETextTable

All Superinterfaces:

ICloneServiceProvider

All Known Implementing Classes:

ETextTable

public interface IETextTable
extends ICloneServiceProvider

Interface for extended tables.

Method Summary

void	addRows(int count) Adds row(s) to the table.
void	addRows(int index, int count) Adds row(s) at submitted index to the table.
void	addRows(int index, int count, boolean after) Adds row(s) before or after submitted index to the table.
IETextTableCell	getCell(int rowIndex, int columIndex) Returns cell with the submitted column and row index.
IETextTableCell	getCell(java.lang.String cellName) Returns cell with the submitted name.
IETextTableCellRange	getCellRange(int fistColumnIndex, int firstRowIndex, int lastColumnIndex, int lastRowIndex) Returns cell range on the basis submitted index informations.
IETextTableCellRange	getCellRange(java.lang.String rangeName) Returns cell range on the basis of the submitted cell range name.
IETextTableColumn	getColumn(int columnIndex) Returns a column at submitted index the table.
int	getColumnCount() Returns number of available columns.
IETextTableColumn[]	getColumns() Returns all columns of a table.
ITextTableProperties[]	getProperties() Returns properties of the text table.
IETextTableRow	getRow(int index) Returns text table row.
int	getRowCount() Returns number of available rows.
IETextTableRow[]	getRows() Returns text table rows.
void	remove() Removes the table.
void	removeRow(int index) Removes a specified row.
void	removeRows(int index) Removes rows.
void	removeRows(int index, int count) Removes rows.
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.clone.ICloneServiceProvider

getCloneService

Method Detail

addRows

void addRows(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

addRows

void addRows(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

addRows

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

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

Parameters:

index - index to be used

count - number of rows to be added

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

Throws:

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

getRowCount

int getRowCount()

Returns number of available rows.

Returns:

number of available rows.

getCell

IETextTableCell getCell(int rowIndex,
                        int columIndex)
                        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

getCell

IETextTableCell getCell(java.lang.String cellName)
                        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

getCellRange

IETextTableCellRange 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

IETextTableCellRange getCellRange(java.lang.String rangeName)
                                  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

getColumn

IETextTableColumn getColumn(int columnIndex)
                            throws TextException

Returns a column at submitted index the table.

Parameters:

columnIndex - index of the column

Returns:

column of a table

Throws:

TextException - if any error occurs

getColumnCount

int getColumnCount()

Returns number of available columns.

Returns:

number of available columns

getColumns

IETextTableColumn[] getColumns()
                               throws TextException

Returns all columns of a table.

Returns:

columns of a table

Throws:

TextException - if any error occurs

getProperties

ITextTableProperties[] getProperties()

Returns properties of the text table.

Returns:

properties of the text table

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

getRows

IETextTableRow[] getRows()
                         throws TextException

Returns text table rows.

Returns:

text table rows

Throws:

TextException - if any error occurs

getRow

IETextTableRow getRow(int index)
                      throws TextException

Returns text table row.

Parameters:

index - the row index

Returns:

text table row

Throws:

TextException - if any error occurs

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

removeRows

void removeRows(int index)
                throws TextException

Removes rows.

Parameters:

index - index of the first row

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.