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

All Superinterfaces:

IRemoteSymphonyDocument

public interface IRemoteSpreadsheet
extends IRemoteSymphonyDocument

This class represents a Lotus Symphony spreadsheet.

Creation and access

• To create a new spreadsheet, use the AddSpreadsheet method in the Spreadsheets class.
• To open a spreadsheet, use the OpenSpreadsheet method in the Spreadsheets class.
• To get an opened spreadsheet, use the Item method in the Spreadsheets class.
• To get the active spreadsheet, use the ActiveSpreadsheet property in the Application class.

Usage

Spreadsheet provides access to sheets, and provides ways to save and export the spreadsheet to other formats.

Method Summary

void	closeSpreadsheet(boolean saveChanges) This method closes the spreadsheet.
IRemoteSheet	getActiveSheet() This property returns or sets the current active sheet in the spreadsheet.
IRemoteNames	getNames() This property returns all the named ranges of a spreadsheet.
IRemoteSheets	getSheets() This property returns all the sheets in the spreadsheet.
IRemoteTableStyles	getTableStyles() This property returns all the table styles of a spreadsheet.
void	saveAsSpreadsheet(java.lang.String fileName, java.lang.String fileFormat) This method saves the spreadsheet with a new name or format.
void	saveAsSpreadsheet(java.lang.String fileName, java.lang.String fileFormat, java.lang.String password) This method saves the spreadsheet with a new name or format.
void	saveSpreadsheet() This method saves the spreadsheet.
void	setActiveSheet(IRemoteSheet sheet) This property returns or sets the current active sheet in the spreadsheet.
void	syncDocument(boolean isEnable) This method enables or disables the synchronization of the user interface with the data of the spreadsheet.

Methods inherited from interface com.mindoo.remote.api.symphony.IRemoteSymphonyDocument

close, export, export, export, exportPDF, getApplication, getFullName, getName, getPath, getSaveFormat, getStyleFamilies, getType, getUniqueID, isSaved, isVisible, print, print, print, print, save, saveAs, saveAs, saveAs, setEditAreaVisible

Method Detail

getTableStyles

IRemoteTableStyles getTableStyles()
                                  throws RemoteEclipseAPIException

This property returns all the table styles of a spreadsheet.

Returns:

styles

Throws:

RemoteEclipseAPIException

getNames

IRemoteNames getNames()
                      throws RemoteEclipseAPIException

This property returns all the named ranges of a spreadsheet.

Returns:

names

Throws:

RemoteEclipseAPIException

getSheets

IRemoteSheets getSheets()
                        throws RemoteEclipseAPIException

This property returns all the sheets in the spreadsheet.

Returns:

sheets

Throws:

RemoteEclipseAPIException

getActiveSheet

IRemoteSheet getActiveSheet()
                            throws RemoteEclipseAPIException

This property returns or sets the current active sheet in the spreadsheet.

Returns:

sheet

Throws:

RemoteEclipseAPIException

setActiveSheet

void setActiveSheet(IRemoteSheet sheet)
                    throws RemoteEclipseAPIException

This property returns or sets the current active sheet in the spreadsheet.

Parameters:

sheet -

Throws:

RemoteEclipseAPIException

closeSpreadsheet

void closeSpreadsheet(boolean saveChanges)
                      throws RemoteEclipseAPIException

This method closes the spreadsheet.

Usage

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

Parameters:

saveChanges - Specifies whether to save changes before closing the spreadsheet. A value of true saves changes. A value of false does not save changes.

Throws:

RemoteEclipseAPIException

saveSpreadsheet

void saveSpreadsheet()
                     throws RemoteEclipseAPIException

This method saves the spreadsheet. Before calling the saveSpreadsheet method for a new spreadsheet, you must call the saveAsSpreadsheet method first to define the file path and name.

Throws:

RemoteEclipseAPIException

saveAsSpreadsheet

void saveAsSpreadsheet(java.lang.String fileName,
                       java.lang.String fileFormat)
                       throws RemoteEclipseAPIException

This method saves the spreadsheet with a new name or format.

Usage

If the file path does not exist, this method throws an exception.
If the file format is not supported, this method throws an exception.
If the file already exists, this method overwrite the existing file.

Parameters:

fileName - Specifies the new name of the spreadsheet to be saved and must be the full file name containing the file path. For example, on Microsoft® Windows® , the format is D:\\test.ods. On Linux®, the format is /home/me/test.ods.

fileFormat - Specifies the format of the spreadsheet to be saved. The following file formats are supported:

• .ods file: Constant.SYMPHONY_FILE_FORMAT_ODS
• .ots file: Constant.SYMPHONY_FILE_FORMAT_OTS
• .xls file: Constant.SYMPHONY_FILE_FORMAT_XLS
• .csv file: Constant.SYMPHONY_FILE_FORMAT_CSV

Throws:

RemoteEclipseAPIException

saveAsSpreadsheet

void saveAsSpreadsheet(java.lang.String fileName,
                       java.lang.String fileFormat,
                       java.lang.String password)
                       throws RemoteEclipseAPIException

This method saves the spreadsheet with a new name or format.

Usage

If the file path does not exist, this method throws an exception.
If the file format is not supported, this method throws an exception.
If the file already exists, this method overwrite the existing file.

Parameters:

fileName - Specifies the new name of the spreadsheet to be saved and must be the full file name containing the file path. For example, on Microsoft® Windows® , the format is D:\\test.ods. On Linux®, the format is /home/me/test.ods.

fileFormat - Specifies the format of the spreadsheet to be saved. The following file formats are supported:

• .ods file: Constant.SYMPHONY_FILE_FORMAT_ODS
• .ots file: Constant.SYMPHONY_FILE_FORMAT_OTS
• .xls file: Constant.SYMPHONY_FILE_FORMAT_XLS
• .csv file: Constant.SYMPHONY_FILE_FORMAT_CSV

password - Specifies the password of the apreadsheet.

Throws:

RemoteEclipseAPIException

syncDocument

void syncDocument(boolean isEnable)
                  throws RemoteEclipseAPIException

This method enables or disables the synchronization of the user interface with the data of the spreadsheet. This method is used to improve the performance when operating mass data.

Usage

This method must be called in pairs. When SyncDocument is disabled, only cells that have a value changed are updated in user interface. All of the formulas or charts depending on this cell do not get refreshed until SyncDocument is enabled.

Parameters:

isEnable - Specifies true to enable the synchronization of the user interface with the data, and specifies false to disable the synchronization of the user interface with the data.

Throws:

RemoteEclipseAPIException