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

public interface IRemoteTextTables

This class represents all the tables in a document.

Access

To get all the tables of a document, use the Tables property in the Document class.

Usage

TextTables provides access to tables, and provides a method to insert new tables.

Method Summary

IRemoteTextTable	add(IRemoteTextRange position, int numOfRow, int numOfColumn) This method creates a new table at the specified position.
IRemoteSymphonyApplication	getApplication() This property represents the Lotus Symphony application.
int	getCount() This property represents the number of table in a document.
IRemoteTextTable	item(int index) This method gets a table according to an index or name.
IRemoteTextTable	item(java.lang.String name) This method gets a table according to an index or name.

Method Detail

getApplication

IRemoteSymphonyApplication getApplication()
                                          throws RemoteEclipseAPIException

This property represents the Lotus Symphony application.

Returns:

application

Throws:

RemoteEclipseAPIException

getCount

int getCount()
             throws RemoteEclipseAPIException

This property represents the number of table in a document.

Returns:

count

Throws:

RemoteEclipseAPIException

add

IRemoteTextTable add(IRemoteTextRange position,
                     int numOfRow,
                     int numOfColumn)
                     throws RemoteEclipseAPIException

This method creates a new table at the specified position.

If the number of rows or the number of columns in the table is out of bound, this method throws an exception.

Parameters:

position - Specifies the position before which the new table is to be inserted.

numOfRow - Specifies the number of rows in the new table. The maximum number of rows in a table is 3276.

numOfColumn - Specifies the number of columns in the new table. The maximum number of columns in a table is 64.

Returns:

A TextTable object that represents a table.

Throws:

RemoteEclipseAPIException

item

IRemoteTextTable item(int index)
                      throws RemoteEclipseAPIException

This method gets a table according to an index or name.

Parameters:

index - Specifies the index of the table, starting at 1.

Returns:

A TextTable object that represents a table.

Throws:

RemoteEclipseAPIException

item

IRemoteTextTable item(java.lang.String name)
                      throws RemoteEclipseAPIException

This method gets a table according to an index or name.

Parameters:

name - Specifies the name of the table.

Returns:

A TextTable object that represents a table.

Throws:

RemoteEclipseAPIException