| Package | flash.events |
| Class | public class KeyboardEvent |
| Inheritance | KeyboardEvent Event Object |
| Language Version : | ActionScript 3.0 |
| Player Version : | Flash Player 9 |
KeyboardEvent.KEY_DOWN and
KeyboardEvent.KEY_UP
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.
See also
| Property | Defined By | ||
|---|---|---|---|
| altKey : Boolean
Indicates whether the Alt key is active (true) or inactive (false).
| KeyboardEvent | ||
![]() | bubbles : Boolean
[read-only]
Indicates whether an event is a bubbling event.
| Event | |
![]() | cancelable : Boolean
[read-only]
Indicates whether the behavior associated with the event can be prevented.
| Event | |
| charCode : uint
Contains the character code value of the key pressed or released.
| KeyboardEvent | ||
![]() | constructor : Object
A reference to the class object or constructor function for a given object instance.
| Object | |
| ctrlKey : Boolean
Indicates whether the Control key is active (true) or inactive
(false).
| KeyboardEvent | ||
![]() | currentTarget : Object
[read-only]
The object that is actively processing the Event object with an event listener.
| Event | |
![]() | eventPhase : uint
[read-only]
The current phase in the event flow.
| Event | |
| keyCode : uint
The key code value of the key pressed or released.
| KeyboardEvent | ||
| keyLocation : uint
Indicates the location of the key on the keyboard.
| KeyboardEvent | ||
![]() | prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
| shiftKey : Boolean
Indicates whether the Shift key modifier is active (true) or inactive
(false).
| KeyboardEvent | ||
![]() | target : Object
[read-only]
The event target.
| Event | |
![]() | type : String
[read-only]
The type of event.
| Event | |
| Method | Defined By | ||
|---|---|---|---|
|
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)
Creates an Event object that contains specific information about keyboard events.
| KeyboardEvent | ||
|
Creates a copy of the KeyboardEvent object and sets the value of each property to match that of the original.
| KeyboardEvent | ||
![]() |
A utility function for implementing the
toString() method in your custom Event class.
| Event | |
![]() |
Indicates whether an object has a specified property defined.
| Object | |
![]() |
Checks whether preventDefault() has been called on the event.
| Event | |
![]() |
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter.
| Object | |
![]() |
Cancels an event's default behavior if that behavior can be canceled.
| Event | |
![]() |
Indicates whether the specified property exists and is enumerable.
| Object | |
![]() |
Sets the availability of a dynamic property for loop operations.
| Object | |
![]() |
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow.
| Event | |
![]() |
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow.
| Event | |
|
Returns a string that contains all the properties of the KeyboardEvent object.
| KeyboardEvent | ||
|
Instructs Flash Player to render after processing of this event completes, if the display
list has been modified
| KeyboardEvent | ||
![]() |
Returns the primitive value of the specified object.
| Object | |
| Constant | Defined By | ||
|---|---|---|---|
![]() | ACTIVATE : String = "activate" [static]
Defines the value of the type property of an activate event object.
| Event | |
![]() | ADDED : String = "added" [static]
Defines the value of the type property of an added event object.
| Event | |
![]() | ADDED_TO_STAGE : String = "addedToStage" [static]
Defines the value of the type property of an addedToStage event object.
| Event | |
![]() | CANCEL : String = "cancel" [static]
Defines the value of the type property of a cancel event object.
| Event | |
![]() | CHANGE : String = "change" [static]
Defines the value of the type property of a change event object.
| Event | |
![]() | CLOSE : String = "close" [static]
Defines the value of the type property of a close event object.
| Event | |
![]() | COMPLETE : String = "complete" [static]
Defines the value of the type property of a complete event object.
| Event | |
![]() | CONNECT : String = "connect" [static]
Defines the value of the type property of a connect event object.
| Event | |
![]() | DEACTIVATE : String = "deactivate" [static]
Defines the value of the type property of a deactivate event object.
| Event | |
![]() | ENTER_FRAME : String = "enterFrame" [static]
Defines the value of the type property of an enterFrame event object.
| Event | |
![]() | FULLSCREEN : String = "fullScreen" [static]
Defines the value of the type property of a fullScreen event object.
| Event | |
![]() | ID3 : String = "id3" [static]
Defines the value of the type property of an id3 event object.
| Event | |
![]() | INIT : String = "init" [static]
Defines the value of the type property of an init event object.
| Event | |
| KEY_DOWN : String = "keyDown" [static]
Defines the value of the type property of a keyDown event object.
| KeyboardEvent | ||
| KEY_UP : String = "keyUp" [static]
Defines the value of the type property of a keyUp event object.
| KeyboardEvent | ||
![]() | MOUSE_LEAVE : String = "mouseLeave" [static]
Defines the value of the type property of a mouseLeave event object.
| Event | |
![]() | OPEN : String = "open" [static]
Defines the value of the type property of an open event object.
| Event | |
![]() | REMOVED : String = "removed" [static]
Defines the value of the type property of a removed event object.
| Event | |
![]() | REMOVED_FROM_STAGE : String = "removedFromStage" [static]
Defines the value of the type property of a removedFromStage event object.
| Event | |
![]() | RENDER : String = "render" [static]
Defines the value of the type property of a render event object.
| Event | |
![]() | RESIZE : String = "resize" [static]
Defines the value of the type property of a resize event object.
| Event | |
![]() | SCROLL : String = "scroll" [static]
Defines the value of the type property of a scroll event object.
| Event | |
![]() | SELECT : String = "select" [static]
Defines the value of the type property of a select event object.
| Event | |
![]() | SOUND_COMPLETE : String = "soundComplete" [static]
Defines the value of the type property of a soundComplete event object.
| Event | |
![]() | TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static]
Defines the value of the type property of a tabChildrenChange event object.
| Event | |
![]() | TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static]
Defines the value of the type property of a tabEnabledChange event object.
| Event | |
![]() | TAB_INDEX_CHANGE : String = "tabIndexChange" [static]
Defines the value of the type property of a tabIndexChange event object.
| Event | |
![]() | UNLOAD : String = "unload" [static]
Defines the value of the type property of an unload event object.
| Event | |
| altKey | property |
altKey:Boolean [read-write]
| Language Version : | ActionScript 3.0 |
| Player Version : | Flash Player 9 |
Indicates whether the Alt key is active (true) or inactive (false).
Supported for Windows operating systems only.
public function get altKey():Boolean
public function set altKey(value:Boolean):void
| charCode | property |
charCode:uint [read-write]
| Language Version : | ActionScript 3.0 |
| Player Version : | Flash Player 9 |
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.
public function get charCode():uint
public function set charCode(value:uint):void
See also
| ctrlKey | property |
ctrlKey:Boolean [read-write]
| Language Version : | ActionScript 3.0 |
| Player Version : | Flash Player 9 |
Indicates whether the Control key is active (true) or inactive
(false).
Note: The Command key modifier on Macintosh systems must be represented using this key modifier.
public function get ctrlKey():Boolean
public function set ctrlKey(value:Boolean):void
| keyCode | property |
keyCode:uint [read-write]
| Language Version : | ActionScript 3.0 |
| Player Version : | Flash Player 9 |
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.
public function get keyCode():uint
public function set keyCode(value:uint):void
See also
| keyLocation | property |
keyLocation:uint [read-write]
| Language Version : | ActionScript 3.0 |
| Player Version : | Flash Player 9 |
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).
public function get keyLocation():uint
public function set keyLocation(value:uint):void
| shiftKey | property |
shiftKey:Boolean [read-write]
| Language Version : | ActionScript 3.0 |
| Player Version : | Flash Player 9 |
Indicates whether the Shift key modifier is active (true) or inactive
(false).
public function get shiftKey():Boolean
public function set shiftKey(value:Boolean):void
| KeyboardEvent | () | Constructor |
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)
| Language Version : | ActionScript 3.0 |
| Player Version : | Flash Player 9 |
Creates an Event object that contains specific information about keyboard events. Event objects are passed as parameters to event listeners.
Parameterstype:String — The type of the event. Possible values are:
KeyboardEvent.KEY_DOWN and KeyboardEvent.KEY_UP
|
|
bubbles:Boolean (default = true) — Determines whether the Event object participates in the bubbling stage of the event flow.
|
|
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled.
|
|
charCode:uint (default = 0) — 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 getASCIICode() method returns # on a Japanese keyboard, just as it does on an English keyboard.
|
|
keyCode:uint (default = 0) — The key code value of the key pressed or released.
|
|
keyLocation:uint (default = 0) — The location of the key on the keyboard.
|
|
ctrlKey:Boolean (default = false) — Indicates whether the Control key modifier is activated.
|
|
altKey:Boolean (default = false) — Indicates whether the Alt key modifier is activated (Windows only).
|
|
shiftKey:Boolean (default = false) — Indicates whether the Shift key modifier is activated.
|
See also
| clone | () | method |
public override function clone():Event
| Language Version : | ActionScript 3.0 |
| Player Version : | Flash Player 9 |
Creates a copy of the KeyboardEvent object and sets the value of each property to match that of the original.
ReturnsEvent — A new KeyboardEvent object with property values that match those of the original.
|
| toString | () | method |
public override function toString():String
| Language Version : | ActionScript 3.0 |
| Player Version : | Flash Player 9 |
Returns a string that contains all the properties of the KeyboardEvent object. The string is in the following format:
[KeyboardEvent type=value bubbles=value cancelable=value ... shiftKey=value]
String — A string that contains all the properties of the KeyboardEvent object.
|
| updateAfterEvent | () | method |
public function updateAfterEvent():void
| Language Version : | ActionScript 3.0 |
| Player Version : | Flash Player 9 |
Instructs Flash Player to render after processing of this event completes, if the display list has been modified
| KEY_DOWN | Constant |
public static const KEY_DOWN:String = "keyDown"
| Language Version : | ActionScript 3.0 |
| Player Version : | Flash Player 9 |
Defines the value of the type property of a keyDown event object.
This event has the following properties:
| Property | Value |
|---|---|
bubbles | true |
cancelable | false; there is no default behavior to cancel. |
charCode | The character code value of the key pressed or released. |
ctrlKey | true if the Control key is active; false if it is inactive. |
currentTarget | The object that is actively processing the Event object with an event listener. |
keyCode | The key code value of the key pressed or released. |
keyLocation | The location of the key on the keyboard. |
shiftKey | true if the Shift key is active; false if it is inactive. |
target | The InteractiveObject instance with focus.
The target is not always the object in the display list
that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event. |
See also
| KEY_UP | Constant |
public static const KEY_UP:String = "keyUp"
| Language Version : | ActionScript 3.0 |
| Player Version : | Flash Player 9 |
Defines the value of the type property of a keyUp event object.
This event has the following properties:
| Property | Value |
|---|---|
bubbles | true |
cancelable | false; there is no default behavior to cancel. |
charCode | Contains the character code value of the key pressed or released. |
ctrlKey | true if the Control key is active; false if it is inactive. |
currentTarget | The object that is actively processing the Event object with an event listener. |
keyCode | The key code value of the key pressed or released. |
keyLocation | The location of the key on the keyboard. |
shiftKey | true if the Shift key is active; false if it is inactive. |
target | The InteractiveObject instance with focus.
The target is not always the object in the display list
that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event. |
See also
KeyboardEventExample class to show
keyboard events and their listener functions. The example carries out the following tasks:
child.addChild() method.click/clickHandler which is dispatched when you click on the square to set focus on the child sprite so it can listen for keyboard events.keyDown/keyDownHandler which is dispatched whenever any key is pressed. The subscriber method prints information about the event
using the trace() statement.keyUp/keyUpHandler which is dispatched when a key is
released.When you test this example, you need to click the square first for the keyboard events to work.
Also, if you are using the Test Movie command in Flash, the authoring interface may respond to certain keys instead of the event listeners attached to the child sprite.
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);
}
}
}