パッケージflash.events
クラスpublic class KeyboardEvent
継承KeyboardEvent Inheritance Event Inheritance Object

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9

Flash® Player は、キーボードからのユーザー入力に対して KeyboardEvent オブジェクトを送出します。次の 2 種類のキーボードイベントがあります。KeyboardEvent.KEY_DOWN および KeyboardEvent.KEY_UP

キーと特定の文字のマッピングはデバイスやオペレーティングシステムごとに異なるため、入力された文字の処理には TextEvent イベントタイプを使用してください。

キーイベントをグローバルにリスニングするには、キャプチャ段階、ターゲット段階またはバブリング段階についてステージでリスニングします。

例を表示

関連項目

KEY_DOWN
KEY_UP
KeyLocation


パブリック プロパティ
 プロパティ定義元
  altKey : Boolean
Alt キーがアクティブになっているか (true) 非アクティブになっているか (false) を示します。
KeyboardEvent
 Inheritedbubbles : Boolean
[read-only] イベントがバブリングイベントかどうかを示します。
Event
 Inheritedcancelable : Boolean
[read-only] イベントに関連付けられた動作を回避できるかどうかを示します。
Event
  charCode : uint
押したキーまたは離したキーの文字コード値を含みます。
KeyboardEvent
 Inheritedconstructor : Object
特定のオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
  ctrlKey : Boolean
Ctrl キーがアクティブになっているか (true) 非アクティブになっているか (false) を示します。
KeyboardEvent
 InheritedcurrentTarget : Object
[read-only] イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
Event
 InheritedeventPhase : uint
[read-only] イベントフローの現在の段階です。
Event
  keyCode : uint
押したキーまたは離したキーのキーコード値です。
KeyboardEvent
  keyLocation : uint
キーボードのキーの場所を示します。
KeyboardEvent
 Inheritedprototype : Object
[static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
  shiftKey : Boolean
Shift キーモディファイアがアクティブになっているか (true) 非アクティブになっているか (false) を示します。
KeyboardEvent
 Inheritedtarget : Object
[read-only] イベントターゲットです。
Event
 Inheritedtype : String
[read-only] イベントのタイプです。
Event
パブリック メソッド
 メソッド定義元
  
KeyboardEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false, charCode:uint = 0, keyCode:uint = 0, keyLocation:uint = 0, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false)
キーボードイベントに関する特定の情報を含む Event オブジェクトを作成します。
KeyboardEvent
  
KeyboardEvent オブジェクトのコピーを作成して、各プロパティの値を元のプロパティの値と一致するように設定します。
KeyboardEvent
 Inherited
formatToString(className:String, ... arguments):String
カスタム Event クラスに toString() メソッドを実装するためのユーティリティ関数です。
Event
 Inherited
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 Inherited
イベントで preventDefault() が呼び出されたかどうかを確認します。
Event
 Inherited
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 Inherited
イベントのデフォルトの動作をキャンセルできる場合に、その動作をキャンセルします。
Event
 Inherited
指定されたプロパティが存在し列挙できるかどうかを示します。
Object
 Inherited
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 Inherited
イベントフローの現在のノードおよび後続するノードで、イベントリスナーが処理されないようにします。
Event
 Inherited
イベントフローの現在のノードに後続するノードで、イベントリスナーが処理されないようにします。
Event
  
KeyboardEvent オブジェクトのすべてのプロパティを含むストリングを返します。
KeyboardEvent
  
表示リストが変更されている場合は、このイベントの処理が終了した後でレンダリングするよう Flash Player に指示します。
KeyboardEvent
 Inherited
指定されたオブジェクトのプリミティブな値を返します。
Object
パブリック 定数
 定数定義元
 InheritedACTIVATE : String = "activate"
[static] activate イベントオブジェクトの type プロパティ値を定義します。
Event
 InheritedADDED : String = "added"
[static] added イベントオブジェクトの type プロパティ値を定義します。
Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] addedToStage イベントオブジェクトの type プロパティ値を定義します。
Event
 InheritedCANCEL : String = "cancel"
[static] cancel イベントオブジェクトの type プロパティ値を定義します。
Event
 InheritedCHANGE : String = "change"
[static] change イベントオブジェクトの type プロパティ値を定義します。
Event
 InheritedCLOSE : String = "close"
[static] close イベントオブジェクトの type プロパティ値を定義します。
Event
 InheritedCOMPLETE : String = "complete"
[static] complete イベントオブジェクトの type プロパティ値を定義します。
Event
 InheritedCONNECT : String = "connect"
[static] connect イベントオブジェクトの type プロパティ値を定義します。
Event
 InheritedDEACTIVATE : String = "deactivate"
[static] deactivate イベントオブジェクトの type プロパティ値を定義します。
Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] enterFrame イベントオブジェクトの type プロパティ値を定義します。
Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] fullScreen イベントオブジェクトの type プロパティ値を定義します。
Event
 InheritedID3 : String = "id3"
[static] id3 イベントオブジェクトの type プロパティ値を定義します。
Event
 InheritedINIT : String = "init"
[static] init イベントオブジェクトの type プロパティの値を定義します。
Event
  KEY_DOWN : String = "keyDown"
