Packagefr.kapit.pictogram.actions.data
Classpublic class KeyboardData
InheritanceKeyboardData Inheritance Object

used by the all actions that refer to the keyboard message.



Public Properties
 PropertyDefined By
  altKey : Boolean
used to specify if the alt key will be used for user interaction
KeyboardData
  ctrlKey : Boolean
used to specify if the ctrl key will used for user interaction
KeyboardData
  keyCode : uint
used to enable the user to choose his interaction key
KeyboardData
  shiftKey : Boolean
used to specify if the shift key will used for user interaction
KeyboardData
  type : String
a string with two possible values KeyBoardAction.DOWN or KeyBoardAction.UP used to indicate the type of the interaction type.
KeyboardData
Public Methods
 MethodDefined By
  
KeyboardData(keyCode:uint = 0, type:String = down, shiftKey:Boolean = false, ctrlKey:Boolean = false, altKey:Boolean = false)
constructor.
KeyboardData
  
toString():String
KeyboardData
Property Detail
altKeyproperty
public var altKey:Boolean

used to specify if the alt key will be used for user interaction

ctrlKeyproperty 
public var ctrlKey:Boolean

used to specify if the ctrl key will used for user interaction

keyCodeproperty 
public var keyCode:uint

used to enable the user to choose his interaction key

shiftKeyproperty 
public var shiftKey:Boolean

used to specify if the shift key will used for user interaction

typeproperty 
public var type:String

a string with two possible values KeyBoardAction.DOWN or KeyBoardAction.UP used to indicate the type of the interaction type. Choosing KeyBoardAction.UP means that the interaction will be launched when a simple click is done on the specified key. However when choosing DOWN the interaction will be launched only when the user holds the key pressed

Constructor Detail
KeyboardData()Constructor
public function KeyboardData(keyCode:uint = 0, type:String = down, shiftKey:Boolean = false, ctrlKey:Boolean = false, altKey:Boolean = false)

constructor.

Parameters
keyCode:uint (default = 0)
 
type:String (default = down)
 
shiftKey:Boolean (default = false)
 
ctrlKey:Boolean (default = false)
 
altKey:Boolean (default = false)
Method Detail
toString()method
public function toString():String

Returns
String