パッケージ | flash.events |
クラス | public class KeyboardEvent |
継承 | KeyboardEvent Event Object |
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | AIR 1.0, Flash Player 9, Flash Lite 4 |
KeyboardEvent.KEY_DOWN
および KeyboardEvent.KEY_UP
キーと特定の文字のマッピングはデバイスやオペレーティングシステムごとに異なるため、入力された文字の処理には TextEvent イベントタイプを使用してください。
キーイベントをグローバルにリスニングするには、キャプチャ段階、ターゲット段階またはバブリング段階について Stage でリスニングします。
さらに例を参照
Handling keyboard events
Understanding the keyCode and charCode properties
Understanding KeyboardEvent precedence
関連する API エレメント
プロパティ | 定義元 | ||
---|---|---|---|
altKey : Boolean
Windows では Alt キーがアクティブになっているか(true)非アクティブになっているか(false)を示します。Mac OS では Option キーがアクティブになっているかを示します。 | KeyboardEvent | ||
bubbles : Boolean [読み取り専用]
イベントがバブリングイベントかどうかを示します。 | Event | ||
cancelable : Boolean [読み取り専用]
イベントに関連付けられた動作を回避できるかどうかを示します。 | Event | ||
charCode : uint
押したキーまたは離したキーの文字コード値を含みます。 | KeyboardEvent | ||
commandKey : Boolean
Command キーがアクティブになっているか(true)非アクティブになっているか(false)を示します。 | KeyboardEvent | ||
constructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。 | Object | ||
controlKey : Boolean
Ctrl キーまたは Control キーがアクティブになっているか(true)非アクティブになっているか(false)を示します。 | KeyboardEvent | ||
ctrlKey : Boolean
Windows および Linux では Ctrl キーがアクティブになっているか(true)非アクティブになっているか(false)を示します。Mac OS では Ctrl キーまたは Command キーがアクティブになっているかを示します。 | KeyboardEvent | ||
currentTarget : Object [読み取り専用]
イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。 | Event | ||
eventPhase : uint [読み取り専用]
イベントフローの現在の段階です。 | Event | ||
keyCode : uint
押したキーまたは離したキーのキーコード値です。 | KeyboardEvent | ||
keyLocation : uint
キーボードのキーの場所を示します。 | KeyboardEvent | ||
shiftKey : Boolean
Shift キーモディファイアがアクティブになっているか(true)非アクティブになっているか(false)を示します。 | KeyboardEvent | ||
target : Object [読み取り専用]
イベントターゲットです。 | Event | ||
type : String [読み取り専用]
イベントのタイプです。 | Event |
メソッド | 定義元 | ||
---|---|---|---|
KeyboardEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false, charCodeValue:uint = 0, keyCodeValue:uint = 0, keyLocationValue:uint = 0, ctrlKeyValue:Boolean = false, altKeyValue:Boolean = false, shiftKeyValue:Boolean = false, controlKeyValue:Boolean = false, commandKeyValue:Boolean = false)
キーボードイベントに関する特定の情報を含む Event オブジェクトを作成します。 | KeyboardEvent | ||
[オーバーライド]
KeyboardEvent オブジェクトのコピーを作成して、各プロパティの値を元のプロパティの値と一致するように設定します。 | KeyboardEvent | ||
カスタム ActionScript 3.0 Event クラスに toString() メソッドを実装するためのユーティリティ関数です。 | Event | ||
オブジェクトに指定されたプロパティが定義されているかどうかを示します。 | Object | ||
イベントで preventDefault() メソッドが呼び出されたかどうかを確認します。 | Event | ||
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。 | Object | ||
イベントのデフォルト動作をキャンセルできる場合に、その動作をキャンセルします。 | Event | ||
指定されたプロパティが存在し、列挙できるかどうかを示します。 | Object | ||
ループ処理に対するダイナミックプロパティの可用性を設定します。 | Object | ||
イベントフローの現在のノードおよび後続するノードで、イベントリスナーが処理されないようにします。 | Event | ||
イベントフローの現在のノードに後続するノードで、イベントリスナーが処理されないようにします。 | Event | ||
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。 | Object | ||
[オーバーライド]
KeyboardEvent オブジェクトのすべてのプロパティを含むストリングを返します。 | KeyboardEvent | ||
表示リストが変更されている場合、このイベント終了処理の後に表示をレンダリングする必要があることを示します。
| KeyboardEvent | ||
指定されたオブジェクトのプリミティブな値を返します。 | Object |
定数 | 定義元 | ||
---|---|---|---|
KEY_DOWN : String = "keyDown" [静的]
KeyboardEvent.KEY_DOWN 定数は、keyDown イベントオブジェクトの type プロパティの値を定義します。 | KeyboardEvent | ||
KEY_UP : String = "keyUp" [静的]
KeyboardEvent.KEY_UP 定数は、keyUp イベントオブジェクトの type プロパティの値を定義します。 | KeyboardEvent |
altKey | プロパティ |
charCode | プロパティ |
charCode:uint
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | AIR 1.0, Flash Player 9, Flash Lite 4 |
押したキーまたは離したキーの文字コード値を含みます。文字コード値は英語キーボードの値です。例えば、Shift + 3 キーが押されると、charCode
は日本語のキーボードで # となり、Shift + 2 が押されると charCode
はドイツ語のキーボードで(" ではなく)@ となって、英語のキーボードと同じになります。
注意:IME が実行されているときは、charCode
では正確な文字コードが報告されません。
実装
public function get charCode():uint
public function set charCode(value:uint):void
commandKey | プロパティ |
controlKey | プロパティ |
ctrlKey | プロパティ |
keyCode | プロパティ |
keyLocation | プロパティ |
keyLocation:uint
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | AIR 1.0, Flash Player 9, Flash Lite 4 |
キーボードのキーの場所を示します。これは、キーボードに複数あるキーを区別するときに役立ちます。例えば、左の Shift キーと右の Shift キーをこのプロパティの値で区別できます。左は KeyLocation.LEFT
、右は KeyLocation.RIGHT
です。また、標準キーボードの数字キー(KeyLocation.STANDARD
)とテンキーの数字キー(KeyLocation.NUM_PAD
)のどちらが押されたかを区別することもできます。
実装
public function get keyLocation():uint
public function set keyLocation(value:uint):void
shiftKey | プロパティ |
KeyboardEvent | () | コンストラクター |
public function KeyboardEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false, charCodeValue:uint = 0, keyCodeValue:uint = 0, keyLocationValue:uint = 0, ctrlKeyValue:Boolean = false, altKeyValue:Boolean = false, shiftKeyValue:Boolean = false, controlKeyValue:Boolean = false, commandKeyValue:Boolean = false)
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | AIR 1.0, Flash Player 9, Flash Lite 4 |
キーボードイベントに関する特定の情報を含む Event オブジェクトを作成します。イベントリスナーには Event オブジェクトがパラメーターとして渡されます。
パラメーターtype:String — イベントのタイプです。有効な値は次のとおりです。KeyboardEvent.KEY_DOWN および KeyboardEvent.KEY_UP
| |
bubbles:Boolean (default = true ) — Event オブジェクトがイベントフローのバブリング段階で処理されるかどうかを判断します。
| |
cancelable:Boolean (default = false ) — Event オブジェクトがキャンセル可能かどうかを判断します。
| |
charCodeValue:uint (default = 0 ) — 押したキーまたは離したキーの文字コード値です。文字コードの戻り値は英語キーボードの値です。例えば、Shift + 3 キーが押されると、Keyboard.charCode() プロパティは日本語やドイツ語のキーボードでも英語のキーボードと同じように # を返します。
| |
keyCodeValue:uint (default = 0 ) — 押したキーまたは離したキーのキーコード値です。
| |
keyLocationValue:uint (default = 0 ) — キーボードのキーの場所です。
| |
ctrlKeyValue:Boolean (default = false ) — Windows では Ctrl キーがアクティブになっているかどうかを示します。Macintosh では、Ctrl キーと Command キーのいずれがアクティブになっているかどうかを示します。
| |
altKeyValue:Boolean (default = false ) — Alt キーモディファイアがアクティブになっているかどうかを示します(Windows のみ)。
| |
shiftKeyValue:Boolean (default = false ) — Shift キーモディファイアがアクティブになっているかどうかを示します。
| |
controlKeyValue:Boolean (default = false ) — Mac で Control キーがアクティブになっているかどうか、および Windows や Linux で Control キーまたは Ctrl キーがアクティブになっているかどうかを示します。
| |
commandKeyValue:Boolean (default = false ) — Command キーがアクティブになっているかどうかを示します(Macintosh のみ)。
|
関連する API エレメント
clone | () | メソッド |
toString | () | メソッド |
override public function toString():String
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | AIR 1.0, Flash Player 9, Flash Lite 4 |
KeyboardEvent オブジェクトのすべてのプロパティを含むストリングを返します。ストリングは次の形式です。
[KeyboardEvent type= value bubbles= value cancelable= value ... shiftKey= value ]
String — KeyboardEvent オブジェクトのすべてのプロパティを含むストリングです。
|
updateAfterEvent | () | メソッド |
public function updateAfterEvent():void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | AIR 1.0, Flash Player 9 |
表示リストが変更されている場合、このイベント終了処理の後に表示をレンダリングする必要があることを示します。
KEY_DOWN | 定数 |
public static const KEY_DOWN:String = "keyDown"
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | AIR 1.0, Flash Player 9, Flash Lite 4 |
KeyboardEvent.KEY_DOWN
定数は、keyDown
イベントオブジェクトの type
プロパティの値を定義します。
このイベントには、次のプロパティがあります。
プロパティ | 値 |
---|---|
bubbles | true |
cancelable | AIR の場合は true 、Flash Player の場合は false です。このイベントをキャンセルすると、テキストフィールドに文字が入力されなくなります。 |
charCode | 押したキーまたは離したキーの文字コード値です。 |
commandKey | Mac では Command キーがアクティブになっている場合は true です。それ以外の場合は、false を返します。 |
controlKey | Windows および Linux では Ctrl キーがアクティブになっている場合は、true です。Mac では Control キーがアクティブになっている場合は true です。それ以外の場合は、false を返します。 |
ctrlKey | Windows および Linux では Ctrl キーがアクティブになっている場合は、true です。Macintosh では Ctrl キーまたは Command キーがアクティブになっている場合は、true です。それ以外の場合は false です。 |
currentTarget | イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。 |
keyCode | 押したキーまたは離したキーのキーコード値です。 |
keyLocation | キーボードのキーの場所です。 |
shiftKey | Shift キーがアクティブになっている場合は true 、非アクティブになっている場合は false です。 |
target | フォーカスを持っている InteractiveObject インスタンスです。target は、必ずしもイベントリスナーを登録した表示リスト内のオブジェクトとは限りません。現在イベントを処理している表示リスト内のオブジェクトにアクセスするには、currentTarget プロパティを使用します。 |
関連する API エレメント
KEY_UP | 定数 |
public static const KEY_UP:String = "keyUp"
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | AIR 1.0, Flash Player 9, Flash Lite 4 |
KeyboardEvent.KEY_UP
定数は、keyUp
イベントオブジェクトの type
プロパティの値を定義します。
このイベントには、次のプロパティがあります。
プロパティ | 値 |
---|---|
bubbles | true |
cancelable | false は、キャンセルするデフォルトの動作がないことを示します。 |
charCode | 押したキーまたは離したキーの文字コード値を含みます。 |
commandKey | Mac では Command キーがアクティブになっている場合は true です。それ以外の場合は、false を返します。 |
controlKey | Windows および Linux では Ctrl キーがアクティブになっている場合は、true です。Mac では Control キーがアクティブになっている場合は true です。それ以外の場合は、false を返します。 |
ctrlKey | Windows では Ctrl キーがアクティブになっている場合は、true です。Macintosh では Ctrl キーまたは Command キーがアクティブになっている場合は、true です。それ以外の場合は false です。 |
currentTarget | イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。 |
keyCode | 押したキーまたは離したキーのキーコード値です。 |
keyLocation | キーボードのキーの場所です。 |
shiftKey | Shift キーがアクティブになっている場合は true 、非アクティブになっている場合は false です。 |
target | フォーカスを持っている InteractiveObject インスタンスです。target は、必ずしもイベントリスナーを登録した表示リスト内のオブジェクトとは限りません。現在イベントを処理している表示リスト内のオブジェクトにアクセスするには、currentTarget プロパティを使用します。 |
関連する API エレメント
KeyboardEventExample
クラスを使用して、キーボードイベントとそのリスナー関数を表示する方法を示します。この例では、次の処理を実行します。
child
という名前の新しい Sprite インスタンスを作成します。- 四角形の背景色とサイズの設定に後で使用するプロパティを宣言します。
- Sprite のメソッドを使用して、
addChild()
メソッドを呼び出し、明るい青色の四角形を描画してステージ上のデフォルトの座標 (0,0) に表示します。 - 1 つのマウスイベントリスナーと 2 つのキーボード入力イベントリスナーを追加します。
click
/clickHandler
:四角形をクリックすると送出されます。キーボードイベントをリッスンできるように、child
スプライトにフォーカスを設定します。keyDown
/keyDownHandler
:任意のキーを押したときに送出されます。このサブスクライバメソッドは、trace()
ステートメントを使用して、イベントに関する情報を出力します。keyUp
/keyUpHandler
:キーを離すと送出されます。
この例をテストするときは、最初に四角形をクリックしてキーボードイベントを有効にする必要があります。
また、Flash の「ムービーのテスト」コマンドを使用する場合は、child スプライトに関連付けられたイベントリスナーではなく特定のキーにオーサリングインターフェイスが反応することがあります。
package { import flash.display.Sprite; import flash.display.DisplayObject; import flash.events.*; public class KeyboardEventExample extends Sprite { private var child:Sprite = new Sprite(); private var bgColor:uint = 0x00CCFF; private var size:uint = 80; public function KeyboardEventExample() { child.graphics.beginFill(bgColor); child.graphics.drawRect(0, 0, size, size); child.graphics.endFill(); addChild(child); child.addEventListener(MouseEvent.CLICK, clickHandler); child.addEventListener(KeyboardEvent.KEY_DOWN, keyDownHandler); child.addEventListener(KeyboardEvent.KEY_UP, keyUpHandler); } private function clickHandler(event:MouseEvent):void { stage.focus = child; } private function keyDownHandler(event:KeyboardEvent):void { trace("keyDownHandler: " + event.keyCode); trace("ctrlKey: " + event.ctrlKey); trace("keyLocation: " + event.keyLocation); trace("shiftKey: " + event.shiftKey); trace("altKey: " + event.altKey); } private function keyUpHandler(event:KeyboardEvent):void { trace("keyUpHandler: " + event.keyCode); } } }
Tue Jun 12 2018, 10:34 AM Z