.dispatchEvent()
DOM内のノードのイベントを実行します。
指定された対象に対してイベントを発行し、適切な方法でイベントリスナーを呼び出します。
dispatchEvent()を使用した手動でのイベントの発行は、
通常のイベント処理のルール(キャプチャと任意のバブルフェーズを含む)が適用されます。
文法
//(訳注)イベントがキャンセルされるとfalseが返るため、
// キャンセルされるとキャンセルされたのかを表す変数canceledがtrueになります。
canceled = !target.dispatchEvent(event)
| 引数 | 説明 |
|---|---|
| event |
型： 発行するEventオブジェクトを指定します。 |
| 対象 | 説明 |
| target |
|
| 戻り値 | 説明 |
| canceled |
型：
少なくとも1つのイベントハンドラが、
このイベントでEvent.preventDefault()を呼び出したのであれば、
戻り値は |
もしメソッドが呼び出される前にイベント初期化によってイベントの型が特定出来ない、
またはイベントの型がnullまたは空文字列の場合、
dispatchEventメソッドは、UNSPECIFIED_EVENT_TYPE_ERR例外をスローします。
イベントハンドラによる例外のスローは、キャッチできない例外とされます。
イベントハンドラは入れ子のコールスタック上で実行され、それらが完了するまで呼び出し元をブロックしますが、
例外は呼び出し元へ伝搬されません。
注意事項
dispatchEventは、イベントモデル実装へのイベント発行で使用される、
作成(create)-初期化(init)-発行(dispatch)プロセスの最後のステップになります。
イベントはdocument.createEventをメソッド使用して作成し、
initEvent(非推奨)や、
その他の特定のinitMouseEvent、
initUIEventのような特定のメソッドを使用して初期化することが出来ます。
詳細は、Eventオブジェクトのページを参照してください。
サンプル
Creating and triggering events(イベントの作成とトリガ)を参照してください。
仕様
© 2017 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
このページは、ページトップのURL先のMozilla Developer Network(以下、MDN)のコンテンツを翻訳した内容を基に構成されています。 構成について異なる点も含まれますので、下記の項目を確認し、必要に応じて元のコンテンツをご確認ください。 もし、誤訳などの間違いを見つけましたら、 @tomofまで教えていただければ幸いです。
- 特定のブラウザに特化しすぎている情報やあまりにも古い情報、 または試験的に導入されているようなAPIや機能については、省略していることがあります。
- 例やデモについて、実際にページ内で動作させる関係で一部ソースコードを変更している場合や、 その例で使用しているコンテンツの単語や文章などを日本人向けに変更しいてる場合があります。
- MDNの更新頻度が高いため、元のコンテンツと比べ情報が古くなっている可能性があります。
- "訳注:"などの断わりを入れた上で、日本人向けの情報の追記を行っている事があります。