ActionScript 3.0 Language and Components Reference | All Packages | All Classes | Language Elements | Index | Appendixes | Conventions | Frames No Frames |
Keyboard

Package | flash.ui
Class | public final class Keyboard
Inheritance | Keyboard Object

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

The Keyboard class is used to build an interface that can be controlled by a user with a standard keyboard. You can use the methods and properties of the Keyboard class without using a constructor. The properties of the Keyboard class are constants representing the keys that are most commonly used to control games.

See also

Capturing keyboard input

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | capsLock : Boolean [static] [read-only] Specifies whether the Caps Lock key is activated (true) or not (false). | Keyboard
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | numLock : Boolean [static] [read-only] Specifies whether the Num Lock key is activated (true) or not (false). | Keyboard
|  | prototype : Object [static] A reference to the prototype object of a class or function object. | Object

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isAccessible():Boolean [static] Specifies whether the last key pressed is accessible by other SWF files. | Keyboard
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | toString():String Returns the string representation of the specified object. | Object
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants

| Constant | Defined By
--- | --- | ---
|  | BACKSPACE : uint = 8 [static] Constant associated with the key code value for the Backspace key (8). | Keyboard
|  | CAPS_LOCK : uint = 20 [static] Constant associated with the key code value for the Caps Lock key (20). | Keyboard
|  | CONTROL : uint = 17 [static] Constant associated with the key code value for the Control key (17). | Keyboard
|  | DELETE : uint = 46 [static] Constant associated with the key code value for the Delete key (46). | Keyboard
|  | DOWN : uint = 40 [static] Constant associated with the key code value for the Down Arrow key (40). | Keyboard
|  | END : uint = 35 [static] Constant associated with the key code value for the End key (35). | Keyboard
|  | ENTER : uint = 13 [static] Constant associated with the key code value for the Enter key (13). | Keyboard
|  | ESCAPE : uint = 27 [static] Constant associated with the key code value for the Escape key (27). | Keyboard
|  | F1 : uint = 112 [static] Constant associated with the key code value for the F1 key (112). | Keyboard
|  | F10 : uint = 121 [static] Constant associated with the key code value for the F10 key (121). | Keyboard
|  | F11 : uint = 122 [static] Constant associated with the key code value for the F11 key (122). | Keyboard
|  | F12 : uint = 123 [static] Constant associated with the key code value for the F12 key (123). | Keyboard
|  | F13 : uint = 124 [static] Constant associated with the key code value for the F13 key (124). | Keyboard
|  | F14 : uint = 125 [static] Constant associated with the key code value for the F14 key (125). | Keyboard
|  | F15 : uint = 126 [static] Constant associated with the key code value for the F15 key (126). | Keyboard
|  | F2 : uint = 113 [static] Constant associated with the key code value for the F2 key (113). | Keyboard
|  | F3 : uint = 114 [static] Constant associated with the key code value for the F3 key (114). | Keyboard
|  | F4 : uint = 115 [static] Constant associated with the key code value for the F4 key (115). | Keyboard
|  | F5 : uint = 116 [static] Constant associated with the key code value for the F5 key (116). | Keyboard
|  | F6 : uint = 117 [static] Constant associated with the key code value for the F6 key (117). | Keyboard
|  | F7 : uint = 118 [static] Constant associated with the key code value for the F7 key (118). | Keyboard
|  | F8 : uint = 119 [static] Constant associated with the key code value for the F8 key (119). | Keyboard
|  | F9 : uint = 120 [static] Constant associated with the key code value for the F9 key (120). | Keyboard
|  | HOME : uint = 36 [static] Constant associated with the key code value for the Home key (36). | Keyboard
|  | INSERT : uint = 45 [static] Constant associated with the key code value for the Insert key (45). | Keyboard
|  | LEFT : uint = 37 [static] Constant associated with the key code value for the Left Arrow key (37). | Keyboard
|  | NUMPAD_0 : uint = 96 [static] Constant associated with the key code value for the number 0 key on the number pad (96). | Keyboard
|  | NUMPAD_1 : uint = 97 [static] Constant associated with the key code value for the number 1 key on the number pad (97). | Keyboard
|  | NUMPAD_2 : uint = 98 [static] Constant associated with the key code value for the number 2 key on the number pad (98). | Keyboard
|  | NUMPAD_3 : uint = 99 [static] Constant associated with the key code value for the number 3 key on the number pad (99). | Keyboard
|  | NUMPAD_4 : uint = 100 [static] Constant associated with the key code value for the number 4 key on the number pad (100). | Keyboard
|  | NUMPAD_5 : uint = 101 [static] Constant associated with the key code value for the number 5 key on the number pad (101). | Keyboard
|  | NUMPAD_6 : uint = 102 [static] Constant associated with the key code value for the number 6 key on the number pad (102). | Keyboard
|  | NUMPAD_7 : uint = 103 [static] Constant associated with the key code value for the number 7 key on the number pad (103). | Keyboard
|  | NUMPAD_8 : uint = 104 [static] Constant associated with the key code value for the number 8 key on the number pad (104). | Keyboard
|  | NUMPAD_9 : uint = 105 [static] Constant associated with the key code value for the number 9 key on the number pad (105). | Keyboard
|  | NUMPAD_ADD : uint = 107 [static] Constant associated with the key code value for the addition key on the number pad (107). | Keyboard
|  | NUMPAD_DECIMAL : uint = 110 [static] Constant associated with the key code value for the decimal key on the number pad (110). | Keyboard
|  | NUMPAD_DIVIDE : uint = 111 [static] Constant associated with the key code value for the division key on the number pad (111). | Keyboard
|  | NUMPAD_ENTER : uint = 108 [static] Constant associated with the key code value for the Enter key on the number pad (108). | Keyboard
|  | NUMPAD_MULTIPLY : uint = 106 [static] Constant associated with the key code value for the multiplication key on the number pad (106). | Keyboard
|  | NUMPAD_SUBTRACT : uint = 109 [static] Constant associated with the key code value for the subtraction key on the number pad (109). | Keyboard
|  | PAGE_DOWN : uint = 34 [static] Constant associated with the key code value for the Page Down key (34). | Keyboard
|  | PAGE_UP : uint = 33 [static] Constant associated with the key code value for the Page Up key (33). | Keyboard
|  | RIGHT : uint = 39 [static] Constant associated with the key code value for the Right Arrow key (39). | Keyboard
|  | SHIFT : uint = 16 [static] Constant associated with the key code value for the Shift key (16). | Keyboard
|  | SPACE : uint = 32 [static] Constant associated with the key code value for the Spacebar (32). | Keyboard
|  | TAB : uint = 9 [static] Constant associated with the key code value for the Tab key (9). | Keyboard
|  | UP : uint = 38 [static] Constant associated with the key code value for the Up Arrow key (38). | Keyboard

