Java™ リファレンス資料提供の一環として、Domino Designer には Domino Designer に関連する API の Javadoc を含むヘルププラグインが付属しています。
目的の Javadoc にアクセスするには、ヘルプの目次から「Notes およびDomino Designer のクライアント API (Client APIs for Notes and Domino Designer)」を参照してください。
このリリースの Domino Designer では、次の API の Javadoc が利用できます。
Eclipse フレームワークは、Notes クライアントの複数の場所に提供する機能を備えています。これらの場所には、グローバルツールバー、サイドバーパネル、最上位レベルまたは右クリックのメニューなどが含まれます。
Notes Client Java UI API では、クライアントのこれらの部分に提供する際に使用できるクラスを指定します。例えば、Notes 文書のコンテキストメニューに項目を提供するようにプラグインを記述することができます。ユーザーがこの項目を選択するときに実行されるカスタムコードは、Notes Client Java UI API を用いて Notes 文書をより詳細に把握し、そのプロパティを変更します。
一般的に、これらの API のスコープと機能はフロントエンドの LotusScript クラスと似ています。実装された最上位クラスには、次の内容が含まれます。
また、lotus.domino クラスを使用して Notes のバックエンドにアクセスすることも可能です (このフレームワークに含まれない notes.jar で Notes のバックエンドにアクセスすることも可能です)。このパッケージと Eclipse ベースのフレームワークとの間のブリッジとなるのが NotesSessionJob クラスです。NotesSessionJob を使用すると、コードにセッションを付与することができます。これを使用すると、コードは直接または Java エージェント内で notes.jar を使用するときと同じバックエンドロジックを利用できます。
Extensibility API を使用すると、選択が変更されたときに、カスタムプラグインで新しい選択に Domino ベースの情報が含まれているかどうかを認識し、さらに新しい選択に Domino ベースの情報が含まれている場合には、選択されているプロジェクト (データベース) と設計要素を認識することができます。
これらの API を使用すると、「コア」ベースの設計要素の設計要素レベルまで選択を追跡することができます。例えば、ユーザーが編集中のフォームが何であるかを確認できます (選択されているフィールドが何であるかはわかりません)。これらは Eclipse に含まれる標準 UI から派生するものであるため、新しい Eclipse ベースのエディタでは、より詳細な情報を得ることもできます。この Eclipse 情報の多くはすでに公開されています。
また、この API を介して設計要素の選択されたプロパティを使用することもできます。これには、例えば「タイトル」のようなすべての設計要素タイプに共通するものの「get」プロパティや「set」プロパティなどが含まれます。
また、多くのデータベースのプロパティも使用できます。API のクラスについては、Javadoc プラグインで提供される標準の JavaDoc に記載されています。API に含まれるクラスは、次のとおりです。