com.mindoo.remote.api.com.ibm.notes.java.ui.documents
Interface IRemoteNotesUIDocument

All Superinterfaces:

IRemoteAdaptable, IRemoteEclipseWrapper, IRemoteNotesUIElement

public interface IRemoteNotesUIDocument
extends IRemoteNotesUIElement

Remote API Wrapper for the com.ibm.notes.java.ui.documents.NotesUIDocument (Online documentation)

Original documentation:
Represents the document that's currently open in the Notes workspace.

Method Summary

void	clearSelectedText() Deletes the current selection from a document.
void	copy() Copies the current selection in a document to the Clipboard.
void	cut() Cuts the current selection from a document and places it on the Clipboard.
void	deselectAll() Deselects any selections in a document.
IRemoteNotesBEDocument	getBEDocument() Return the back-end document that corresponds to the currently open document.
IRemoteNotesUIField	getCurrentField() Return the field that the cursor is in.
IRemoteNotesDocumentData	getDocumentData() Gets the document data for this document.
IRemoteNotesUIField	getField(java.lang.String name) Get the field from the document.
IRemoteNotesUIField[]	getFields() Return all of the fields within the document.
java.lang.String	getForm() Get the name of the document's form.
java.lang.String	getSelectedText() Gets the text that is highlighted in the UI.
void	gotoNextField() Places the cursor in the next field on a document.
void	gotoPreviousField() Places the cursor in the previous field on a document.
void	insertHtml(java.lang.String html) Inserts HMTL at the cursor.
void	insertText(java.lang.String text) Inserts text at the cursor.
boolean	isEditable() Indicates whether the document can be placed in edit mode.
boolean	isEditMode() Indicates whether a document is in edit mode.
boolean	isInPreviewPane() Indicates whether the document is being accessed from the preview pane.
boolean	isNewDoc() Indicates whether a document is new.
void	paste() Pastes the contents of the Clipboard at the current cursor position on a document.
void	print() Sends the document to the printer.
void	refresh() Refreshes a document.
void	refreshHideFormulas() Recalculates the hide-when formulas on the current document's form.
void	reload() Refreshes the current document with any changes that have been made to the corresponding back-end document.
void	save() Saves the document.
void	selectAll() If the document is in edit mode, selects the entire contents of the current field.
void	setEditMode(boolean edit) Set whether or not the document should be in edit mode.

Methods inherited from interface com.mindoo.remote.api.com.ibm.notes.java.ui.IRemoteNotesUIElement

activate, close, getTitle, getUrl, getWindow

Methods inherited from interface com.mindoo.remote.api.IRemoteEclipseWrapper

_internalGetId, equalWrappedObjects

Method Detail

getBEDocument

IRemoteNotesBEDocument getBEDocument()
                                     throws RemoteEclipseAPIException

Return the back-end document that corresponds to the currently open document.

Returns:

the back-end document

Throws:

RemoteEclipseAPIException

getCurrentField

IRemoteNotesUIField getCurrentField()
                                    throws RemoteEclipseAPIException

Return the field that the cursor is in. This property is valid only when the document is in Edit mode. If the document is in Read mode, this method returns null.

Returns:

the field that the cursor is in

Throws:

RemoteEclipseAPIException

getFields

IRemoteNotesUIField[] getFields()
                                throws RemoteEclipseAPIException

Return all of the fields within the document.

Returns:

document fields

Throws:

RemoteEclipseAPIException

getField

IRemoteNotesUIField getField(java.lang.String name)
                             throws RemoteEclipseAPIException

Get the field from the document.

Parameters:

name - name of the field

Returns:

the field denoted by the given name

Throws:

RemoteEclipseAPIException

gotoNextField

void gotoNextField()
                   throws RemoteEclipseAPIException

Places the cursor in the next field on a document. The next field is the one below and to the right of the current field. This method is valid only when the document is in edit mode.

Throws:

RemoteEclipseAPIException

gotoPreviousField

void gotoPreviousField()
                       throws RemoteEclipseAPIException

Places the cursor in the previous field on a document. The previous field is the one above and to the left of the current field. This method is valid only when the document is in edit mode.

Throws:

RemoteEclipseAPIException

isNewDoc

boolean isNewDoc()
                 throws RemoteEclipseAPIException

Indicates whether a document is new. A new document is one that hasn't been saved.

Returns:

true indicates that the document is new, and hasn't been saved, false indicates that the document is not new, and has been saved

Throws:

RemoteEclipseAPIException

isEditable

boolean isEditable()
                   throws RemoteEclipseAPIException

Indicates whether the document can be placed in edit mode.

Returns:

true if the document is or can be put into edit mode, false if the document is not or cannot be but into edit mode

Throws:

RemoteEclipseAPIException

