com.mindoo.remote.api.symphony.document
Interface IRemoteDocument

All Superinterfaces:

IRemoteSymphonyDocument

public interface IRemoteDocument
extends IRemoteSymphonyDocument

This class represents a Lotus Symphony document.

Document provides access to paragraphs, table, page styles and sections, and provides methods to save, print, close, and export documents to other formats.

Creation and access

• To create a new document, use the AddDocument method in the Documents class.
• To open a document, use the OpenDocument method in the Documents class.
• To get an opened document, use the Item method in the Documents class.
• To get the active document in Lotus Symphony, use the ActiveDocument property in the Application class.

Method Summary

void	closeDocument(boolean saveChanges) This method closes the document.
IRemoteBookmarks	getBookmarks() This property returns all the bookmarks of a document.
IRemoteTextRange	getContent() This property returns a TextRange object that represents the whole text range of the document.
IRemoteFields	getFields() This property returns a Fields object that represents all the fields in a document.
IRemotePageStyles	getPageStyles() This property returns page styles of this document.
IRemoteTextParagraphs	getParagraphs() This property returns a TextParagraphs object that represents all the paragraphs of a document.
IRemoteTextSections	getSections() This property returns a TextSections object that represents all the sections of a document.
IRemoteSelection	getSelection() This property returns the selection object of the document.
IRemoteTextTables	getTables() This property returns a TextTables object that represents all the tables of a document.
IRemoteTextGraphics	getTextGraphics() This property returns a TextGraphics object that represents all the graphic objects of a document.
int	getWordCount() This property returns the number of words in the document.
void	replaceAll(java.lang.String what, java.lang.String replacement, boolean matchcase) This method replaces all the specified text in a document with other text.
void	saveAsDocument(java.lang.String fileName, java.lang.String fileFormat) This method saves the document with a new name or format.
void	saveAsDocument(java.lang.String fileName, java.lang.String fileFormat, java.lang.String password) This method saves the document with a new name or format.
void	saveDocument() This method saves the document.

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

getContent

IRemoteTextRange getContent()
                            throws RemoteEclipseAPIException

This property returns a TextRange object that represents the whole text range of the document.

Returns:

content

Throws:

RemoteEclipseAPIException

getParagraphs

IRemoteTextParagraphs getParagraphs()
                                    throws RemoteEclipseAPIException

This property returns a TextParagraphs object that represents all the paragraphs of a document.

Returns:

paragraphs

Throws:

RemoteEclipseAPIException

getPageStyles

IRemotePageStyles getPageStyles()
                                throws RemoteEclipseAPIException

This property returns page styles of this document.

Returns:

styles

Throws:

RemoteEclipseAPIException

getSections

IRemoteTextSections getSections()
                                throws RemoteEclipseAPIException

This property returns a TextSections object that represents all the sections of a document.

Returns:

sections

Throws:

RemoteEclipseAPIException

getTables

IRemoteTextTables getTables()
                            throws RemoteEclipseAPIException

This property returns a TextTables object that represents all the tables of a document.

Returns:

tables

Throws:

RemoteEclipseAPIException

getWordCount

int getWordCount()
                 throws RemoteEclipseAPIException

This property returns the number of words in the document.

Returns:

word count

Throws:

RemoteEclipseAPIException

getSelection

IRemoteSelection getSelection()
                              throws RemoteEclipseAPIException

This property returns the selection object of the document.

Returns:

selection

Throws:

RemoteEclipseAPIException

getBookmarks

IRemoteBookmarks getBookmarks()
                              throws RemoteEclipseAPIException

This property returns all the bookmarks of a document.

Returns:

bookmarks

Throws:

RemoteEclipseAPIException

getTextGraphics

IRemoteTextGraphics getTextGraphics()
                                    throws RemoteEclipseAPIException

This property returns a TextGraphics object that represents all the graphic objects of a document.

Returns:

graphics

Throws:

RemoteEclipseAPIException

closeDocument

void closeDocument(boolean saveChanges)
                   throws RemoteEclipseAPIException

This method closes the document.

• If the parameter saveChanges is false, the document is closed without saving changes.
• If the parameter saveChanges 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 saveChanges 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:

saveChanges - Specifies true to save changes before closing document.

Throws:

RemoteEclipseAPIException

saveDocument

void saveDocument()
                  throws RemoteEclipseAPIException

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

Throws:

RemoteEclipseAPIException

saveAsDocument

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

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

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

fileFormat - Specifies the format of the document to be saved. 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

Throws:

RemoteEclipseAPIException

replaceAll

void replaceAll(java.lang.String what,
                java.lang.String replacement,
                boolean matchcase)
                throws RemoteEclipseAPIException

This method replaces all the specified text in a document with other text.

Parameters:

what - Specifies the text in the document to be replaced.

replacement - Specifies the text that replaces the text specified by the what parameter.

matchcase - Specifies whether to match case. A value of true matches case, and a value of false does not match case.

Throws:

RemoteEclipseAPIException

getFields

IRemoteFields getFields()
                        throws RemoteEclipseAPIException

This property returns a Fields object that represents all the fields in a document.

Returns:

fields

Throws:

RemoteEclipseAPIException

saveAsDocument

void saveAsDocument(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.

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

fileFormat - Specifies the format of the document to be saved. 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

password - Specifies the password of the document.

Throws:

RemoteEclipseAPIException