com.mindoo.remote.api.symphony.presentation
Interface IRemotePresentation

All Superinterfaces:

IRemoteSymphonyDocument

public interface IRemotePresentation
extends IRemoteSymphonyDocument

This class represents a Lotus® Symphony™ presentation file.

Creation and access

• To create a new presentation, use the AddPresentation method in the Presentations class.
• To open a presentation, use the OpenPresentation method in the Presentations class.
• To get an opened presentation, use the Item method in the Presentations class.
• To get the active presentation in Lotus Symphony, use the ActivePresentation property in the Application class.

Usage

Presentation provides methods to save, close, print, and export presentations to other formats. It also provides properties to access the pages of a presentation.

Method Summary

void	closePresentation(boolean saveChanges) This method closes the presentation.
IRemotePage	getActivePage() This property returns the active page of the presentation.
IRemotePages	getMasterPages() This property returns all the master pages of the presentation.
IRemotePages	getPages() This property returns all the pages of the presentation.
void	playScreen() This method plays the screen show for the presentation.
void	playScreen(int pageNum) This method plays the screen show for the presentation.
void	saveAsPresentation(java.lang.String fileName, java.lang.String fileFormat) This method saves the presentation with a new name or format.
void	saveAsPresentation(java.lang.String fileName, java.lang.String fileFormat, java.lang.String password) This method saves the presentation with a new name or format.
void	savePresentation() This method saves the current presentation.

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

closePresentation

void closePresentation(boolean saveChanges)
                       throws RemoteEclipseAPIException

This method closes the presentation.

Usage

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

Parameters:

saveChanges - Specifies whether to save changes before closing a presentation. A value of true saves the changes.

Throws:

RemoteEclipseAPIException

savePresentation

void savePresentation()
                      throws RemoteEclipseAPIException

This method saves the current presentation. Before calling the savePresentation method for a new presentation, you must call the saveAsPresentation method first to define the file path and name.

Throws:

RemoteEclipseAPIException

saveAsPresentation

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

This method saves the presentation 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 presentation to be saved and must contain the file path. For example, on Microsoft® Windows® , the format is D:\\test.odp. On Linux®, the format is /home/me/test.odp.

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

• .odp file: Constant.SYMPHONY_FILE_FORMAT_ODP
• .otp file: Constant.SYMPHONY_FILE_FORMAT_OTP
• .ppt file: Constant.SYMPHONY_FILE_FORMAT_PPT
Throws:
RemoteEclipseAPIException

saveAsPresentation

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

This method saves the presentation 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 presentation to be saved and must contain the file path. For example, on Microsoft® Windows® , the format is D:\\test.odp. On Linux®, the format is /home/me/test.odp.

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

• .odp file: Constant.SYMPHONY_FILE_FORMAT_ODP
• .otp file: Constant.SYMPHONY_FILE_FORMAT_OTP
• .ppt file: Constant.SYMPHONY_FILE_FORMAT_PPT
password - Specifies the password of the presentation.
Throws:
RemoteEclipseAPIException

getPages

IRemotePages getPages()
                      throws RemoteEclipseAPIException

This property returns all the pages of the presentation.

Returns:

pages

Throws:

RemoteEclipseAPIException

getMasterPages

IRemotePages getMasterPages()
                            throws RemoteEclipseAPIException

This property returns all the master pages of the presentation.

Returns:

pages

Throws:

RemoteEclipseAPIException

getActivePage

IRemotePage getActivePage()
                          throws RemoteEclipseAPIException

This property returns the active page of the presentation.

Returns:

page

Throws:

RemoteEclipseAPIException

playScreen

void playScreen()
                throws RemoteEclipseAPIException

This method plays the screen show for the presentation.

Throws:

RemoteEclipseAPIException

playScreen

void playScreen(int pageNum)
                throws RemoteEclipseAPIException

This method plays the screen show for the presentation.

Parameters:

pageNum - Specifies the page number to start to play the screen show. The default value is 1. The range of the value is from 1 to the number of pages of the presentation. If the value of this parameter is out of bounds, this method throws an exception.

Throws:

RemoteEclipseAPIException