com.mindoo.remote.api.symphony.spreadsheet
Interface IRemoteDataPilotTables

public interface IRemoteDataPilotTables

This class represents a collection of all the DataPilot tables on the specified sheet.

Access

To get all the DataPilot tables of a sheet, use the DataPilotTables property in the Sheet class.

Usage

DataPilotTables provides access to DataPilot tables, and a method to create a new DataPilot table.

Method Summary

IRemoteDataPilotTable	add(IRemoteRange source, java.lang.String name, IRemoteRange destination) This method creates a new DataPilot table.
IRemoteSymphonyApplication	getApplication() This property represents the Lotus Symphony application.
int	getCount() This property represents the number of the DataPilot tables.
IRemoteDataPilotTable	item(int index) This method returns a DataPilot table according to an index.

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 the DataPilot tables.

Returns:

count

Throws:

RemoteEclipseAPIException

add

IRemoteDataPilotTable add(IRemoteRange source,
                          java.lang.String name,
                          IRemoteRange destination)
                          throws RemoteEclipseAPIException

This method creates a new DataPilot table.

Usage
After calling the Add method, a DataPilot table is created, but there is no data in the table. Use the addFields method to fill data in the table:

• Add column fields for the table, each column field must be a column of the source range.
• Add row fields for the table, each row field must be a column of the source range.
• Add data fields for the table, each data field must be a column of the source range.
• Add page fields for the table, each page field must be a column of the source range.

Parameters:

source - Specifies the range that contains the data. If the range is in another sheet, this method throws an exception.

name - Specifies the name of the table.

destination - Specifies the position to display the table.

Returns:

A DataPilotTable object that represents a DataPilot table.

Throws:

RemoteEclipseAPIException

item

IRemoteDataPilotTable item(int index)
                           throws RemoteEclipseAPIException

This method returns a DataPilot table according to an index.

Parameters:

index - Specifies the index of the DataPilot table to get, starting at 1 .

Returns:

A DataPilotTable object represents a DataPilot table.

Throws:

RemoteEclipseAPIException