Packagecom.gestureworks.cml.element
Classpublic class Key
InheritanceKey Inheritance Button Inheritance Container Inheritance ContainerFactory Inheritance ElementFactory Inheritance flash.display.Sprite

The key element simulates a key on a keyboard by dispatching a keyboard event, containing the assigned character and key unicode values, when touched.
        
        var ke:Key = new Key();
        ke.text = "a";
        ke.init();
        addChild(ke);
      
     

See also

TouchKeyboard
Button


Public Properties
 PropertyDefined By
 Inheritedalpha : Number
[override] [write-only] sets the alpha for display objects
ElementFactory
 Inheritedblur : Boolean
Sets the drop shadow effect
ElementFactory
 Inheritedbottom : Number
sets the bottom value
ElementFactory
  capsOn : Boolean
A flag indicating the "capitalized" state of the text.
Key
  charCode : uint
The character code (unicode) value of the key pressed
Key
 InheritedchildList : ChildList
[read-only] store the child list
ContainerFactory
 Inheritedclass_ : String
Object's css class;
ElementFactory
 InheritedclassName : String
sets the class name of displayobject
ElementFactory
 InheritedcmlIndex : int
sets the cml index
ElementFactory
 Inheriteddebug : Boolean = false
Button
 InheriteddebugStyle : *
sets the debug style
ElementFactory
 InheriteddimensionsTo : String
sets the dimensions of the container
ContainerFactory
 Inheriteddispatch : String
Assigns a message to dispatch with a button state event.
Button
 InheriteddispatchDefault : Boolean = false
Button
 InheriteddisplayEvents : String
Use for dispatch completes.
ElementFactory
 Inheriteddown : *
Sets button state association with down event
Button
  downTextColor : uint
The color of the text when touched down
Key
 InheriteddropShadow : Boolean
Sets the drop shadow effect
ElementFactory
 Inheritedheight : Number
[override] Sets width of the display object in pixels
ElementFactory
 InheritedheightPercent : String
sets the height percent of display object
ElementFactory
 Inheritedhit : *
The hit object is the object recieving the input events
Button
 InheritedhorizontalCenter : Number
sets the horizontal center of display object
ElementFactory
  icon : *
The icon displayed on the key element
Key
 Inheritedid : String
sets the id of child
ElementFactory
 Inheritedindex : int
sets the index of display object
ElementFactory
 InheritedinfoSource : String
sets info source
ContainerFactory
 Inheritedinitial : *
Sets the initial button state object
Button
  initTextColor : uint
The inital text color
Key
  keyCode : uint
The key code (unicode) value of the key pressed
Key
 Inheritedlayout : *
Sets the layout of the container
Container
 InheritedlayoutComplete : Function
Sets the function to call when the layout is complete
Container
 InheritedlayoutList : Dictionary
Defines the layoutlist
Container
 InheritedlayoutUpdate : Function
Sets the function to call when the layout updates
Container
 Inheritedleft : Number
sets left value
ElementFactory
 InheritedmouseDown : *
Sets button state association with mouse down event
Button
 InheritedmouseOut : *
Sets button state association with mouse out event
Button
 InheritedmouseOver : *
Sets button state association with mouse over event
Button
 InheritedmouseUp : *
Sets button state association with mouse up event
Button
 Inheritedout : *
Sets button state association with out event
Button
  outTextColor : uint
The text color when touched out
Key
 Inheritedover : *
Sets button state association with over event (mouse only)
Button
  overTextColor : uint
The text color when touched over
Key
 InheritedpaddingBottom : Number
Sets the number of pixels between the container's bottom border and the bottom of its content area.
Container
 InheritedpaddingLeft : Number
Sets the number of pixels between the component's left border and the left edge of its content area.
Container
 InheritedpaddingRight : Number
Sets the number of pixels between the component's right border and the right edge of its content area.
Container
 InheritedpaddingTop : Number
Sets the number of pixels between the container's top border and the top of its content area.
Container
 Inheritedposition : String
