PlatformUI API - access the Notes Client workbench

Abstract

ShowTable of Contents

HideTable of Contents

1 Access the API

1.1 Message boxes
1.2 File and directory dialogs
1.3 Workbench access

2 Sample applications

The PlatformUI API gives you access to the Eclipse part of the Notes Client user interface: You can find out what the user is currently looking at, open new display areas for content (so called view parts) or bring existing ones to the front.

The API also contains helper classes to display message boxes and file/directory selection dialogs.

Access the API

To use the PlatformUI API, call the method com.x2e.PlatformUIAPI.getUI(conn) with a valid XPages2Eclipse connection object.

The resulting object of type IRemotePlatformUI contains a useful helper method to write text to the Notes Client's status bar:

var conn=X2E.createConnection();
var pUI=com.x2e.PlatformUIAPI.getUI(conn);
pUI.logToStatusBar("Use the method 'logToStatusBar()' to write status and debug information");

Message boxes

The MessageBoxTools class that you get by calling pUI.getMessageBoxTools() makes it easy to display a variety of message box types from server-side JavaScript of an XPage, and also from JavaScript code launched at client startup and JavaScript background jobs. The class offers all kinds of standard message boxes that SWT, the graphical library of Eclipse, offers

var conn=X2E.createConnection();
var pUI=com.x2e.PlatformUIAPI.getUI(conn);
var msgBoxTools=pUI.getMessageBoxTools();
//the first parameter is a bit combination of an ICON_ constant and the button types (e.g. OK, CANCEL)
msgBoxTools.showMessageBox(2 /* ICON_INFORMATION */ | 32 /* OK */,"Title", "Information message");

For a complete reference of available message box icons and buttons, please refer to the Javadocs for the Base API.
The sample application for this wiki article demonstrates all valid icon/button combinations: