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

public interface IRemoteChartObjects

This class represents a collection of all the chart objects of a sheet.

Access

To get all the chart objects of a sheet, use the ChartObjects property in the Sheet class.

Usage

ChartObjects provides access to chart objects, and methods to create chart objects and remove all the chart objects of a sheet.

Method Summary

IRemoteChartObject	add(java.lang.String name, int left, int top, int width, int height) This method creates a new chart object.
IRemoteChartObject	add(java.lang.String name, int left, int top, int width, int height, boolean rowHeader, boolean columnHeader) This method creates a new chart object.
IRemoteSymphonyApplication	getApplication() This property represents the Lotus Symphony application.
int	getCount() This property represents the number of chart objects of a sheet.
IRemoteChartObject	item(int index) This method gets a chart object of a sheet according to an index.
void	remove() This method deletes all chart objects.

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 chart objects of a sheet.

Returns:

count

Throws:

RemoteEclipseAPIException

add

IRemoteChartObject add(java.lang.String name,
                       int left,
                       int top,
                       int width,
                       int height,
                       boolean rowHeader,
                       boolean columnHeader)
                       throws RemoteEclipseAPIException

This method creates a new chart object.

Usage

If the value of the parameter left, top,width or height is negative, this method throws an exception.

Parameters:

name - Specifies the name of the chart object. If a chart object with the same name already exists, an index suffix is added after the new chart object's name. For example, if the chart object with name "report" already exists, the new chart object's name is "report1".

left - Specifies the X coordinate of the new chart in 1/100th mm, relative to the left side of a sheet.

top - Specifies the Y coordinate of the new chart in 1/100th mm, relative to the top side of a sheet.

width - Specifies the width of the new chart in 1/100th mm.

height - Specifies the height of the new chart in 1/100th mm .

rowHeader - true means that the new chart has row header, false means that there is no row header for this chart. The default value is false.

columnHeader - true means that the new chart has column header, false means that there is no column header for this chart. The default value is false.

Returns:

A ChartObject object that represents a chart.

Throws:

RemoteEclipseAPIException

add

IRemoteChartObject add(java.lang.String name,
                       int left,
                       int top,
                       int width,
                       int height)
                       throws RemoteEclipseAPIException

This method creates a new chart object.

Usage

If the value of the parameter left, top,width or height is negative, this method throws an exception.

Parameters:

name - Specifies the name of the chart object. If a chart object with the same name already exists, an index suffix is added after the new chart object's name. For example, if the chart object with name "report" already exists, the new chart object's name is "report1".

left - Specifies the X coordinate of the new chart in 1/100th mm, relative to the left side of a sheet.

top - Specifies the Y coordinate of the new chart in 1/100th mm, relative to the top side of a sheet.

width - Specifies the width of the new chart in 1/100th mm.

height - Specifies the height of the new chart in 1/100th mm .

Returns:

A ChartObject object that represents a chart.

Throws:

RemoteEclipseAPIException

item

IRemoteChartObject item(int index)
                        throws RemoteEclipseAPIException

This method gets a chart object of a sheet according to an index.

Parameters:

index - Specifies the index of the chart object in the collection, starting at 1.

Returns:

A ChartObject object that represents a chart object.

Throws:

RemoteEclipseAPIException

remove

void remove()
            throws RemoteEclipseAPIException

This method deletes all chart objects.

Throws:

RemoteEclipseAPIException