Sets the position
Container
 InheritedpropertyStates : Array
Deprecated: Please Use state
ElementFactory
 Inheritedright : Number
sets the right value
ElementFactory
 Inheritedscale : Number
Sets both the x and y scale values
ElementFactory
 InheritedscaleX : Number
[override] Sets width of the display object in pixels
ElementFactory
 InheritedscaleY : Number
[override] Sets width of the display object in pixels
ElementFactory
  shiftCharCode : uint
The character code (unicode) value of the key pressed while in a shift state
Key
  shiftOn : Boolean
A flag indicating the shift state of the text.
Key
  shiftText : String
The text displayed on the key while in a shift state
Key
 Inheritedside : String
Attaches an event string to a button to listen for to toggle visibility when that event is dispatched.
Button
 Inheritedstate : Array
property states array
ElementFactory
 Inheritedtap : *
Sets the button state association with tap event.
Button
  text : *
The text displayed on the key
Key
 Inheritedtoggle : String
An alternative to button state events, the toggle displays the next child at each event defined by the toggle value (e.g.
Button
 Inheritedtop : Number
sets top value
ElementFactory
 InheritedtouchDown : *
Sets button state association with touch down event
Button
 InheritedtouchOut : *
Sets button state association with touch out event
Button
 InheritedtouchOver : *
Sets button state association with touch out event
Button
 InheritedtouchUp : *
Sets button state association with touch up event
Button
 Inheritedup : *
Sets button state association with up event
Button
  upTextColor : uint
The text color when touched up
Key
 InheritedverticalCenter : Number
sets the vertical center of display object
ElementFactory
 Inheritedwidth : Number
[override] Sets width of the display object in pixels
ElementFactory
 InheritedwidthPercent : String
sets the percent of width of display object
ElementFactory
Protected Properties
 PropertyDefined By
 InheritedbuttonStates : Array
Button
Public Methods
 MethodDefined By
  
Key()
Constructor
Key
 Inherited
This method searches the childlist and add the children
ContainerFactory
 Inherited
addChild(child:DisplayObject):DisplayObject
[override] Adds child to display list and, if not already added, the child list TODO: This mechanism should be abstracted to better syncrhonize child and display lists
Container
 Inherited
applyLayout(value:* = null):void
Apply the containers layout
Container
 Inherited
childToList(id:String, child:*):void
this method append to the childlist
ContainerFactory
 Inherited
clone():*
[override] Returns clone of self
Button
  
[override] CML initialization
Key
  
dispose():void
[override] Dispose methods
Key
 Inherited
getIndex(index:int):*
returns childlist index
Container
 Inherited
getKey(key:String):*
returns the childlist key
Container
 Inherited
hideIndex(index:int):void
hides the childlist index
Container
 Inherited
hideKey(key:String):void
hides the childlist key
Container
  
init():void
[override] Initialization function
Key
 Inherited
Button
 Inherited
parseCML(cml:XMLList):XMLList
[override] Parse cml for local layouts.
Container
 Inherited
postparseCML(cml:XMLList):void
post parses the cml file
ElementFactory
 Inherited
reset():void
Button
 Inherited
runToggle():void
Button
 Inherited
searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists.
Container
 Inherited
This method sets the dimensions of childlist
ContainerFactory
 Inherited
showIndex(index:int):void
shows the childlist index
Container
 Inherited
showKey(key:String):void
shows the childlist key
Container
 Inherited
Updates dimensions
Button
 Inherited
updateProperties(state:Number = 0):void
this method updates the properties
ElementFactory
Protected Methods
 MethodDefined By
  
onDown(event:*):void
[override] The down event handler.
Key
 Inherited
onMouseDown(event:*):void
Processes the mouse down event by displaying the mouseDown state and hiding the other states.
Button
 Inherited
onMouseOut(event:*):void
Processes the mouse out event by displaying the mouseOut state and hiding the other states.
Button
 Inherited
onMouseOver(event:*):void
Processes the mouse over event by displaying the mouseOver state and hiding the other states.
Button
 Inherited
onMouseUp(event:*):void
Processes the mouse up event by displaying the mouseUp state and hiding the other states.
Button
  
onOut(event:*):void
[override] The out event handler.
Key
  
onOver(event:*):void
[override] The over event handler.
Key
 Inherited
onTap(event:*):void
Button
 Inherited
onToggle(event:*):void
Displays the the next child on the specified button event.
Button
 Inherited
onTouchDown(event:*):void
Processes the touch down event by displaying the touchDown state and hiding the other states.
Button
 Inherited
onTouchOut(event:*):void
Processes the touch out event by displaying the touchOut state and hiding the other states.
Button
 Inherited
onTouchOver(event:*):void
Processes the touch over event by displaying the touchOver state and hiding the other states.
Button
 Inherited
onTouchUp(event:*):void
Processes the touch up event by displaying the touchUp state and hiding the other states.
Button
  
onUp(event:*):void
[override] The up event handler.
Key
Property Detail
capsOnproperty
capsOn:Boolean

A flag indicating the "capitalized" state of the text. Only valid for letter characters.


Implementation
    public function get capsOn():Boolean
    public function set capsOn(value:Boolean):void
charCodeproperty 
charCode:uint

The character code (unicode) value of the key pressed


Implementation
    public function get charCode():uint
    public function set charCode(value:uint):void
downTextColorproperty 
downTextColor:uint

The color of the text when touched down


Implementation
    public function get downTextColor():uint
    public function set downTextColor(value:uint):void
iconproperty 
icon:*

The icon displayed on the key element


Implementation
    public function get icon():*
    public function set icon(value:any):void
initTextColorproperty 
initTextColor:uint

The inital text color


Implementation
    public function get initTextColor():uint
    public function set initTextColor(value:uint):void
keyCodeproperty 
keyCode:uint

The key code (unicode) value of the key pressed


Implementation
    public function get keyCode():uint
    public function set keyCode(value:uint):void
outTextColorproperty 
outTextColor:uint

The text color when touched out


Implementation
    public function get outTextColor():uint
    public function set outTextColor(value:uint):void
overTextColorproperty 
overTextColor:uint

The text color when touched over


Implementation
    public function get overTextColor():uint
    public function set overTextColor(value:uint):void
shiftCharCodeproperty 
shiftCharCode:uint

The character code (unicode) value of the key pressed while in a shift state


Implementation
    public function get shiftCharCode():uint
    public function set shiftCharCode(value:uint):void
shiftOnproperty 
shiftOn:Boolean

A flag indicating the shift state of the text. Any key can have a text value for a shift state and one for the initial state.


Implementation
    public function get shiftOn():Boolean
    public function set shiftOn(value:Boolean):void
shiftTextproperty 
shiftText:String

The text displayed on the key while in a shift state


Implementation
    public function get shiftText():String
    public function set shiftText(value:String):void
textproperty 
text:*

The text displayed on the key


Implementation
    public function get text():*
    public function set text(value:any):void
upTextColorproperty 
upTextColor:uint

The text color when touched up


Implementation
    public function get upTextColor():uint
    public function set upTextColor(value:uint):void
Constructor Detail
Key()Constructor
public function Key()

Constructor

Method Detail
displayComplete()method
override public function displayComplete():void

CML initialization

dispose()method 
override public function dispose():void

Dispose methods

init()method 
override public function init():void

Initialization function

onDown()method 
override protected function onDown(event:*):void

The down event handler. Dispatches a KEY_DOWN event containing the character key codes. The key location has an arbitrary value (10) to identify its origin.

Parameters

event:* — event triggered when touched/clicked

onOut()method 
override protected function onOut(event:*):void

The out event handler.

Parameters

event:* — event triggered when a key is released from an over event

onOver()method 
override protected function onOver(event:*):void

The over event handler.

Parameters

event:* — event triggered when a key is intersected from outside

onUp()method 
override protected function onUp(event:*):void

The up event handler.

Parameters

event:* — event triggered when a key is released from a down event