com.mindoo.remote.api.symphony.presentation
Interface IRemotePresentationTableRows

public interface IRemotePresentationTableRows

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

Access

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

Usage

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

Method Summary

IRemotePresentationTableRow	add() This method inserts one or more rows.
IRemotePresentationTableRow	add(int rowIndex) This method inserts one or more rows.
IRemotePresentationTableRow	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 of all rows in a table.
IRemotePresentationTableRow	item(int index) This method gets a row in a 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	setHeight(int height) This property gets the height of the first row and sets the height of all rows in a table.

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 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 of all rows in a table.

Returns:

height

Throws:

RemoteEclipseAPIException

setHeight

void setHeight(int height)
               throws RemoteEclipseAPIException

This property gets the height of the first row and sets the height of all rows in a table.

Parameters:

height -

Throws:

RemoteEclipseAPIException

add

IRemotePresentationTableRow 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 inserts 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 PresentationTableRow object that represents a row.

Throws:

RemoteEclipseAPIException

add

IRemotePresentationTableRow 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 inserts several rows specified by the count parameter after the last row.

Returns:

A PresentationTableRow object that represents a row.

Throws:

RemoteEclipseAPIException

add

IRemotePresentationTableRow 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 PresentationTableRow object that represents a row.

Throws:

RemoteEclipseAPIException

item

IRemotePresentationTableRow item(int index)
                                 throws RemoteEclipseAPIException

This method gets a row in a table according to an index.

Parameters:

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

Returns:

A PresentationTableRow 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