|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IRemoteNotesUIDocument
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 |
---|
IRemoteNotesBEDocument getBEDocument() throws RemoteEclipseAPIException
RemoteEclipseAPIException
IRemoteNotesUIField getCurrentField() throws RemoteEclipseAPIException
RemoteEclipseAPIException
IRemoteNotesUIField[] getFields() throws RemoteEclipseAPIException
RemoteEclipseAPIException
IRemoteNotesUIField getField(java.lang.String name) throws RemoteEclipseAPIException
name
- name of the field
RemoteEclipseAPIException
void gotoNextField() throws RemoteEclipseAPIException
RemoteEclipseAPIException
void gotoPreviousField() throws RemoteEclipseAPIException
RemoteEclipseAPIException
boolean isNewDoc() throws RemoteEclipseAPIException
RemoteEclipseAPIException
boolean isEditable() throws RemoteEclipseAPIException
RemoteEclipseAPIException
boolean isEditMode() throws RemoteEclipseAPIException
RemoteEclipseAPIException
void setEditMode(boolean edit) throws RemoteEclipseAPIException
edit
- true to put the document in edit more, false to put it in read-only mode
RemoteEclipseAPIException
boolean isInPreviewPane() throws RemoteEclipseAPIException
RemoteEclipseAPIException
void clearSelectedText() throws RemoteEclipseAPIException
RemoteEclipseAPIException
void copy() throws RemoteEclipseAPIException
RemoteEclipseAPIException
void cut() throws RemoteEclipseAPIException
RemoteEclipseAPIException
void paste() throws RemoteEclipseAPIException
RemoteEclipseAPIException
java.lang.String getSelectedText() throws RemoteEclipseAPIException
RemoteEclipseAPIException
void insertText(java.lang.String text) throws RemoteEclipseAPIException
text
- plain text to insert
RemoteEclipseAPIException
void insertHtml(java.lang.String html) throws RemoteEclipseAPIException
html
- HTML to insert
RemoteEclipseAPIException
void print() throws RemoteEclipseAPIException
RemoteEclipseAPIException
void refresh() throws RemoteEclipseAPIException
RemoteEclipseAPIException
void refreshHideFormulas() throws RemoteEclipseAPIException
RemoteEclipseAPIException
void reload() throws RemoteEclipseAPIException
RemoteEclipseAPIException
java.lang.String getForm() throws RemoteEclipseAPIException
RemoteEclipseAPIException
void save() throws RemoteEclipseAPIException
RemoteEclipseAPIException
void selectAll() throws RemoteEclipseAPIException
RemoteEclipseAPIException
void deselectAll() throws RemoteEclipseAPIException
RemoteEclipseAPIException
IRemoteNotesDocumentData getDocumentData() throws RemoteEclipseAPIException
RemoteEclipseAPIException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |