Base API Overview

This page lists all the available areas of the XPages2Eclipse base API. For each area, we provide tutorial articles which, together with the XPages2Eclipse Base API Javadocs, will help you to discover what the product has to offer.

In addition to code snippets, most of the articles will also contain a sample that you can download and experiment with.

 

PlatformUI API

Functionality to access the Eclipse workbench, e.g. open viewparts and read viewpart properties, locate the active viewpart as well as useful tools to display messages and file/directory selection dialogs.

Articles using this API

PlatformUI API - access the Notes Client workbench
Focus Tracking - Track viewpart and perspective activation with JavaScript listeners
JavaScript Jobs - Background operations developed in JavaScript (directory selection dialog)

Notes UI API

Job API

Functionality to visualize and execute code as Eclipse background job including parameter passing from SSJS code, progress tracking in progress dialogs and progress perspective and sharing of job execution result between different job types (e.g. Notes agent execution, JavaScript code) and calling code.

Articles using this API

Monitoring Jobs - Display progress of SSJS Ajax requests

Clipboard API

Component API

Contains functions to create visual components (e.g. with Notes data or a web browser) programmatically and useful tools to work with Composite Applications.

Articles using this API

Component API - Create component viewparts programmatically

Access the HTML DOM tree of XPages viewparts, read the current URL and execute client-side JavaScript in the context of the web page.

Articles using this API

Perspective API

Functionality to create custom Eclipse perspectives (main tabs) in the Lotus Notes Client.

Articles using this API

Extension Registry API