com.mindoo.remote.api.symphony
Interface IRemoteSymphonyDocument

All Known Subinterfaces:

IRemoteDocument, IRemotePresentation, IRemoteSpreadsheet

public interface IRemoteSymphonyDocument

This class represents a Lotus Symphony document.

Method Summary

void	close(boolean isSave) This method closes the document.
void	export(java.lang.String fileName) This method exports a document to another name or format.
void	export(java.lang.String fileName, java.lang.String fileFormat) This method exports a document to another name or format.
void	export(java.lang.String fileName, java.lang.String fileFormat, java.lang.String password) This method exports a document to another name or format.
void	exportPDF(java.lang.String fileName) This method exports the document as a PDF file.
IRemoteSymphonyApplication	getApplication() This property represents the Lotus Symphony application.
java.lang.String	getFullName() This property returns the name of the document, including it's path and name.
java.lang.String	getName() This property returns the name of the document.
java.lang.String	getPath() This property returns the path of the document.
java.lang.String	getSaveFormat() This property returns the file format of the document.
IRemoteStyleFamilies	getStyleFamilies() This property returns all the style family of a document.
int	getType() This property returns the file type.
java.lang.String	getUniqueID() This property returns an unique ID to identify an opened document.
boolean	isSaved() This property returns true if the document has not changed since it was last saved, otherwise it returns false.
boolean	isVisible() This property returns true when the specified document is visible in the user interface.
void	print() This method prints the document.
void	print(int copies) This method prints the document.
void	print(int copies, java.lang.String pages) This method prints the document.
void	print(int copies, java.lang.String pages, boolean collate) This method prints the document.
void	save() This method saves the document.
void	saveAs(java.lang.String fileName) This method saves the document with a new name or format.
void	saveAs(java.lang.String fileName, java.lang.String fileFormat) This method saves the document with a new name or format.
void	saveAs(java.lang.String fileName, java.lang.String fileFormat, java.lang.String password) This method saves the document with a new name or format.
void	setEditAreaVisible(boolean visible) No documentation in Symphony SDK

Method Detail

getApplication

IRemoteSymphonyApplication getApplication()
                                          throws RemoteEclipseAPIException

This property represents the Lotus Symphony application.

Returns:

application

Throws:

RemoteEclipseAPIException

isVisible

boolean isVisible()
                  throws RemoteEclipseAPIException

This property returns true when the specified document is visible in the user interface.

Returns:

visible

Throws:

RemoteEclipseAPIException

getName

java.lang.String getName()
                         throws RemoteEclipseAPIException

This property returns the name of the document.

Returns:

name

Throws:

RemoteEclipseAPIException

getFullName

java.lang.String getFullName()
                             throws RemoteEclipseAPIException

This property returns the name of the document, including it's path and name. For example, on Microsoft® Windows® , the format is D:\\test.odt. On Linux®, the format is /home/me/test.odt.

Returns:

fullname

Throws:

RemoteEclipseAPIException

getPath

java.lang.String getPath()
                         throws RemoteEclipseAPIException

This property returns the path of the document. For example, on Microsoft® Windows® , the format is D:\\FileType. On Linux®, the format is /home/me.

Returns:

path

Throws:

RemoteEclipseAPIException

isSaved

boolean isSaved()
                throws RemoteEclipseAPIException

This property returns true if the document has not changed since it was last saved, otherwise it returns false. When creating a new document, the Saved property's value is true.

Returns:

saved

Throws:

RemoteEclipseAPIException

getSaveFormat

java.lang.String getSaveFormat()
                               throws RemoteEclipseAPIException

This property returns the file format of the document.

Returns:

For Lotus Symphony Document, the following file formats are supported:

• .odt file: Constant.SYMPHONY_FILE_FORMAT_ODT
• .ott file: Constant.SYMPHONY_FILE_FORMAT_OTT
• .doc file: Constant.SYMPHONY_FILE_FORMAT_DOC
• .rtf file: Constant.SYMPHONY_FILE_FORMAT_RTF
• .txt file: Constant.SYMPHONY_FILE_FORMAT_TXT

For Lotus Symphony Presentation, the following file formats are supported:

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

For Lotus Symphony Spreadsheet, 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

getStyleFamilies

IRemoteStyleFamilies getStyleFamilies()
                                      throws RemoteEclipseAPIException

This property returns all the style family of a document.

Returns:

families

Throws:

RemoteEclipseAPIException

getType

int getType()
            throws RemoteEclipseAPIException

This property returns the file type.

Returns:

type

Throws:

RemoteEclipseAPIException

print

void print()
           throws RemoteEclipseAPIException

This method prints the document.

Throws:

RemoteEclipseAPIException

print

void print(int copies)
           throws RemoteEclipseAPIException

This method prints the document.

Parameters:

copies - Specifies the count of copies to print. The default value is 1.

Throws:

RemoteEclipseAPIException

print

void print(int copies,
           java.lang.String pages)
           throws RemoteEclipseAPIException

This method prints the document.

Parameters:

copies - Specifies the count of copies to print. The default value is 1.

pages - Specifies the range of pages to print. For example, the range 1-5, 7 prints pages 1 to 5, and page 7. The default value is all pages.

Throws:

RemoteEclipseAPIException

print

void print(int copies,
           java.lang.String pages,
           boolean collate)
           throws RemoteEclipseAPIException

This method prints the document.

Parameters:

copies - Specifies the count of copies to print. The default value is 1.

pages - Specifies the range of pages to print. For example, the range 1-5, 7 prints pages 1 to 5, and page 7. The default value is all pages.

collate - Specifies true to print all the pages before printing another copy when more than one copy to print, or false to print each page copies together. The default value is true.

Throws:

RemoteEclipseAPIException

save

void save()
          throws RemoteEclipseAPIException

This method saves the document. Before calling the save method for a new document, you must call the saveAs method first to define the file path and name.

Throws:

RemoteEclipseAPIException

saveAs

void saveAs(java.lang.String fileName)
            throws RemoteEclipseAPIException

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

Usage

If the file path does not exist, this method throws an exception.

If unsupported file format is used, this method throws an exception.

If the file already exists, this method overwrite the existing file.

Parameters:

fileName - Specifies the new name of the document to be saved and must contain the file path. For example, on Microsoft® Windows® , the format is D:\\test.odt . On Linux®, the format is /home/me/test.odt.This method save the new document to the position indicated by fileName, then it become the current document in editor.If the document is opened, it will be save as it's default format. If the document is new, the SW,SD,SC type document will be saved as .odt,.odp,.ods type document.

Throws:

RemoteEclipseAPIException

saveAs

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

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

Usage

If the file path does not exist, this method throws an exception.

If unsupported file format is used, this method throws an exception.

If the file already exists, this method overwrite the existing file.

Parameters:

fileName - Specifies the new name of the document to be saved and must contain the file path. For example, on Microsoft® Windows® , the format is D:\\test.odt . On Linux®, the format is /home/me/test.odt.This method save the new document to the position indicated by fileName, then it become the current document in editor.If the document is opened, it will be save as it's default format. If the document is new, the SW,SD,SC type document will be saved as .odt,.odp,.ods type document.

fileFormat - Specifies the format of the document to be saved.

For Lotus Symphony Document, the following file formats are supported:

• .odt file: Constant.SYMPHONY_FILE_FORMAT_ODT
• .ott file: Constant.SYMPHONY_FILE_FORMAT_OTT
• .doc file: Constant.SYMPHONY_FILE_FORMAT_DOC
• .rtf file: Constant.SYMPHONY_FILE_FORMAT_RTF
• .txt file: Constant.SYMPHONY_FILE_FORMAT_TXT

For Lotus Symphony Presentation, the following file formats are supported:

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

For Lotus Symphony Spreadsheet, 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

saveAs

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

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

Usage

If the file path does not exist, this method throws an exception.

If unsupported file format is used, this method throws an exception.

If the file already exists, this method overwrite the existing file.

Parameters:

