SYNCERのロゴ
アイキャッチ画像

KeyboardEvent() - コンストラクタ

KeyboardEvent()は、KeyboardEventのコンストラクタです。新しいオブジェクトを作成します。

概要

名前
KeyboardEvent
所属
KeyboardEvent
IDL
Constructor(DOMString type, optional KeyboardEventInit eventInitDict)

dictionary KeyboardEventInit : EventModifierInit {
  DOMString key = "";
  DOMString code = "";
  unsigned long location = 0;
  boolean repeat = false;
  boolean isComposing = false;
};

partial dictionary MouseEventInit {
    long movementX = 0;
    long movementY = 0;
};

partial dictionary MouseEventInit {
  double screenX = 0.0;
  double screenY = 0.0;
  double clientX = 0.0;
  double clientY = 0.0;
};

dictionary EventModifierInit : UIEventInit {
  boolean ctrlKey = false;
  boolean shiftKey = false;
  boolean altKey = false;
  boolean metaKey = false;

  boolean modifierAltGraph = false;
  boolean modifierCapsLock = false;
  boolean modifierFn = false;
  boolean modifierFnLock = false;
  boolean modifierHyper = false;
  boolean modifierNumLock = false;
  boolean modifierScrollLock = false;
  boolean modifierSuper = false;
  boolean modifierSymbol = false;
  boolean modifierSymbolLock = false;
};

dictionary MouseEventInit : EventModifierInit {
  long screenX = 0;
  long screenY = 0;
  long clientX = 0;
  long clientY = 0;

  short button = 0;
  unsigned short buttons = 0;
  EventTarget? relatedTarget = null;
};

dictionary UIEventInit : EventInit {
  Window? view = null;
  long detail = 0;
};

dictionary EventInit {
  boolean bubbles = false;
  boolean cancelable = false;
  boolean composed = false;
};
仕様書
https://w3c.github.io/uievents/#dom-keyboardevent-keyboardevent

説明

第1引数(type)には、イベントの種類を表す文字列を指定します。

第2引数(eventInitDict)には、オブジェクトの各値をオブジェクトで定義します。指定できる固有のキーは下記の通りです。UIEvent()のキーを継承しています。

key
keyの値。初期値は""。
code
codeの値。初期値は""。
location
locationの値。初期値は0。
repeat
repeatの値。初期値はfalse。
isComposing
isComposingの値。初期値はfalse。

チュートリアル

コンストラクタでKeyboardEventを作成する例です。EventTarget.dispatchEvent()の引数にすれば、擬似的にイベントを発生させることができます。

var event = new KeyboardEvent( "compositionupdate", {
	key: "a" ,
	code: "keyA" ,
	location: 1 ,
	repeat: false ,
	isComposing: false ,
} ) ;

element.dispatchEvent( event ) ;

デモ

KeyboardEvent()のデモです。ボタンをクリックすると、keydownイベントのオブジェクトを作成して擬似的にイベントを発火させます。

<!-- このコードは編集できます。 -->

<!DOCTYPE html>
<html>
<head>
<style>
textarea#hoge {
	width: 80% ;
	min-height: 80px ;
	font-size: 16px ;
}
div#result { white-space: pre-wrap ; }
</style>
</head>
<body>
<button id="create">イベントを作成</button>
<hr>
<textarea id="hoge"></textarea>
<hr>
<p>keydownの発生回数→<span id="count">0</span></p>
<div id="result"></div>
<script>
var element = document.getElementById( "hoge" ) ;
element.addEventListener( "keydown", getEventInfo ) ;

var number = 0 ;

document.getElementById( "create" ).onclick = function () {
	var event = new KeyboardEvent( "keydown", {
		key: "a" ,
		code: "keyA" ,
		location: 1 ,
		repeat: false ,
		isComposing: false ,
	} ) ;
	element.dispatchEvent( event ) ;
}

function getEventInfo( event ) {
	document.getElementById( "result" ).textContent = "" ;
	document.getElementById( "count" ).textContent = ++number ;

	console.log( event ) ;
	appendText( event + "\n" ) ;
	appendText( "key: " + event.key + "\n" ) ;
	appendText( "code: " + event.code + "\n" ) ;
	appendText( "location: " + event.location + "\n" ) ;
	appendText( "repeat: " + event.repeat + "\n" ) ;
	appendText( "isComposing: " + event.isComposing + "\n" ) ;
}

function appendText ( text ) {
	document.getElementById( "result" ).appendChild( document.createTextNode( text ) ) ;
}
</script>
</body>
</html>

サポート状況

ChromeFirefoxSafariEdgeIEOperaiOS SafariAndroid
26+ 31+ 7.1+× 15+ 7.0+ 4.4+
  • Twitterでシェア
  • Facebookでシェア
  • Google+でシェア
  • はてなブックマークでシェア
  • pocketに保存
  • LINEでシェア
更新履歴
2017年10月24日 (火)
コンテンツを公開しました。