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

public interface IRemoteTextTableRows

This class is a collection of TextTableRow objects representing all the rows in a table.

Access

To get all the rows of a table, use the Rows property in the TextTable class.

Usage

TextTableRows provides access to rows, and provides methods to insert and remove rows.

Method Summary

IRemoteTextTableRow	add() This method inserts one or more rows.
IRemoteTextTableRow	add(int rowIndex) This method inserts one or more rows.
IRemoteTextTableRow	add(int rowIndex, int count) This method inserts one or more rows.
IRemoteSymphonyApplication	getApplication() This property represents the Lotus Symphony application.
int	getCount() This property returns the number of rows in a table.
int	getHeight() This property gets the height of the first row and sets the height to all rows, its unit is 1/100th mm.
boolean	isAutoHeight() This property gets the AutoHeight property of the first row and sets the AutoHeight property of all rows.
IRemoteTextTableRow	item(int index) This method gets a row of the table according to an index.
void	remove() This method removes one or more rows in a table.
void	remove(int beginIdx) This method removes one or more rows in a table.
void	remove(int beginIdx, int count) This method removes one or more rows in a table.
void	setAutoHeight(boolean autoHeight) This property gets the AutoHeight property of the first row and sets the AutoHeight property of all rows.
void	setHeight(int height) This property gets the height of the first row and sets the height to all rows, its unit is 1/100th mm.

Method Detail

getApplication

IRemoteSymphonyApplication getApplication()
                                          throws RemoteEclipseAPIException

This property represents the Lotus Symphony application.

Returns:

application

Throws:

RemoteEclipseAPIException

isAutoHeight

boolean isAutoHeight()
                     throws RemoteEclipseAPIException

This property gets the AutoHeight property of the first row and sets the AutoHeight property of all rows.

Returns:

auto height

Throws:

RemoteEclipseAPIException

setAutoHeight

void setAutoHeight(boolean autoHeight)
                   throws RemoteEclipseAPIException

This property gets the AutoHeight property of the first row and sets the AutoHeight property of all rows.

Parameters:

autoHeight -

Throws:

RemoteEclipseAPIException

getCount

int getCount()
             throws RemoteEclipseAPIException

This property returns the number of rows in a table. The maximum number of rows in a table is 3276.

Returns:

count

Throws:

RemoteEclipseAPIException

getHeight

int getHeight()
              throws RemoteEclipseAPIException

This property gets the height of the first row and sets the height to all rows, its unit is 1/100th mm. To set the height to all rows, set the AutoHeight property to false.

Returns:

height

Throws:

RemoteEclipseAPIException

setHeight

void setHeight(int height)
               throws RemoteEclipseAPIException

This property gets the height of the first row and sets the height to all rows, its unit is 1/100th mm. To set the height to all rows, set the AutoHeight property to false.

Parameters:

height -

Throws:

RemoteEclipseAPIException

add

IRemoteTextTableRow add(int rowIndex,
                        int count)
                        throws RemoteEclipseAPIException

This method inserts one or more rows. When inserting several rows, this method returns the last inserted row.
The add() method inserts a row after the last row.

Parameters:

rowIndex - Specifies the index of a row before which new rows are inserted. The range of the index is from 1 to row number +1. If the index is row number +1, this method insert several rows specified by the count parameter after the last row.

count - Specifies the number of rows to be added. The default value is 1. If the number of rows is out of bounds, this method throws an exception.

Returns:

A TextTableRow object that represents a row.

Throws:

RemoteEclipseAPIException

add

IRemoteTextTableRow add(int rowIndex)
                        throws RemoteEclipseAPIException

This method inserts one or more rows. When inserting several rows, this method returns the last inserted row.
The add() method inserts a row after the last row.

Parameters:

rowIndex - Specifies the index of a row before which new rows are inserted. The range of the index is from 1 to row number +1. If the index is row number +1, this method insert several rows specified by the count parameter after the last row.

Returns:

A TextTableRow object that represents a row.

Throws:

RemoteEclipseAPIException

add

IRemoteTextTableRow add()
                        throws RemoteEclipseAPIException

This method inserts one or more rows. When inserting several rows, this method returns the last inserted row.
The add() method inserts a row after the last row.

Returns:

A TextTableRow object that represents a row.

Throws:

RemoteEclipseAPIException

item

IRemoteTextTableRow item(int index)
                         throws RemoteEclipseAPIException

This method gets a row of the table according to an index.

Parameters:

index -

Returns:

A TextTableRow object that represents a row.

Throws:

RemoteEclipseAPIException

remove

void remove()
            throws RemoteEclipseAPIException

This method removes one or more rows in a table.
The remove() method removes the last row.

Throws:

RemoteEclipseAPIException

remove

void remove(int beginIdx)
            throws RemoteEclipseAPIException

This method removes one or more rows in a table.
The remove() method removes the last row.

Parameters:

beginIdx - Specifies the index of the first row to be removed, starting at 1.

Throws:

RemoteEclipseAPIException

remove

void remove(int beginIdx,
            int count)
            throws RemoteEclipseAPIException

This method removes one or more rows in a table.
The remove() method removes the last row.

Parameters:

beginIdx - Specifies the index of the first row to be removed, starting at 1.

count - Specifies the number of rows to be removed. The default value is 1. If the number of rows is out of bounds, this method throws an exception.

Throws:

RemoteEclipseAPIException