.initKeyEvent()

document.createEvent("KeyboardEvent")を使用して作成されたイベントの値を初期化するのに使用されます。

文法

event.initKeyEvent (type, bubbles, cancelable, viewArg,
                    ctrlKeyArg, altKeyArg, shiftKeyArg, metaKeyArg,
                    keyCodeArg, charCodeArg)
引数 説明
type イベントのタイプを指定します。
bubbles イベントがイベントチェーンを介してバブルアップすべきか否かの真偽値を指定します。 (bubbles参照)
cancelable イベントがキャンセル可能であるか否かの真偽値を指定します。 (cancelable参照)
viewArg UIEvent.viewを指定します。 この値は、nullを指定することも可能です。
ctrlKeyArg 生成された仮想キーがCtrlキーとその他のキーと連携する場合、真偽値のtrueを指定します。
altKeyArg 生成された仮想キーがAltキーとその他のキーと連携する場合、真偽値のtrueを指定します。
shiftKeyArg 生成された仮想キーがShiftキーとその他のキーと連携する場合、真偽値のtrueを指定します。
metaKeyArg 生成された仮想キーがMetaキーとその他のキーと連携する場合、真偽値のtrueを指定します。
keyCodeArg キーが押された際の仮想キーの整数値を、 もしくは0を指定します。
charCodeArg キーが押された際のそれに関連付くUnicode文字を、 もしくは0を指定します。

キーコードの一覧については、 dom/interfaces/events/nsIDOMKeyEvent.idlを参照してください。

// create a key event
event.initKeyEvent(
  "keypress",  // DOMString typeArg,
   true,       // boolean canBubbleArg,
   true,       // boolean cancelableArg,
   null,       // nsIDOMAbstractView viewArg, UIEvent.viewを指定、nullも可。
   false,      // boolean ctrlKeyArg,
   false,      // boolean altKeyArg,
   false,      // boolean shiftKeyArg,
   false,      // boolean metaKeyArg,
    9,         // unsigned long keyCodeArg,
    0);        // unsigned long charCodeArg);

注意事項

この方法で初期化されるイベントは、 document.createEvent("KeyboardEvent")を使用して、 作成されていなければいけません。 initKeyEventはそれがdispatchされる前に、 イベントを設定するために呼び出される必要があります。

仕様

キーボードイベントのこの実装は、 DOM 2イベントの初期バージョンのキーイベント仕様が基になっていますが、 その後仕様から削除されました。

initKeyEventは現在のGeckoでは、 下記の引数に沿ったDOMレベル3の草案のinitKeyboardEventメソッドに相当します。 (翻訳に自信なし)

typeArg of type DOMString
canBubbleArg of type boolean
cancelableArg of type boolean
viewArg of type views::AbstractView
keyIdentifierArg of type DOMString
keyLocationArg of type unsigned long
modifiersList of type DOMString);

 Back to top

© 2017 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.

このページは、ページトップのURL先のMozilla Developer Network(以下、MDN)のコンテンツを翻訳した内容を基に構成されています。 構成について異なる点も含まれますので、下記の項目を確認し、必要に応じて元のコンテンツをご確認ください。 もし、誤訳などの間違いを見つけましたら、 @tomofまで教えていただければ幸いです。

  • 特定のブラウザに特化しすぎている情報やあまりにも古い情報、 または試験的に導入されているようなAPIや機能については、省略していることがあります。
  • 例やデモについて、実際にページ内で動作させる関係で一部ソースコードを変更している場合や、 その例で使用しているコンテンツの単語や文章などを日本人向けに変更しいてる場合があります。
  • MDNの更新頻度が高いため、元のコンテンツと比べ情報が古くなっている可能性があります。
  • "訳注:"などの断わりを入れた上で、日本人向けの情報の追記を行っている事があります。