Boost!シリーズのプラグインで発生するイベントに、JavaScriptで独自の処理を追加できます。このページでは、イベントハンドラーの登録と削除の方法、eventオブジェクトで実行できる操作を紹介します。イベントの種類ごとの詳細は、下のリンク先をご覧ください。
イベントハンドラーをイベントに登録する方法と、削除する方法を紹介します。
bst.event.on(type, handler)| パラメータ名 | 指定する値 | 説明 |
|---|---|---|
| type | 文字列、または文字列の配列 |
イベントハンドラーをバインドする対象のイベントタイプ、またはイベントタイプの配列を指定します。 |
| handler | 関数 |
イベント発生時に実行されるハンドラーです。 イベントのハンドラー内でPromiseオブジェクトをreturnすると、非同期処理の完了を待って次の処理を開始します。 |
(() => {
"use strict";
const handler = (event) => {
console.log(event);
};
bst.event.on('bst.view.load', handler);
})();bst.event.off(type, handler)| パラメータ名 | 指定する値 | 説明 |
|---|---|---|
| type | 文字列、または文字列の配列 |
削除対象のイベントハンドラーをバインドしたイベントタイプ、またはイベントタイプの配列を指定します。 |
| handler | 関数 |
削除対象のイベントハンドラーです。バインド時と同一のイベントハンドラーを指定します。 |
(() => {
"use strict";
const handler = (event) => {
console.log(event);
};
bst.event.on('bst.view.load', handler);
bst.event.off('bst.view.load', handler);
})();イベントハンドラーで、eventオブジェクトを使って実行できる操作を紹介します。
イベントハンドラーでレコードオブジェクトのフィールドの値を書き換えてeventオブジェクトを返すと、レコードのフィールドの値が更新されます。
(() => {
"use strict";
bst.event.on('bst.change.field_1_', (event) => {
const record = event.record;
if (record.field_1_.value=='')
{
record.field_2_.value='option1';
}
return event;
});
})();イベントハンドラーでルックアップフィールドのlookupプロパティにtrueを入力してeventオブジェクトを返すと、そのルックアップフィールドの値を自動で取得します。
ルックアップフィールドをクリアする場合は、valueプロパティを空にした状態で、lookupプロパティにtrueを入力します。
(() => {
"use strict";
bst.event.on('bst.edit.load', (event) => {
const record = event.record;
if (!record.field_3_.value)
{
record.field_3_.value=1;
record.field_3_.lookup=true;
}
return event;
});
})();イベントハンドラーでerrorプロパティにtrueを入力してeventオブジェクトを返すと、後続の処理を含む操作がキャンセルされます。
(() => {
"use strict";
bst.event.on('bst.create.submit', (event) => {
const record = event.record;
if (record.field_1_.value=='')
{
bst.alert('No value entered.');
event.error=true;
}
return event;
});
})();