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

public interface IRemoteTextTableColumns

This class is a collection of TextTableColumn objects representing all the columns in a table.

Access

To get all the columns of a table, use the Columns property in the TextTable class.

Usage

TextTableColumns provides access to columns, and provides methods to insert and remove columns.

Method Summary

IRemoteTextTableColumn	add() This method inserts one or more columns in a table.
IRemoteTextTableColumn	add(int index) This method inserts one or more columns in a table.
IRemoteTextTableColumn	add(int index, int count) This method inserts one or more columns in a table.
IRemoteSymphonyApplication	getApplication() This property represents the Lotus Symphony application.
int	getCount() This property returns the number of columns of a table.
int	getWidth() This property gets the width of the first column and sets the width to all columns.
IRemoteTextTableColumn	item(int index) This method gets a column of the table according to an index.
void	remove() This method removes one or more columns in a table.
void	remove(int paramInt) This method removes one or more columns in a table.
void	remove(int beginIdx, int count) This method removes one or more columns in a table.
void	setWidth(int width) This property gets the width of the first column and sets the width to all columns.

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 columns of a table. The maximum number of columns in a table is 64.

Returns:

count

Throws:

RemoteEclipseAPIException

add

IRemoteTextTableColumn add()
                           throws RemoteEclipseAPIException

This method inserts one or more columns in a table. When inserting several columns, this method returns the last inserted column.
The add() method inserts a column after the last column.

Returns:

A TextTableColumn object that represents a column.

Throws:

RemoteEclipseAPIException

add

IRemoteTextTableColumn add(int index)
                           throws RemoteEclipseAPIException

This method inserts one or more columns in a table. When inserting several columns, this method returns the last inserted column.
The add() method inserts a column after the last column.

Parameters:

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

Returns:

A TextTableColumn object that represents a column.

Throws:

RemoteEclipseAPIException

add

IRemoteTextTableColumn add(int index,
                           int count)
                           throws RemoteEclipseAPIException

This method inserts one or more columns in a table. When inserting several columns, this method returns the last inserted column.
The add() method inserts a column after the last column.

Parameters:

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

count - Specifies the number of columns to be added. If the number of columns is out of bounds, this method throws an exception.

Returns:

A TextTableColumn object that represents a column.

Throws:

RemoteEclipseAPIException

item

IRemoteTextTableColumn item(int index)
                            throws RemoteEclipseAPIException

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

Parameters:

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

Returns:

A TextTableColumn object that represents a column.

Throws:

RemoteEclipseAPIException

remove

void remove()
            throws RemoteEclipseAPIException

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

Throws:

RemoteEclipseAPIException

remove

void remove(int paramInt)
            throws RemoteEclipseAPIException

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

Parameters:

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

Throws:

RemoteEclipseAPIException

remove

void remove(int beginIdx,
            int count)
            throws RemoteEclipseAPIException

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

Parameters:

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

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

Throws:

RemoteEclipseAPIException

getWidth

int getWidth()
             throws RemoteEclipseAPIException

This property gets the width of the first column and sets the width to all columns.

Returns:

width

Throws:

RemoteEclipseAPIException

setWidth

void setWidth(int width)
              throws RemoteEclipseAPIException

This property gets the width of the first column and sets the width to all columns.

Parameters:

width -

Throws:

RemoteEclipseAPIException