When Notes 8 was released, it opened a whole new world of application development based on Eclipse technology. The combination of the Eclipse plugin framework and the existing Notes.jar APIs enabled interesting and powerful plugins to be built on top of Lotus Notes. Notes.jar APIs allowed plugin developers to access back-end information about Domino applications, but did not provide a means to access information about the Notes UI. The information that could be obtained about the Notes UI was accessed through Eclipse APIs or through unsupported, undocumented Notes plugin APIs that were not intended for external use. The Notes Client Java UI APIs were introduced in Notes 8.5.1 as a means for plugin developers to access information about the Notes UI through well documented and supported APIs. In conjunction with Notes.jar APIs, the Notes Client Java UI APIs allow Eclipse plugin developers to create robust applications that leverage their Domino data in the Notes UI.
Resources
Click here to open the JavaDoc in a new window.
Click here to download the JavaDoc.
Click here to download the JavaDoc in Japanese.
Click here to download a sample plugin from OpenNTF.
Search Terms:
com.ibm.notes.java.api com.ibm.notes.java.ui com.ibm.notes.java.api.data com.ibm.notes.java.api.uti com.ibm.notes.java.ui.callbacks com.ibm.notes.java.ui.documents com.ibm.notes.java.ui.events com.ibm.notes.java.ui.listeners com.ibm.notes.java.ui.prompt com.ibm.notes.java.ui.views DOcumentFieldChangeEvent DocumentFieldListener NotesAgentData NotesBEDocument NotesData NotesDatabaseData NotesDocumentData NotesDocumentDataCallback NotesDocumentDataEvent NotesDocumentKeyData NotesDocumentUtil NotesFormData NotesFramesetData NotesJob NotesPageData NotesPlatform NotesSessionJob NotesThreadUtil NotesUIDocument NotesUIElement NotesUIEvent NotesUIField NotesUIView NotesUIWorkspace NotesViewData Prompt
activate() addCloseListener(Listener) addComposeItem(String, Object) addDatabase(NotesDatabaseData) addEditListener(Listener) addFieldListener(DocumentFieldListener) addItem(String, Object)
addModifiedListener(Listener) appendItemValues(Document, Map) appendText(String) baseUrl ChooseDatabase(String, String) ChooseDatabase() close() composeDocument(Document)
composeDocument(NotesDatabaseData, Document) composeDocument(NotesFormData) contains(String) copy() createSession() cut() deselectAll() DocumentFieldChangeEvent(NotesUIField, NotesUIField) done(NotesDocumentDataEvent) encode(String) equals(Object) fieldChanged(DocumentFieldChangeEvent) getBaseUrl() getBEDocument() getCalendar(int, int, int, int, int, int, int, TimeZone)
getCalendarDate(int, int, int) getCalendarTime(int, int, int, int) getComposeItems() getCurrentDocument() getCurrentField() getCurrentView() getDatabaseData() getDatabaseData() getDateTime(Session, Date) getDateTime(Session, Calendar) getDocumentData() getDocumentData() getDocumentKey() getEditUrl() getError() getField(String) getFields() getFilePath() getForm() getFramesetUnid() getInstance() getItemCalendar(String) getItemDouble(String) getItemInteger(String) getItemList(String) getItems() getItemString(String) getName() getNewField() getOldField() getOpenUrl() getParser() getReplicaId() getSearchUrl(String) getSelectedText() getServer() getSession() getTemporaryDocument(Session) getText() getTitle() getUIDocument() getUnid() getUrl() getViewData() gotoNextField()
gotoPreviousField() handle(NotesException) handle(InterruptedException) hasDate(Calendar) hasItem(String) hasTime(Calendar) initThread() insertHtml(String) insertText(String) isEditable()
isEditMode() isInPreviewPane() isNewDoc() isOnMainThread() NOTES_COMMAND_SEPARATOR NOTES_PARAMETER_SEPARATOR NOTES_PATH_SEPARATOR NOTES_PROTOCOL NotesData()
NotesData(String) NotesDatabaseData(String, String, String, String) NotesDatabaseData(String, String, String) NotesDatabaseData(String) NotesDatabaseData(Database) NotesDocumentData(NotesViewData, String) NotesDocumentData(NotesDatabaseData, String) NotesDocumentData(Document) NotesDocumentKeyData(NotesViewData, String) NotesDocumentKeyData(Document) NotesFormData(NotesDatabaseData, String) NotesFormData(Form) NotesFramesetData(NotesDatabaseData, String) NotesPageData(NotesDatabaseData, String)
NotesViewData(NotesDatabaseData, String) NotesViewData(NotesDatabaseData, String, String) NotesViewData(View) Ok(String, String) OkCancelCombo(String, String, String, String[]) OkCancelEdit(String, String, String) OkCancelEditCombo(String, String, String, String[]) OkCancelList(String, String, String, String[]) OkCancelListMulti(String, String, String[], String[]) open(Session) openDatabase(NotesDatabaseData) openDocument(boolean, NotesDocumentData) openDocumentByKey(NotesDocumentKeyData) openFrameset(NotesFramesetData) openFrameset(NotesFramesetData, String) openFrameset(NotesFramesetData, NotesViewData) openPage(NotesPageData) openUrl(String) openView(NotesViewData) Password(String, String) paste()
print() prompt(int, String, String, Object, String[]) PROMPT_CHOOSEDATABASE PROMPT_OK PROMPT_OKCANCELCOMBO PROMPT_OKCANCELEDIT PROMPT_OKCANCELEDITCOMBO
PROMPT_OKCANCELLIST PROMPT_OKCANCELLISTMULT PROMPT_PASSWORD PROMPT_YESNO PROMPT_YESNOCANCEL recycle() refresh() refreshHideFormulas() reload()
removeCloseListener(Listener) removeCommandAndParams(String) removeComposeItem(String) removeEditListener(Listener) removeFieldListener(DocumentFieldListener)
removeItem(String) removeModifiedListener(Listener) run(IProgressMonitor) runAgent(NotesAgentData, NotesDocumentDataCallback, boolean) runInNotesThread(IProgressMonitor)
runInNotesThread(Session, IProgressMonitor) save() selectAll() setBaseUrl() setEditMode(boolean) setFilePath(String) setForm(Document, String) setItemValue(String, Object) setName(String) setReplicaId(String) setText(String) setTitle(String) termThread() YesNo(String, String) YesNoCancel(String, String)