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

public interface IRemoteSpreadsheets

This class represents a collection of all the opened spreadsheets.

Access

To get all the opened spreadsheets, use the Spreadsheets property in the Application class.

Usage

Spreadsheets provides access to spreadsheets, and methods to create new spreadsheets, open existing spreadsheets, and save and close all opened spreadsheets.

A spreadsheet document can be created and opened in two ways: visible mode and not visible mode, see addSpreadsheet method and openSpreadsheet method.

Method Summary

IRemoteSpreadsheet	addSpreadsheet(java.lang.String template, boolean newTemplate, boolean visible) This method creates a new spreadsheet.
void	closeSpreadsheets(boolean saveChanges) This method closes all the spreadsheets opened in Lotus Symphony.
IRemoteSymphonyApplication	getApplication() This property represents the Lotus Symphony application.
int	getCount() This property represents the number of spreadsheet opened.
IRemoteSpreadsheet	item(int index) This method returns a spreadsheet opened in Lotus Symphony by an index.
IRemoteSpreadsheet	openSpreadsheet(java.lang.String fileName, boolean visible) This method opens a spreadsheet.
IRemoteSpreadsheet	openSpreadsheet(java.lang.String fileName, boolean visible, java.lang.String password) This method opens a spreadsheet.
void	saveSpreadsheets() This method saves all the spreadsheets opened in Lotus Symphony.

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 spreadsheet opened.

Returns:

count

Throws:

RemoteEclipseAPIException

addSpreadsheet

IRemoteSpreadsheet addSpreadsheet(java.lang.String template,
                                  boolean newTemplate,
                                  boolean visible)
                                  throws RemoteEclipseAPIException

This method creates a new spreadsheet. The values of Name, FullName, Path property of a new spreadsheet are empty string.

Parameters:

template - Specifies the name of template for the new spreadsheet. For example, on Microsoft® Windows®, the format is D:\\template.ots. On Linux®, the format is /home/me/template.ots. If the template file does not exists, this method throws an exception. If no template is used, the value of this property is empty string, for example, spreadsheets.addSpreadsheet("",false,true).

newTemplate - If a template is used, specifies true to creates a new untitled spreadsheet based on the template, false to load the template for editing. If no template is used, both true and false create a new untitled spreadsheet.

visible - Specifies true to open the new spreadsheet in a visible window or tab, or false to open the new spreadsheet in invisible mode.

Returns:

A Spreadsheet object that represents a spreadsheet.

Throws:

RemoteEclipseAPIException

closeSpreadsheets

void closeSpreadsheets(boolean saveChanges)
                       throws RemoteEclipseAPIException

This method closes all the spreadsheets opened in Lotus Symphony.

Usage

• If the parameter saveChanges is false, all the spreadsheets are closed without saving changes.
• If the parameter saveChanges is true and the spreadsheets are in visible mode:
  • If there are spreadsheets that are new, or new from a template, a Documents-Save window display to save the file.
  • If there are spreadsheets that are opened from a file, then the spreadsheets are saved before closing.
• If the parameter saveChanges is true and the spreadsheets are in invisible mode:
  • If there are spreadsheets that are new, or new from a template, this method throws an exception.
  • If there are spreadsheets that are opened from a file, then the spreadsheets are saved before closing.

Parameters:

saveChanges - Specifies true to save all the changed spreadsheets before closing.

Throws:

RemoteEclipseAPIException

item

IRemoteSpreadsheet item(int index)
                        throws RemoteEclipseAPIException

This method returns a spreadsheet opened in Lotus Symphony by an index.

Parameters:

index - Specifies the index of the spreadsheet to be returned, starting at 1.

Returns:

A Spreadsheet object that represents a spreadsheet.

Throws:

RemoteEclipseAPIException

openSpreadsheet

IRemoteSpreadsheet openSpreadsheet(java.lang.String fileName,
                                   boolean visible)
                                   throws RemoteEclipseAPIException

This method opens a spreadsheet.

Parameters:

fileName - Specifies the name of the spreadsheet to be opened. For example, on Microsoft® Windows®, the format is D:\\test.ods. On Linux®, the format is /home/me/test.ods. If the spreadsheet does not exist or is an unsupported file type, this method throws an exception.

visible - Specifies true to open the spreadsheet in a visible window or tab, or false to open the spreadsheet invisibly.

Returns:

A Spreadsheet object that represents the opened spreadsheet.

Throws:

RemoteEclipseAPIException

saveSpreadsheets

void saveSpreadsheets()
                      throws RemoteEclipseAPIException

This method saves all the spreadsheets opened in Lotus Symphony.

Throws:

RemoteEclipseAPIException

openSpreadsheet

IRemoteSpreadsheet openSpreadsheet(java.lang.String fileName,
                                   boolean visible,
                                   java.lang.String password)
                                   throws RemoteEclipseAPIException

This method opens a spreadsheet.

Parameters:

fileName - Specifies the name of the spreadsheet to be opened. For example, on Microsoft® Windows®, the format is D:\\test.ods. On Linux®, the format is /home/me/test.ods. If the spreadsheet does not exist or is an unsupported file type, this method throws an exception.

visible - Specifies true to open the spreadsheet in a visible window or tab, or false to open the spreadsheet invisibly.

password - Specifies the password of the spreadsheet. If the password is not correct, this method throws an exception.

Returns:

A Spreadsheet object that represents the opened spreadsheet.

Throws:

RemoteEclipseAPIException