この基底クラスは、 on, onceそして off
イベントをディスパッチできるオブジェクトのメソッド。
方法
| 名称 | 説明 |
|---|---|
addEventListener(type, listener, context) |
非推奨です。 |
off(type, handler, context) → {Object} |
1つまたは複数のイベントハンドラを削除します。 |
on(type, handler, context) → {EventDispatcher} |
1つ以上のイベントに対するイベントハンドラ関数を追加します。 |
once(type, handler, context) → {Object} |
1つ以上のイベントに対するイベントハンドラ関数を追加します。 |
removeEventListener(type, listener, context) |
非推奨です。 |
addEventListener(type, listener, context)
パラメータ:
| 名称 | タイプ | 説明 |
|---|---|---|
type |
ストリング | イベントの種類を識別する文字列。 |
listener |
機能 | オブジェクトがイベントをディスパッチする際に呼び出される関数。 |
context |
目的 | (オプション)の値を定義します。 this イベントハンドラ関数内で。 |
非推奨 — 使い方 on() または once() その代わりだ。
このメソッドは、特定のイベントのイベントリスナーとしてメソッドを登録します。
イベントに対してハンドラが登録されていない場合、そのイベントはローカルでは無視されます。 イベントリスナー関数が存在しない場合、そのイベントはローカルでは無視されます。
以下の場合、例外をスローします。 listener 名前が無効です。
off(type, handler, context) →{Object}
1つまたは複数のイベントハンドラを削除します。
イベント名を1つとハンドラメソッドを1つ渡すと、その イベントのハンドラが削除されます:
obj.off("eventName", eventHandler);
複数のイベント名とハンドラメソッドを渡した場合、それらのイベントについては ハンドラが削除されます:
obj.off("eventName1 eventName2", eventHandler);
イベント名(1つまたは複数)を指定して いいえ ハンドラメソッドでは、それらのイベントに対して すべてのハンドラが削除されます:
obj.off("event1Name event2Name");
引数を指定しない場合は、 すべて そのオブジェクトによってディスパッチされたすべてのイベントについて、 イベントハンドラが削除されます:
obj.off();
このメソッドは、別の構文もサポートしています。この構文では、最初のパラメータは イベント名とハンドラ関数のハッシュマップであるオブジェクトとなり、2番目のパラメータ(オプション)は 各ハンドラにおけるこのオブジェクトのコンテキストとなります:
obj.off(
{
eventName1: event1Handler,
eventName2: event2Handler
});
パラメータ:
| 名称 | タイプ | 説明 |
|---|---|---|
type |
ストリング | (オプション)イベントの種類を識別する文字列。スペースを区切りとして複数のイベントを指定できます(例:「accessAllowed accessDenied accessDialogClosed」)。何も指定しない場合は type 値(またはその他の引数)が指定されると、そのオブジェクトのすべてのイベントハンドラが削除されます。 |
handler |
機能 | (オプション)削除するイベントハンドラ関数。このハンドラは、 on(). 以下のようなヘルパー関数については注意が必要です。 bind() 呼び出されると新しい関数を返すもの。引数を何も渡さない場合は handler, 指定されたイベントに対するすべてのイベントハンドラが削除されます type. |
context |
目的 | (任意)もし context, 指定されたすべてのイベントおよび、指定されたコンテキストを使用するハンドラについて、イベントハンドラが削除されます。(コンテキストは、 on().) |
リターンズ
イベントを発生させたオブジェクト。
on(type, handler, context) → {EventDispatcher}
1つ以上のイベントに対するイベントハンドラ関数を追加します。
次のコードは、1つのイベントに対するイベントハンドラを追加します:
obj.on("eventName", function (event) {
// This is the event handler.
});
複数のイベント名とハンドラメソッドを渡すと、それらのイベントそれぞれに対して ハンドラが登録されます:
obj.on("eventName1 eventName2",
function (event) {
// This is the event handler.
});
3つ目を渡すこともできます context (オプションの)パラメータを使用して、
の値を定義します。 this ハンドラメソッド内で:
obj.on("eventName",
function (event) {
// This is the event handler.
},
obj);
このメソッドは、別の構文もサポートしています。この構文では、最初のパラメータはイベント名とハンドラ関数のハッシュマップであるオブジェクトとなり、2番目のパラメータ(オプション)は、各ハンドラにおけるこのオブジェクトのコンテキストとなります:
obj.on(
{
eventName1: function (event) {
// This is the handler for eventName1.
},
eventName2: function (event) {
// This is the handler for eventName2.
}
},
obj);
イベントに対するハンドラを追加しない場合、そのイベントはローカルでは無視されます。
パラメータ:
| 名称 | タイプ | 説明 |
|---|---|---|
type |
ストリング | イベントの種類を識別する文字列です。この文字列には、スペースで区切って複数のイベント名を指定できます。イベントハンドラは、指定された各イベントを処理します。 |
handler |
機能 | イベントを処理するためのハンドラ関数です。この関数は、イベントオブジェクトをパラメータとして受け取ります。 |
context |
目的 | (オプション)の値を定義します。 this イベントハンドラ関数内で。 |
リターンズ
EventDispatcher オブジェクト。
once(type, handler, context) →{Object}
1つ以上のイベントに対するイベントハンドラ関数を追加します。ハンドラが呼び出されると、
指定されたハンドラメソッドは、このイベントのハンドラとして削除されます。( on() イベントハンドラを追加する方法として、そのハンドラは 違う
(呼び出された際に削除されます。)その once() このメソッドは、
を呼び出すことと同じです。 on()
メソッドと呼び出し off() ハンドラが最初に呼び出されたとき。
次のコードは、1つのイベントに対して1回限りのイベントハンドラを追加します:
obj.once("eventName", function (event) {
// This is the event handler.
});
複数のイベント名とハンドラメソッドを渡すと、それらのイベントそれぞれに対して ハンドラが登録されます:
obj.once("eventName1 eventName2"
function (event) {
// This is the event handler.
});
3つ目を渡すこともできます context (オプションの)パラメータを使用して、
の値を定義します
this ハンドラメソッド内で:
obj.once("eventName",
function (event) {
// This is the event handler.
},
obj);
このメソッドは、別の構文もサポートしています。この構文では、最初のパラメータは イベント名とハンドラ関数のハッシュマップであるオブジェクトとなり、2番目のパラメータ(オプション)は 各ハンドラにおけるこのオブジェクトのコンテキストとなります:
obj.once(
{
eventName1: function (event) {
// This is the event handler for eventName1.
},
eventName2: function (event) {
// This is the event handler for eventName1.
}
},
obj);
パラメータ:
| 名称 | タイプ | 説明 |
|---|---|---|
type |
ストリング | イベントの種類を識別する文字列です。この文字列には、スペースで区切って複数のイベント名を指定できます。イベントハンドラは、指定されたイベントのうち最初に発生したものを処理します。最初のイベントが発生した後、ハンドラは(指定されたすべてのイベントについて)削除されます。 |
handler |
機能 | イベントを処理するためのハンドラ関数です。この関数は、イベントオブジェクトをパラメータとして受け取ります。 |
context |
目的 | (オプション)の値を定義します。 this イベントハンドラ関数内で。 |
リターンズ
イベントを発生させたオブジェクト。
removeEventListener(type, listener, context)
パラメータ:
| 名称 | タイプ | 説明 |
|---|---|---|
type |
ストリング | イベントの種類を識別する文字列。 |
listener |
機能 | 削除するイベントリスナー関数。 |
context |
目的 | (任意)もし context, 指定されたすべてのイベントおよび、指定されたコンテキストを使用するイベントリスナーについて、イベントハンドラが削除されます。(コンテキストは、 addEventListener().) |
非推奨 — 使い方 off() その代わりだ。
特定のイベントに対するイベントリスナーを解除します。
以下の場合、例外をスローします。 listener 名前が無効です。