Packagecc.cote.feathers.softkeyboard
Classpublic class SoftKeyboardEvent
InheritanceSoftKeyboardEvent Inheritance starling.events.Event

A SoftKeyboardEvent object is dispatched in response to a user pressing or releasing one of the keys on a SoftKeyboard object. Please note that this object inherits properties and methods from starling.events.event. You will have to look up Starling's API documentation for those inherited elements.

See also

cc.cote.feathers.softkeyboard.SoftKeyboard
Starling API documentation


Public Properties
 PropertyDefined By
  char : String
[read-only] The actual printable character associated to the key that triggered the event.
SoftKeyboardEvent
  charCode : uint
[read-only] The code of the character associated to the key that triggered the event.
SoftKeyboardEvent
Public Methods
 MethodDefined By
  
SoftKeyboardEvent(type:String, charCode:uint, char:String = null)
Creates a new SoftKeyboardEvent object.
SoftKeyboardEvent
  
toString():String
[override] Returns a textual description of the event (useful in debugging situations).
SoftKeyboardEvent
Public Constants
 ConstantDefined By
  DONE : String = done
[static] The DONE constant defines the value of the type property of a done event object.
SoftKeyboardEvent
  KEY_DOWN : String = keyDown
[static] The KEY_DOWN constant defines the value of the type property of a keyDown event object.
SoftKeyboardEvent
  KEY_UP : String = keyUp
[static] The KEY_UP constant defines the value of the type property of a keyUp event object.
SoftKeyboardEvent
Property Detail
charproperty
char:String  [read-only]

The actual printable character associated to the key that triggered the event. The value for non-printable characters will be null.


Implementation
    public function get char():String
charCodeproperty 
charCode:uint  [read-only]

The code of the character associated to the key that triggered the event. Many basic characters have constants defined for them in the CharCode class. For others, use Unicode as a base reference.


Implementation
    public function get charCode():uint

See also

Constructor Detail
SoftKeyboardEvent()Constructor
public function SoftKeyboardEvent(type:String, charCode:uint, char:String = null)

Creates a new SoftKeyboardEvent object.

Parameters
type:String — Type of the event
 
charCode:uint — The code of the character associated to the key that triggered the event.
 
char:String (default = null) — The actual printable character associated to the key that triggered the event.
Method Detail
toString()method
override public function toString():String

Returns a textual description of the event (useful in debugging situations).

Returns
String
Constant Detail
DONEConstant
public static const DONE:String = done

The DONE constant defines the value of the type property of a done event object.

KEY_DOWNConstant 
public static const KEY_DOWN:String = keyDown

The KEY_DOWN constant defines the value of the type property of a keyDown event object.

KEY_UPConstant 
public static const KEY_UP:String = keyUp

The KEY_UP constant defines the value of the type property of a keyUp event object.