ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
flash.ui 

KeyLocation  - AS3

Packageflash.ui
Classpublic final class KeyLocation
InheritanceKeyLocation Inheritance Object

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9

The KeyLocation class contains constants that indicate the location of a key pressed on the keyboard or keyboard-like input device.

The KeyLocation constants are used in the KeyboardEvent.keyLocation property.

Related API Elements



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
Public Methods
 MethodDefined By
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
      D_PAD : uint = 4
[static] Indicates the key activation originated on a directional pad of input device.
KeyLocation
  LEFT : uint = 1
[static] Indicates the key activated is in the left key location (there is more than one possible location for this key).
KeyLocation
  NUM_PAD : uint = 3
[static] Indicates the key activation originated on the numeric keypad or with a virtual key corresponding to the numeric keypad.
KeyLocation
  RIGHT : uint = 2
[static] Indicates the key activated is in the right key location (there is more than one possible location for this key).
KeyLocation
  STANDARD : uint = 0
[static] Indicates the key activation is not distinguished as the left or right version of the key, and did not originate on the numeric keypad (or did not originate with a virtual key corresponding to the numeric keypad).
KeyLocation
Constant Detail
    

D_PAD

Constant
public static const D_PAD:uint = 4

Language Version: ActionScript 3.0
Runtime Versions: AIR 2.5

Indicates the key activation originated on a directional pad of input device. Example: The trackball on a mobile device or the left arrow on a remote control.

LEFT

Constant 
public static const LEFT:uint = 1

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9

Indicates the key activated is in the left key location (there is more than one possible location for this key). Example: The left Shift key on a PC 101 Key US keyboard.

NUM_PAD

Constant 
public static const NUM_PAD:uint = 3

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9

Indicates the key activation originated on the numeric keypad or with a virtual key corresponding to the numeric keypad. Example: The 1 key on a PC 101 Key US keyboard located on the numeric pad.

RIGHT

Constant 
public static const RIGHT:uint = 2

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9

Indicates the key activated is in the right key location (there is more than one possible location for this key). Example: The right Shift key on a PC 101 Key US keyboard.

STANDARD

Constant 
public static const STANDARD:uint = 0

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9

Indicates the key activation is not distinguished as the left or right version of the key, and did not originate on the numeric keypad (or did not originate with a virtual key corresponding to the numeric keypad). Example: The Q key on a PC 101 Key US keyboard.