isEditMode

boolean isEditMode()
                   throws RemoteEclipseAPIException

Indicates whether a document is in edit mode.

Returns:

true if the document is in edit mode, false if the document is not in edit mode

Throws:

RemoteEclipseAPIException

setEditMode

void setEditMode(boolean edit)
                 throws RemoteEclipseAPIException

Set whether or not the document should be in edit mode.

Parameters:

edit - true to put the document in edit more, false to put it in read-only mode

Throws:

RemoteEclipseAPIException

isInPreviewPane

boolean isInPreviewPane()
                        throws RemoteEclipseAPIException

Indicates whether the document is being accessed from the preview pane.

Returns:

true indicates that the document is being accessed from the preview pane, false indicates that the document was opened by the user

Throws:

RemoteEclipseAPIException

clearSelectedText

void clearSelectedText()
                       throws RemoteEclipseAPIException

Deletes the current selection from a document. The current selection can be anything in an editable field, such as text or graphics. This method is valid only when the document is in Edit mode.

Throws:

RemoteEclipseAPIException

copy

void copy()
          throws RemoteEclipseAPIException

Copies the current selection in a document to the Clipboard. The current selection can be anything on the document, such as text or graphics. This method is valid only when the document is in Edit mode.

Throws:

RemoteEclipseAPIException

cut

void cut()
         throws RemoteEclipseAPIException

Cuts the current selection from a document and places it on the Clipboard. The current selection can be anything in an editable field, such as text or graphics. This method is valid only when the document is in Edit mode.

Throws:

RemoteEclipseAPIException

paste

void paste()
           throws RemoteEclipseAPIException

Pastes the contents of the Clipboard at the current cursor position on a document. This method is valid only when the document is in Edit mode.

Throws:

RemoteEclipseAPIException

getSelectedText

java.lang.String getSelectedText()
                                 throws RemoteEclipseAPIException

Gets the text that is highlighted in the UI. Gives an empty String if no text is selected.

Returns:

the currently selected text, or an empty string if nothing is selected

Throws:

RemoteEclipseAPIException

insertText

void insertText(java.lang.String text)
                throws RemoteEclipseAPIException

Inserts text at the cursor. If there is a selection, it is replaced. If the user can place the document into edit mode, that is done and the text is inserted.

Parameters:

text - plain text to insert

Throws:

RemoteEclipseAPIException

insertHtml

void insertHtml(java.lang.String html)
                throws RemoteEclipseAPIException

Inserts HMTL at the cursor. If there is a selection, it is replaced. If the user can place the document into edit mode, that is done and the HTML is inserted.

Parameters:

html - HTML to insert

Throws:

RemoteEclipseAPIException

print

void print()
           throws RemoteEclipseAPIException

Sends the document to the printer.

Throws:

RemoteEclipseAPIException

refresh

void refresh()
             throws RemoteEclipseAPIException

Refreshes a document. When you refresh a document, its computed fields are recalculated. This method is valid only when the document is in edit mode.

Throws:

RemoteEclipseAPIException

refreshHideFormulas

void refreshHideFormulas()
                         throws RemoteEclipseAPIException

Recalculates the hide-when formulas on the current document's form. Use this method when you want to recalculate hide-when formulas without recalculating all the formulas on the current document's form. This method is an expensive operation, and may affect performance.

Throws:

RemoteEclipseAPIException

reload

void reload()
            throws RemoteEclipseAPIException

Refreshes the current document with any changes that have been made to the corresponding back-end document. Refreshing the current document updates its representation in memory, and visually on the workspace, to reflect the changes that have been made to the back-end document. This method is valid only when the document is in edit mode. Modifications made to rich text items on the back-end document will not appear on the current document until the current document is closed and reopened.

Throws:

RemoteEclipseAPIException

getForm

java.lang.String getForm()
                         throws RemoteEclipseAPIException

Get the name of the document's form. Note this method returns the actual form name, not the alias of the form.

Returns:

the form name

Throws:

RemoteEclipseAPIException

save

void save()
          throws RemoteEclipseAPIException

Saves the document. Valid only when the document is in edit mode.

Throws:

RemoteEclipseAPIException

selectAll

void selectAll()
               throws RemoteEclipseAPIException

If the document is in edit mode, selects the entire contents of the current field. If the document is in read mode, selects the entire contents of the document.

Throws:

RemoteEclipseAPIException

deselectAll

void deselectAll()
                 throws RemoteEclipseAPIException

Deselects any selections in a document.

Throws:

RemoteEclipseAPIException

getDocumentData

IRemoteNotesDocumentData getDocumentData()
                                         throws RemoteEclipseAPIException

Gets the document data for this document.

Returns:

the document data for this document

Throws:

RemoteEclipseAPIException