Property Detail

capsLock | property

`capsLock:Boolean` [read-only]

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Specifies whether the Caps Lock key is activated (`true`) or not (`false`).

Implementation
`public static function get capsLock():Boolean`

numLock | property |

`numLock:Boolean` [read-only]

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Specifies whether the Num Lock key is activated (`true`) or not (`false`).

Implementation
`public static function get numLock():Boolean`
Method Detail

isAccessible | () | method

`public static function isAccessible():Boolean`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Specifies whether the last key pressed is accessible by other SWF files. By default, security restrictions prevent code from a SWF file in one domain from accessing a keystroke generated from a SWF file in another domain.

Returns

| `Boolean` — The value `true` if the last key pressed can be accessed. If access is not permitted, this method returns `false`.

Constant Detail

BACKSPACE | Constant

`public static const BACKSPACE:uint = 8`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the Backspace key (8).

CAPS_LOCK | Constant |

`public static const CAPS_LOCK:uint = 20`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the Caps Lock key (20).

CONTROL | Constant |

`public static const CONTROL:uint = 17`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the Control key (17).

DELETE | Constant |

`public static const DELETE:uint = 46`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the Delete key (46).

DOWN | Constant |

`public static const DOWN:uint = 40`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the Down Arrow key (40).

END | Constant |

`public static const END:uint = 35`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the End key (35).

ENTER | Constant |

`public static const ENTER:uint = 13`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the Enter key (13).

ESCAPE | Constant |

`public static const ESCAPE:uint = 27`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the Escape key (27).

F1 | Constant |

`public static const F1:uint = 112`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the F1 key (112).

F10 | Constant |

`public static const F10:uint = 121`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the F10 key (121).

