class flash.events.KeyboardEvent extends Event

Available on all platforms

A KeyboardEvent object id dispatched in response to user input through a * keyboard. There are two types of keyboard events: * KeyboardEvent.KEYDOWN and KeyboardEvent.KEYUP *

Because mappings between keys and specific characters vary by device and * operating system, use the TextEvent event type for processing character * input.

*

To listen globally for key events, listen on the Stage for the capture * and target or bubble phase.

Class Fields

static var KEY_DOWN:String

The KeyboardEvent.KEY_DOWN constant defines the value of the * type property of a keyDown event object. * *

This event has the following properties:

static var KEY_UP:String

The KeyboardEvent.KEY_UP constant defines the value of the * type property of a keyUp event object. * *

This event has the following properties:

Instance Fields

var altKey:Bool

Indicates whether the Alt key is active(true) or inactive * (false) on Windows; indicates whether the Option key is * active on Mac OS.

var charCode:UInt

Contains the character code value of the key pressed or released. The * character code values are English keyboard values. For example, if you * press Shift+3, charCode is # on a Japanese keyboard, just as * it is on an English keyboard. * *

Note: When an input method editor(IME) is running, * charCode does not report accurate character codes.

var ctrlKey:Bool

On Windows and Linux, indicates whether the Ctrl key is active * (true) or inactive(false); On Mac OS, indicates * whether either the Ctrl key or the Command key is active.

var keyCode:UInt

The key code value of the key pressed or released. * *

Note: When an input method editor(IME) is running, * keyCode does not report accurate key codes.

var keyLocation:KeyLocation

Indicates the location of the key on the keyboard. This is useful for * differentiating keys that appear more than once on a keyboard. For * example, you can differentiate between the left and right Shift keys by * the value of this property: KeyLocation.LEFT for the left and * KeyLocation.RIGHT for the right. Another example is * differentiating between number keys pressed on the standard keyboard * (KeyLocation.STANDARD) versus the numeric keypad * (KeyLocation.NUM_PAD).

var shiftKey:Bool

Indicates whether the Shift key modifier is active(true) or * inactive(false).

function new(type:String, ?bubbles:Bool, ?cancelable:Bool, ?charCodeValue:UInt, ?keyCodeValue:UInt, ?keyLocationValue:KeyLocation, ?ctrlKeyValue:Bool, ?altKeyValue:Bool, ?shiftKeyValue:Bool):Void

Creates an Event object that contains specific information about keyboard * events. Event objects are passed as parameters to event listeners. * *

type

The type of the event. Possible values are: * KeyboardEvent.KEYDOWN and * KeyboardEvent.KEYUP *

bubbles

Determines whether the Event object participates * in the bubbling stage of the event flow. *

cancelable

Determines whether the Event object can be * canceled. *

charCodeValue

The character code value of the key pressed or * released. The character code values returned are * English keyboard values. For example, if you press * Shift+3, the Keyboard.charCode() * property returns # on a Japanese keyboard, just as * it does on an English keyboard. *

keyCodeValue

The key code value of the key pressed or released. *

keyLocationValue

The location of the key on the keyboard. *

ctrlKeyValue

On Windows, indicates whether the Ctrl key is * activated. On Mac, indicates whether either the * Ctrl key or the Command key is activated. *

altKeyValue

Indicates whether the Alt key modifier is * activated(Windows only). *

shiftKeyValue

Indicates whether the Shift key modifier is * activated.

function updateAfterEvent():Void

Indicates that the display should be rendered after processing of this * event completes, if the display list has been modified