com.mindoo.remote.api.symphony.document
Interface IRemoteTextTable

public interface IRemoteTextTable

This class represents a table.

Creation and access

• To create a new table, use the add method in the TextTables class.
• To get a table of a document, use the item method in the TextTables class.

Usage

TextTable provides access to rows, columns, and cells of a table, and provides a method to remove the table.

Method Summary

IRemoteBorder	borders(int position) This method returns a Border object that represents a border of the table.
IRemoteTextTableCell	cell(int rowIndex, int columnIndex) This method returns a TextTableCell object that represents a cell in the table specified by a column index and a row index.
IRemoteTextTableCell	cell(java.lang.String name) This method returns a TextTableCell object that represents a cell in the table specified by a column index and a row index.
IRemoteSymphonyApplication	getApplication() This property represents the Lotus Symphony application.
int	getBackColor() This property returns or sets the background color of a table.
IRemoteTextTableCells	getCells() This property returns all cells in a table.
IRemoteTextTableColumns	getColumns() This property returns a TextTableColumns object, which represents all the columns of a table.
java.lang.String	getName() This property returns or sets the name of a table.
IRemoteTextTableRows	getRows() This property returns a TextTableRows object, which represents all the rows of a table.
boolean	isAllowPageBreak() This property specifies whether to allow this table to span pages.
boolean	isBackTransparent() This property returns or sets whether the background of a table is transparent.
void	mergeCells(IRemoteTextTableCell cell1, IRemoteTextTableCell cell2) This method merge all the cells between cell1 and cell2.
void	mergeCellsByOffset(IRemoteTextTableCell cell, int hOffset, int vOffset) This method merge cells by the given cell and offset.
void	remove() This method removes the current table.
void	setAllowPageBreak(boolean allow) This property specifies whether to allow this table to span pages.
void	setBackColor(int color) This property returns or sets the background color of a table.
void	setBackTransparent(boolean transparent) This property returns or sets whether the background of a table is transparent.
void	setName(java.lang.String name) This property returns or sets the name of a table.

Method Detail

getApplication

IRemoteSymphonyApplication getApplication()
                                          throws RemoteEclipseAPIException

This property represents the Lotus Symphony application.

Returns:

application

Throws:

RemoteEclipseAPIException

isAllowPageBreak

boolean isAllowPageBreak()
                         throws RemoteEclipseAPIException

This property specifies whether to allow this table to span pages. Specifying true allows the table to span pages.

Returns:

allow

Throws:

RemoteEclipseAPIException

setAllowPageBreak

void setAllowPageBreak(boolean allow)
                       throws RemoteEclipseAPIException

This property specifies whether to allow this table to span pages. Specifying true allows the table to span pages.

Parameters:

allow - allow

Throws:

RemoteEclipseAPIException

getBackColor

int getBackColor()
                 throws RemoteEclipseAPIException

This property returns or sets the background color of a table.

Defined in

The value of this property is the decimal value of a color which you can using the RGB method in the Application class.

Returns:

color

Throws:

RemoteEclipseAPIException

setBackColor

void setBackColor(int color)
                  throws RemoteEclipseAPIException

This property returns or sets the background color of a table.

Defined in

The value of this property is the decimal value of a color which you can using the RGB method in the Application class.

Parameters:

color - color

Throws:

RemoteEclipseAPIException

isBackTransparent

boolean isBackTransparent()
                          throws RemoteEclipseAPIException

This property returns or sets whether the background of a table is transparent. Specifying true means that no background color is used in this table. Specifying false uses the background color specified by the BackColor property.

Returns:

transparent

Throws:

RemoteEclipseAPIException

setBackTransparent

void setBackTransparent(boolean transparent)
                        throws RemoteEclipseAPIException

This property returns or sets whether the background of a table is transparent. Specifying true means that no background color is used in this table. Specifying false uses the background color specified by the BackColor property.

Parameters:

transparent - transparent

Throws:

RemoteEclipseAPIException

getCells