F11 | Constant |

`public static const F11:uint = 122`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the F11 key (122).

F12 | Constant |

`public static const F12:uint = 123`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the F12 key (123).

F13 | Constant |

`public static const F13:uint = 124`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the F13 key (124).

F14 | Constant |

`public static const F14:uint = 125`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the F14 key (125).

F15 | Constant |

`public static const F15:uint = 126`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the F15 key (126).

F2 | Constant |

`public static const F2:uint = 113`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the F2 key (113).

F3 | Constant |

`public static const F3:uint = 114`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the F3 key (114).

F4 | Constant |

`public static const F4:uint = 115`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the F4 key (115).

F5 | Constant |

`public static const F5:uint = 116`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the F5 key (116).

F6 | Constant |

`public static const F6:uint = 117`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the F6 key (117).

F7 | Constant |

`public static const F7:uint = 118`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the F7 key (118).

F8 | Constant |

`public static const F8:uint = 119`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the F8 key (119).

F9 | Constant |

`public static const F9:uint = 120`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the F9 key (120).

HOME | Constant |

`public static const HOME:uint = 36`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the Home key (36).

INSERT | Constant |

`public static const INSERT:uint = 45`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the Insert key (45).

LEFT | Constant |

`public static const LEFT:uint = 37`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the Left Arrow key (37).

NUMPAD_0 | Constant |

`public static const NUMPAD_0:uint = 96`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the number 0 key on the number pad (96).

NUMPAD_1 | Constant |

`public static const NUMPAD_1:uint = 97`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the number 1 key on the number pad (97).

NUMPAD_2 | Constant |

`public static const NUMPAD_2:uint = 98`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the number 2 key on the number pad (98).

NUMPAD_3 | Constant |

`public static const NUMPAD_3:uint = 99`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the number 3 key on the number pad (99).

NUMPAD_4 | Constant |

`public static const NUMPAD_4:uint = 100`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the number 4 key on the number pad (100).

NUMPAD_5 | Constant |

`public static const NUMPAD_5:uint = 101`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the number 5 key on the number pad (101).

NUMPAD_6 | Constant |

`public static const NUMPAD_6:uint = 102`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the number 6 key on the number pad (102).

NUMPAD_7 | Constant |

`public static const NUMPAD_7:uint = 103`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the number 7 key on the number pad (103).

NUMPAD_8 | Constant |

`public static const NUMPAD_8:uint = 104`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the number 8 key on the number pad (104).

NUMPAD_9 | Constant |

`public static const NUMPAD_9:uint = 105`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the number 9 key on the number pad (105).

NUMPAD_ADD | Constant |

`public static const NUMPAD_ADD:uint = 107`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the addition key on the number pad (107).

NUMPAD_DECIMAL | Constant |

`public static const NUMPAD_DECIMAL:uint = 110`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the decimal key on the number pad (110).

NUMPAD_DIVIDE | Constant |

`public static const NUMPAD_DIVIDE:uint = 111`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the division key on the number pad (111).

NUMPAD_ENTER | Constant |

`public static const NUMPAD_ENTER:uint = 108`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the Enter key on the number pad (108).

NUMPAD_MULTIPLY | Constant |

`public static const NUMPAD_MULTIPLY:uint = 106`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the multiplication key on the number pad (106).

NUMPAD_SUBTRACT | Constant |

`public static const NUMPAD_SUBTRACT:uint = 109`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the subtraction key on the number pad (109).

PAGE_DOWN | Constant |

`public static const PAGE_DOWN:uint = 34`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the Page Down key (34).

PAGE_UP | Constant |

`public static const PAGE_UP:uint = 33`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the Page Up key (33).

RIGHT | Constant |

`public static const RIGHT:uint = 39`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the Right Arrow key (39).

SHIFT | Constant |

`public static const SHIFT:uint = 16`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the Shift key (16).

SPACE | Constant |

`public static const SPACE:uint = 32`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the Spacebar (32).

TAB | Constant |

`public static const TAB:uint = 9`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the Tab key (9).

UP | Constant |

`public static const UP:uint = 38`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constant associated with the key code value for the Up Arrow key (38).

Submit Feedback on LiveDocs
© 2004-2008 Adobe Systems Incorporated. All rights reserved.
Tue May 20 2008, 04:02 AM -07:00