[static] keyDown イベントオブジェクトの type プロパティ値を定義します。
KeyboardEvent
  KEY_UP : String = "keyUp"
[static] keyUp イベントオブジェクトの type プロパティ値を定義します。
KeyboardEvent
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] mouseLeave イベントオブジェクトの type プロパティ値を定義します。
Event
 InheritedOPEN : String = "open"
[static] open イベントオブジェクトの type プロパティ値を定義します。
Event
 InheritedREMOVED : String = "removed"
[static] removed イベントオブジェクトの type プロパティ値を定義します。
Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] removedFromStage イベントオブジェクトの type プロパティ値を定義します。
Event
 InheritedRENDER : String = "render"
[static] render イベントオブジェクトの type プロパティ値を定義します。
Event
 InheritedRESIZE : String = "resize"
[static] resize イベントオブジェクトの type プロパティ値を定義します。
Event
 InheritedSCROLL : String = "scroll"
[static] scroll イベントオブジェクトの type プロパティ値を定義します。
Event
 InheritedSELECT : String = "select"
[static] select イベントオブジェクトの type プロパティ値を定義します。
Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] soundComplete イベントオブジェクトの type プロパティ値を定義します。
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] tabChildrenChange イベントオブジェクトの type プロパティ値を定義します。
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] tabEnabledChange イベントオブジェクトの type プロパティ値を定義します。
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] tabIndexChange イベントオブジェクトの type プロパティ値を定義します。
Event
 InheritedUNLOAD : String = "unload"
[static] unload イベントオブジェクトの type プロパティ値を定義します。
Event
プロパティの詳細
altKeyプロパティ
altKey:Boolean  [read-write]

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9

Alt キーがアクティブになっているか (true) 非アクティブになっているか (false) を示します。Windows オペレーティングシステムでのみサポートされます。


実装
    public function get altKey():Boolean
    public function set altKey(value:Boolean):void
charCodeプロパティ 
charCode:uint  [read-write]

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9

押したキーまたは離したキーの文字コード値を含みます。文字コード値は英語キーボードの値です。たとえば、Shift + 3 が押されると、charCode は日本語のキーボードでも英語のキーボードと同じように # を返します。

メモ :IME が実行されているときは、charCode では正確な文字コードが報告されません。


実装
    public function get charCode():uint
    public function set charCode(value:uint):void

関連項目

ctrlKeyプロパティ 
ctrlKey:Boolean  [read-write]

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9

Ctrl キーがアクティブになっているか (true) 非アクティブになっているか (false) を示します。

メモ :Macintosh システムの Command キーモディファイアは、このキーモディファイアを使用して表す必要があります。


実装
    public function get ctrlKey():Boolean
    public function set ctrlKey(value:Boolean):void
keyCodeプロパティ 
keyCode:uint  [read-write]

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9

押したキーまたは離したキーのキーコード値です。

メモ :IME が実行されているときは、keyCode では正確なキーコードが報告されません。


実装
    public function get keyCode():uint
    public function set keyCode(value:uint):void

関連項目

keyLocationプロパティ 
keyLocation:uint  [read-write]

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9

キーボードのキーの場所を示します。これは、キーボードに複数あるキーを区別するときに役立ちます。たとえば、左の Shift キーと右の Shift キーをこのプロパティの値で区別できます。左は KeyLocation.LEFT、右は KeyLocation.RIGHT です。また、標準キーボードの数字キー (KeyLocation.STANDARD) とテンキーの数字キー (KeyLocation.NUM_PAD) のどちらが押されたかを区別することもできます。


実装
    public function get keyLocation():uint
    public function set keyLocation(value:uint):void
shiftKeyプロパティ 
shiftKey:Boolean  [read-write]

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9

Shift キーモディファイアがアクティブになっているか (true) 非アクティブになっているか (false) を示します。


実装
    public function get shiftKey():Boolean
    public function set shiftKey(value:Boolean):void
コンストラクタの詳細
KeyboardEvent()コンストラクタ
public function KeyboardEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false, charCode:uint = 0, keyCode:uint = 0, keyLocation:uint = 0, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false)

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9

キーボードイベントに関する特定の情報を含む Event オブジェクトを作成します。イベントリスナーには Event オブジェクトがパラメータとして渡されます。

パラメータ
type:String — イベントのタイプです。有効な値は次のとおりです。KeyboardEvent.KEY_DOWN および KeyboardEvent.KEY_UP
 
bubbles:Boolean (default = true) — Event オブジェクトがイベントフローのバブリング段階で処理されるかどうかを判断します。
 
cancelable:Boolean (default = false) — Event オブジェクトがキャンセル可能かどうかを判断します。
 
charCode:uint (default = 0) — 押したキーまたは離したキーの文字コード値です。文字コードの戻り値は英語キーボードの値です。たとえば、Shift + 3 が押されると、getASCIICode() メソッドは日本語のキーボードでも英語のキーボードと同じように # を返します。
 
keyCode:uint (default = 0) — 押したキーまたは離したキーのキーコード値です。
 
keyLocation:uint (default = 0) — キーボードのキーの場所です。
 
