クラス一覧 | ファイル一覧

SmartdbClientAPIStub.js

SmartDBクライアントAPIの概要

SmartDBのHTML画面上にカスタムロジックを埋め込むための軽量なJavascriptライブラリです。 「クライアント」とは、そのAPIのカバーする範囲はウェブページ上に限定するという意味で、「API」は、 アプリケーションインタフェースの略で、ユーザのビジネスロジックをSmartDBの内部動作に結合する ための架け橋の役割を担います。

機能

1. SmartDB画面に対して、ブラウザのイベントにぶら下がるカスタムイベントの定義および処理を追加できる方法を提供します。
2. SmartDBの文書編集、文書詳細閲覧、文書一覧画面上、文書オブジェクトとして統一扱う方法を提供します。
3. SmartDB既存の画面に、HookPointが埋め込まれました。事前に特定のHookPoint処理を登録すれば、 SmartDBの処理がそのHookPointに差し掛かった時に、登録済みのHookPoint処理が呼び出され、入力チェックをしたり、 選択ダイアログに追加のパラメータを渡したり、戻り値によって画面遷移をコントロールしたりすることが出来ます。
4. ClientAPIはAjaxコールをラッピングしています。これらのAPIを使うことで、サーバ側に保存された文書などの情報を取得 できます。このように、SmartDB経由で外部の他アプリケーションサーバへアクセスすることで、他システムとの連携も可能です。
5. SmartDB以外のアプリのダイアログを開く時にSmartDBの文書情報を渡したり、ダイアログ閉じた後の選択情報を加工して SmartDBの文書情報として保存したりすることによって、SmartDB以外のアプリとの画面間連携を実現します。

クライアントAPIの実行環境

Prototype.js-1.6.1がロードされた状態なので、左記に含まれるユーティリティ関数が使えます。

作成者:

DreamArts

バージョン:

1.0.1

media/js/smartdb/clientapi/CustomEvent.js