Package | com.gestureworks.cml.element |
Class | public class TouchKeyboard |
Inheritance | TouchKeyboard Container ContainerFactory ElementFactory flash.display.Sprite |
TouchKeyboard
is a virtual keyboard providing an interface for a collection of Key
objects
and output management for key events. Default configurations are in place for convenience but the keyboard's style, layout, and key
actions are customizable.
var tk:TouchKeyboard = new TouchKeyboard(); tk.init(); addChild(tk); var txt1:Text = new Text(); txt1.width = 400; txt1.height = 400; txt1.x = 1000; txt1.border = true; txt1.multiline = true; txt1.type = "input"; addChild(txt1);
See also
Property | Defined By | ||
---|---|---|---|
alpha : Number [override] [write-only]
sets the alpha for display objects
| ElementFactory | ||
background : *
The graphical canvas containing the keys
| TouchKeyboard | ||
bkgPadding : Number
The space between the outermost keys and the edges of the background
| TouchKeyboard | ||
blur : Boolean
Sets the drop shadow effect
| ElementFactory | ||
bottom : Number
sets the bottom value
| ElementFactory | ||
childList : ChildList [read-only]
store the child list
| ContainerFactory | ||
class_ : String
Object's css class;
| ElementFactory | ||
className : String
sets the class name of displayobject
| ElementFactory | ||
cmlIndex : int
sets the cml index
| ElementFactory | ||
debugStyle : *
sets the debug style
| ElementFactory | ||
dimensionsTo : String
sets the dimensions of the container
| ContainerFactory | ||
displayEvents : String
Use for dispatch completes. | ElementFactory | ||
dropShadow : Boolean
Sets the drop shadow effect
| ElementFactory | ||
height : Number [override]
Sets width of the display object in pixels
| ElementFactory | ||
heightPercent : String
sets the height percent of display object
| ElementFactory | ||
horizontalCenter : Number
sets the horizontal center of display object
| ElementFactory | ||
id : String
sets the id of child
| ElementFactory | ||
index : int
sets the index of display object
| ElementFactory | ||
infoSource : String
sets info source
| ContainerFactory | ||
keySpacing : Number
The spacing between the keys
| TouchKeyboard | ||
layout : *
Sets the layout of the container
| Container | ||
layoutComplete : Function
Sets the function to call when the layout is complete
| Container | ||
layoutList : Dictionary
Defines the layoutlist
| Container | ||
layoutUpdate : Function
Sets the function to call when the layout updates
| Container | ||
left : Number
sets left value
| ElementFactory | ||
output : *
A specified output text field
| TouchKeyboard | ||
paddingBottom : Number
Sets the number of pixels between the container's bottom border and the bottom of its content area. | Container | ||
paddingLeft : Number
Sets the number of pixels between the component's left border and the left edge of its content area. | Container | ||
paddingRight : Number
Sets the number of pixels between the component's right border and the right edge of its content area. | Container | ||
paddingTop : Number
Sets the number of pixels between the container's top border and the top of its content area. | Container | ||
position : String
Sets the position
| Container | ||
propertyStates : Array Deprecated: Please Use state | ElementFactory | ||
right : Number
sets the right value
| ElementFactory | ||
scale : Number
Sets both the x and y scale values
| ElementFactory | ||
scaleX : Number [override]
Sets width of the display object in pixels
| ElementFactory | ||
scaleY : Number [override]
Sets width of the display object in pixels
| ElementFactory | ||
state : Array
property states array
| ElementFactory | ||
top : Number
sets top value
| ElementFactory | ||
verticalCenter : Number
sets the vertical center of display object
| ElementFactory | ||
width : Number [override]
Sets width of the display object in pixels
| ElementFactory | ||
widthPercent : String
sets the percent of width of display object
| ElementFactory |
Method | Defined By | ||
---|---|---|---|
Constructor
| TouchKeyboard | ||
addAllChildren():void
This method searches the childlist and add the children
| ContainerFactory | ||
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 | ||
applyLayout(value:* = null):void
Apply the containers layout
| Container | ||
childToList(id:String, child:*):void
this method append to the childlist
| ContainerFactory | ||
clone():*
Returns clone of self
| ElementFactory | ||
displayComplete():void [override]
CML initialization
| TouchKeyboard | ||
dispose():void [override]
Dispose method
| TouchKeyboard | ||
getIndex(index:int):*
returns childlist index
| Container | ||
getKey(key:String):*
returns the childlist key
| Container | ||
hideIndex(index:int):void
hides the childlist index
| Container | ||
hideKey(key:String):void
hides the childlist key
| Container | ||
init():void [override]
Initialization function
| TouchKeyboard | ||
parseCML(cml:XMLList):XMLList [override]
Parse cml for local layouts. | Container | ||
postparseCML(cml:XMLList):void
post parses the cml file
| ElementFactory | ||
searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists. | Container | ||
setDimensionsToChild():void
This method sets the dimensions of childlist
| ContainerFactory | ||
showIndex(index:int):void
shows the childlist index
| Container | ||
showKey(key:String):void
shows the childlist key
| Container | ||
updateProperties(state:Number = 0):void
this method updates the properties
| ElementFactory |
background | property |
background:*
The graphical canvas containing the keys
public function get background():*
public function set background(value:any):void
bkgPadding | property |
bkgPadding:Number
The space between the outermost keys and the edges of the background
public function get bkgPadding():Number
public function set bkgPadding(value:Number):void
keySpacing | property |
keySpacing:Number
The spacing between the keys
public function get keySpacing():Number
public function set keySpacing(value:Number):void
output | property |
output:*
A specified output text field
public function get output():*
public function set output(value:any):void
TouchKeyboard | () | Constructor |
public function TouchKeyboard()
Constructor
displayComplete | () | method |
override public function displayComplete():void
CML initialization
dispose | () | method |
override public function dispose():void
Dispose method
init | () | method |
override public function init():void
Initialization function