ctrlKey:Boolean (default = false) — Ctrl キーモディファイアがアクティブになっているかどうかを示します。
 
altKey:Boolean (default = false) — Alt キーモディファイアがアクティブになっているかどうかを示します (Windows のみ)。
 
shiftKey:Boolean (default = false) — Shift キーモディファイアがアクティブになっているかどうかを示します。

関連項目

メソッドの詳細
clone()メソッド
public override function clone():Event

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9

KeyboardEvent オブジェクトのコピーを作成して、各プロパティの値を元のプロパティの値と一致するように設定します。

戻り値
Event — 元のオブジェクトと同じプロパティ値を含む新しい KeyboardEvent オブジェクトです。
toString()メソッド 
public override function toString():String

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9

KeyboardEvent オブジェクトのすべてのプロパティを含むストリングを返します。ストリングは次の形式です。

[KeyboardEvent type= value bubbles= value cancelable= value ... shiftKey= value ]

戻り値
String — KeyboardEvent オブジェクトのすべてのプロパティを含むストリングです。
updateAfterEvent()メソッド 
public function updateAfterEvent():void

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9

表示リストが変更されている場合は、このイベントの処理が終了した後でレンダリングするよう Flash Player に指示します。

定数の詳細
KEY_DOWN定数
public static const KEY_DOWN:String = "keyDown"

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9

type プロパティ (keyDown イベントオブジェクト) の値を定義します。

このイベントには、次のプロパティがあります。

プロパティ
bubblestrue
cancelablefalse は、キャンセルするデフォルトの動作がないことを示します。
charCode押したキーまたは離したキーの文字コード値です。
ctrlKeyCtrl キーがアクティブになっている場合は true、非アクティブになっている場合は false です。
currentTargetイベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
keyCode押したキーまたは離したキーのキーコード値です。
keyLocationキーボードのキーの場所です。
shiftKeyShift キーがアクティブになっている場合は true、非アクティブになっている場合は false です。
targetフォーカスを持っている InteractiveObject インスタンスです。target は、必ずしもイベントリスナーを登録した表示リスト内のオブジェクトとは限りません。現在イベントを処理している表示リスト内のオブジェクトにアクセスするには、currentTarget プロパティを使用します。

関連項目

KEY_UP定数 
public static const KEY_UP:String = "keyUp"

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9

type プロパティ (keyUp イベントオブジェクト) の値を定義します。

このイベントには、次のプロパティがあります。

プロパティ
bubblestrue
cancelablefalse は、キャンセルするデフォルトの動作がないことを示します。
charCode押したキーまたは離したキーの文字コード値を含みます。
ctrlKeyCtrl キーがアクティブになっている場合は true、非アクティブになっている場合は false です。
currentTargetイベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
keyCode押したキーまたは離したキーのキーコード値です。
keyLocationキーボードのキーの場所です。
shiftKeyShift キーがアクティブになっている場合は true、非アクティブになっている場合は false です。
targetフォーカスを持っている InteractiveObject インスタンスです。target は、必ずしもイベントリスナーを登録した表示リスト内のオブジェクトとは限りません。現在イベントを処理している表示リスト内のオブジェクトにアクセスするには、currentTarget プロパティを使用します。

関連項目

例の使用法
KeyboardEventExample.as

次の例では、KeyboardEventExample クラスを使用して、キーボードイベントとそのリスナー関数を表示する方法を示します。この例では、次の処理を実行します。
  1. 四角形の背景色とサイズの設定に後で使用するプロパティを宣言します。
  2. child という名前の新しい Sprite インスタンスを作成します。
  3. Sprite のメソッドを使用して、addChild() メソッドを呼び出し、明るい青色の四角形を描画してステージ上のデフォルトの座標 (0,0) に表示します。
  4. 次の 2 つのキーボードタイプのイベントリスナーを追加します。
    • keyDown / keyDownHandler : 任意のキーを押したときに送出されます。このサブスクライバメソッドは、trace() ステートメントを使用して、イベントに関する情報を出力します。
    • keyUp/keyUpHandler : キーを離すと送出されます。

一部のインスタンスでは、ステージをクリックしないと、キーボードイベントが実行されない場合があります。

package {
    import flash.display.Sprite;
    import flash.display.DisplayObject;
    import flash.events.*;

    public class KeyboardEventExample extends Sprite {
        private var bgColor:uint = 0x00CCFF;
        private var size:uint = 80;

        public function KeyboardEventExample() {
            var child:Sprite = new Sprite();
            child.graphics.beginFill(bgColor);
            child.graphics.drawRect(0, 0, size, size);
            child.graphics.endFill();
            addChild(child);
            stage.focus = child;
            child.addEventListener(KeyboardEvent.KEY_DOWN, keyDownHandler);
            child.addEventListener(KeyboardEvent.KEY_UP, keyUpHandler);
        }

        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);
        }
    }
}




 

このページに新しいコメントが追加された場合に、電子メールでの通知を希望する。 | コメントレポート

現在のページ: http://livedocs.adobe.com/flash/9.0_jp/ActionScriptLangRefV3/flash/events/KeyboardEvent.html