flash.ui

# KeyboardType - AS3

Package | flash.ui
Class | public final class KeyboardType
Inheritance | KeyboardType 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

Keyboard.physicalKeyboardType

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | 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
|  | 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
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | 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
--- | --- | ---
|  | 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

flash.ui.Keyboard.hasVirtualKeyboard
Examples How to use this example
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;
    }

Copy

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00