IRemoteTextTableCells getCells()
                               throws RemoteEclipseAPIException

This property returns all cells in a table.

Returns:

cells

Throws:

RemoteEclipseAPIException

getColumns

IRemoteTextTableColumns getColumns()
                                   throws RemoteEclipseAPIException

This property returns a TextTableColumns object, which represents all the columns of a table.

Returns:

columns

Throws:

RemoteEclipseAPIException

getRows

IRemoteTextTableRows getRows()
                             throws RemoteEclipseAPIException

This property returns a TextTableRows object, which represents all the rows of a table.

Returns:

rows

Throws:

RemoteEclipseAPIException

borders

IRemoteBorder borders(int position)
                      throws RemoteEclipseAPIException

This method returns a Border object that represents a border of the table.

Parameters:

position - Specifies the type of the border, and the type can be a border type constant.

Returns:

A Border object that represents a border.

Throws:

RemoteEclipseAPIException

See Also:

IRemoteConstant

cell

IRemoteTextTableCell cell(int rowIndex,
                          int columnIndex)
                          throws RemoteEclipseAPIException

This method returns a TextTableCell object that represents a cell in the table specified by a column index and a row index.

This method throws an exception if:

• The name of cell is invalid.
• The value of the row index parameter is out of bounds.
• The value of the column index parameter is out of bounds.

Parameters:

rowIndex - Specifies the row index of the cell in the table, starting at 1.

columnIndex - Specifies the column index of the cell in the table, start at 1.

Returns:

A TextTableCell object that represents a cell.

Throws:

RemoteEclipseAPIException

cell

IRemoteTextTableCell cell(java.lang.String name)
                          throws RemoteEclipseAPIException

This method returns a TextTableCell object that represents a cell in the table specified by a column index and a row index.

This method throws an exception if:

• The name of cell is invalid.
• The value of the row index parameter is out of bounds.
• The value of the column index parameter is out of bounds.

Parameters:

name - Specifies the name of the cell.

Returns:

A TextTableCell object that represents a cell.

Throws:

RemoteEclipseAPIException

remove

void remove()
            throws RemoteEclipseAPIException

This method removes the current table.

Throws:

RemoteEclipseAPIException

setName

void setName(java.lang.String name)
             throws RemoteEclipseAPIException

This property returns or sets the name of a table.

When setting name for a table, the name of a table can not contain blank characters, otherwise this method throws an exception. If the name already exists in another table, the table's name does not change.

Parameters:

name - name

Throws:

RemoteEclipseAPIException

getName

java.lang.String getName()
                         throws RemoteEclipseAPIException

This property returns or sets the name of a table.

When setting name for a table, the name of a table can not contain blank characters, otherwise this method throws an exception. If the name already exists in another table, the table's name does not change.

Returns:

name

Throws:

RemoteEclipseAPIException

mergeCells

void mergeCells(IRemoteTextTableCell cell1,
                IRemoteTextTableCell cell2)
                throws RemoteEclipseAPIException

This method merge all the cells between cell1 and cell2.

Parameters:

cell1 - Specifies the beginning cell to merge. If the beginning cell is in another table, this method throws an exception.

cell2 - Specifies the end cell to merge. If the end cell is in another table, this method throws an exception.

Throws:

RemoteEclipseAPIException

mergeCellsByOffset

void mergeCellsByOffset(IRemoteTextTableCell cell,
                        int hOffset,
                        int vOffset)
                        throws RemoteEclipseAPIException

This method merge cells by the given cell and offset.

Parameters:

cell - Specifies the beginning cell to merge. If the beginning cell is in another table, this method throws an exception.

hOffset - Specifies the horizontal offset. The horizontal offsets should correspondingly between 0 to (the count of the rows of the table - the row number of the given cell). If the value is illegal, this method throws an exception.

vOffset - Specifies the vertical offset. The vertical offsets should correspondingly between 0 to (the count of the columns of the table - the column number of the given cell). If the value is illegal, this method throws an exception.

Throws:

RemoteEclipseAPIException