fileName - Specifies the new name of the document to be saved and must contain the file path. For example, on Microsoft® Windows® , the format is D:\\test.odt . On Linux®, the format is /home/me/test.odt.This method save the new document to the position indicated by fileName, then it become the current document in editor.If the document is opened, it will be save as it's default format. If the document is new, the SW,SD,SC type document will be saved as .odt,.odp,.ods type document.

fileFormat - Specifies the format of the document to be saved.

For Lotus Symphony Document, the following file formats are supported:

• .odt file: Constant.SYMPHONY_FILE_FORMAT_ODT
• .ott file: Constant.SYMPHONY_FILE_FORMAT_OTT
• .doc file: Constant.SYMPHONY_FILE_FORMAT_DOC
• .rtf file: Constant.SYMPHONY_FILE_FORMAT_RTF
• .txt file: Constant.SYMPHONY_FILE_FORMAT_TXT

For Lotus Symphony Presentation, the following file formats are supported:

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

For Lotus Symphony Spreadsheet, 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 document.

Throws:

RemoteEclipseAPIException

close

void close(boolean isSave)
           throws RemoteEclipseAPIException

This method closes the document.

Usage

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

Parameters:

isSave - Specifies true to save changes before closing document.

Throws:

RemoteEclipseAPIException

exportPDF

void exportPDF(java.lang.String fileName)
               throws RemoteEclipseAPIException

This method exports the document as a PDF file.

Usage

If the file path does not exist, this method throws an exception.

If the file already exists, this method overwrite the existing file.

Parameters:

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

Throws:

RemoteEclipseAPIException

setEditAreaVisible

void setEditAreaVisible(boolean visible)
                        throws RemoteEclipseAPIException

No documentation in Symphony SDK

Parameters:

visible -

Throws:

RemoteEclipseAPIException

getUniqueID

java.lang.String getUniqueID()
                             throws RemoteEclipseAPIException

This property returns an unique ID to identify an opened document.

Returns:

id

Throws:

RemoteEclipseAPIException

export

void export(java.lang.String fileName)
            throws RemoteEclipseAPIException

This method exports a document to another name or format.

Parameters:

fileName - Specifies the name of the document to export and must contain the file path. For example, on Microsoft® Windows®, the format is D:\\test.odt. On Linux®, the format is /home/me/test.odt.

Throws:

RemoteEclipseAPIException

export

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

This method exports a document to another name or format.

Parameters:

fileName - Specifies the name of the document to export and must contain the file path. For example, on Microsoft® Windows®, the format is D:\\test.odt. On Linux®, the format is /home/me/test.odt.

fileFormat - Specifies the format of the document to export.

For Lotus Symphony Document, the following file formats are supported:

• .odt file: Constant.SYMPHONY_FILE_FORMAT_ODT
• .ott file: Constant.SYMPHONY_FILE_FORMAT_OTT
• .doc file: Constant.SYMPHONY_FILE_FORMAT_DOC
• .rtf file: Constant.SYMPHONY_FILE_FORMAT_RTF
• .txt file: Constant.SYMPHONY_FILE_FORMAT_TXT

For Lotus Symphony Presentation, the following file formats are supported:

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

For Lotus Symphony Spreadsheet, 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

export

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

This method exports a document to another name or format.

Parameters:

fileName - Specifies the name of the document to export and must contain the file path. For example, on Microsoft® Windows®, the format is D:\\test.odt. On Linux®, the format is /home/me/test.odt.

fileFormat - Specifies the format of the document to export.

For Lotus Symphony Document, the following file formats are supported:

• .odt file: Constant.SYMPHONY_FILE_FORMAT_ODT
• .ott file: Constant.SYMPHONY_FILE_FORMAT_OTT
• .doc file: Constant.SYMPHONY_FILE_FORMAT_DOC
• .rtf file: Constant.SYMPHONY_FILE_FORMAT_RTF
• .txt file: Constant.SYMPHONY_FILE_FORMAT_TXT

For Lotus Symphony Presentation, the following file formats are supported:

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

For Lotus Symphony Spreadsheet, 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 document to export.

Throws:

RemoteEclipseAPIException