common.trigger

trigger(eventData)

on()メソッドで追加されたイベントを実行します。 戻り値はobjectです。

eventDataobject

イベントパラメータ。

説明

全てのw2uiウィジェットはイベントリスナを実行するために、内部的にtriggerメソッドを呼び出しています。 独自のイベントをtriggerメソッドでトリガーすることができます。 triggerはデフォルトアクションが処理される前に1回、処理された後に1回呼び出す必要があります。

トリガーを指定する方法は以下の通りです。

// event before
var event = this.trigger({ phase: 'before', target: this.name, type: 'click', recid: recid, event: event });
if (event.cancelled === true) return false;

// default action

// event after
this.trigger($.extend(event, { phase: 'after' }));

上記からも分かるように、デフォルトアクションはイベントハンドラから呼ばれたevent.preventDefault()で 取り消すことができます。 JavaScriptはオブジェクトを参照渡しするため、eventオブジェクトを返す必要はありません。
イベントハンドラのeventによって元オブジェクトを直接変更します。 イベントが処理された後に、アクションを実行する必要がある場合、 コールバックとしてevent.onCompleteを定義することもできます。