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

KeyboardType  - AS3

Packageflash.ui
Classpublic final class KeyboardType
InheritanceKeyboardType Inheritance Object

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10.1, AIR 2

The KeyboardType class is an enumeration class that provides values for different categories of physical computer or device keyboards.

Use the values defined by the KeyboardType class with the Keybooard.physicalKeyboardType property.

View the examples

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
  ALPHANUMERIC : String = "alphanumeric"
[static] A standard keyboard with a full set of numbers and letters.
KeyboardType
  KEYPAD : String = "keypad"
[static] A phone-style 12-button keypad.
KeyboardType
  NONE : String = "none"
[static] No physical keyboard is supported.
KeyboardType
Constant Detail

ALPHANUMERIC

Constant
public static const ALPHANUMERIC:String = "alphanumeric"

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10.1, AIR 2

A standard keyboard with a full set of numbers and letters.

Most desktop computers and some mobile devices provide an alphanumeric keyboard.

KEYPAD

Constant 
public static const KEYPAD:String = "keypad"

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10.1, AIR 2

A phone-style 12-button keypad.

Many mobile devices provide a keypad, although some provide an alphanumeric keyboard.

NONE

Constant 
public static const NONE:String = "none"

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10.1, AIR 2

No physical keyboard is supported.

Typically, a virtual keyboard is provided in the absence of a physical keyboard.

Related API Elements

KeyboardType.as

The following example is a simple test that indicates the current state of the "Num Lock" and "Caps Lock" keys as well as the type of keybaord and touch screen type in the running environment. When testing this example, click the text field to see the property values:
import flash.events.*;
import flash.display.*;
import flash.ui.Keyboard;
import flash.system.Capabilities;
import flash.text.TextField;


var keyboardInfoTxt:TextField = new TextField();
keyboardInfoTxt.x = 30;
keyboardInfoTxt.y = 50;
keyboardInfoTxt.width = 300;
keyboardInfoTxt.height = 100;
keyboardInfoTxt.border = true;

addChild(keyboardInfoTxt);

addEventListener (MouseEvent.CLICK, getScreenKeyboardType);

function getScreenKeyboardType(e:MouseEvent):void{
    keyboardInfoTxt.text= "Caps Lock is : " + String(flash.ui.Keyboard.capsLock)+ "\n" + 
    "Num Lock is : " + String(flash.ui.Keyboard.numLock) +"\n" + 
    "Has Virtual Keyboard : " + String(flash.ui.Keyboard.hasVirtualKeyboard) + "\n" + 
    "Physical Keyboard Type : " + flash.ui.Keyboard.physicalKeyboardType + "\n" + 
    "flash.system.Capabilities.touchscreenType is : " + flash.system.Capabilities.touchscreenType;
}