Packagecom.gestureworks.cml.elements
Classpublic class Toggle
InheritanceToggle Inheritance TouchContainer Inheritance com.gestureworks.core.TouchSprite

The Toggle element acts as a toggle button. It adds a crossline graphic inside of square when toggled.
     
       var toggle:Toggle = new Toggle();
       toggle.fillColor = 0x333333;
       toggle.backgroundLineColor = 0xFF0000;
       toggle.toggleLineStoke = 4;
       toggle.x = 100;
       toggle.y = 100;
       addChild(toggle);
    
       toggle.addEventListener(StateEvent.CHANGE, onToggle);
    
       var txt:TextElement = new TextElement;
       txt.text = "hello";
       txt.x = 200;
       txt.y = 130;
       txt.visible = false;
       addChild(txt);
    
       function onToggle(event:StateEvent):void
       {
          trace("toggle text", event.value);

          if (event.value == "true")
              txt.visible = true;
          else
              txt.visible = false;
       }
     
     



Public Properties
 PropertyDefined By
 InheritedautoShuffle : Boolean
autoshuffles
TouchContainer
  background : Sprite
Defines the square background
Toggle
  backgroundColor : uint
Sets the inside color of the background
Toggle
  backgroundLineAlpha : Number
Sets alpha of the background line
Toggle
  backgroundLineColor : uint
Sets the color of the background line color
Toggle
  backgroundLineStoke : Number
Sets the background Line Stoke
Toggle
 InheritedchildList : ChildList
Returns the object's childList.
TouchContainer
 InheritedclassName : String
sets the class name of displayobject
TouchContainer
 InheritedcloneExclusions : Vector.<String>
[read-only] Returns a list of properties to exclude when cloning this object
TouchContainer
 InheritedcmlIndex : int
Returns the index created by the CML parser.
TouchContainer
 InheriteddimensionsTo : Object
Sets the dimensions of TouchContainer to given object
TouchContainer
 InheriteddropShadow : Boolean
Sets the drop shadow effect
TouchContainer
 Inheritedgroup : String
TouchContainer
  height : Number
[override] Sets height of the display object in pixels
Toggle
 InheritedheightPercent : Number
sets the height of the container
TouchContainer
 Inheritedid : String
Returns the object's id.
TouchContainer
 Inheritedlayout : *
specifies the type of layout
TouchContainer
 InheritedlayoutList : Dictionary
TouchContainer
 InheritedmouseChildren : Boolean
[override] sets the mousechildren value to true or false.
TouchContainer
 InheritedpaddingBottom : Number
Sets the number of pixels between the container's bottom border and the bottom of its content area.
TouchContainer
 InheritedpaddingLeft : Number
Sets the number of pixels between the component's left border and the left edge of its content area.
TouchContainer
 InheritedpaddingRight : Number
Sets the number of pixels between the component's right border and the right edge of its content area.
TouchContainer
 InheritedpaddingTop : Number
Sets the number of pixels between the container's top border and the top of its content area.
TouchContainer
 Inheritedposition : *
Sets the position
TouchContainer
 InheritedrelativeX : Boolean
When set true this containers children's x position will be laid out relatively to each other.
TouchContainer
 InheritedrelativeY : Boolean
When set true this containers children's y position will be laid out relatively to each other.
TouchContainer
 Inheritedsound : String
TouchContainer
 Inheritedstate : Dictionary
TouchContainer
 InheritedstateId : *
Returns the current state id.
TouchContainer
 InheritedtoBitmap : Boolean
TouchContainer
  toggleColor : uint
Sets the toggle color of the background
Toggle
  toggleGraphic : Sprite
The "x" graphic in the background
Toggle
  toggleLineStoke : Number
Sets the toggle Line Stoke of the background
Toggle
  value : Boolean
Sets the current toggle state
Toggle
  width : Number
[override] Sets width of the display object in pixels
Toggle
 InheritedwidthPercent : Number
sets the width of the container
TouchContainer
Protected Properties
 PropertyDefined By
 InheritedcmlGestureList : Object
TouchContainer
Public Methods
 MethodDefined By
  
Constructor
Toggle
 Inherited
TouchContainer
 Inherited
method searches the child and adds to the list
TouchContainer
 Inherited
addChild(child:DisplayObject):DisplayObject
[override] Adds child to display list and, if not already added, the child list
TouchContainer
 Inherited
addChildAt(child:DisplayObject, index:int):DisplayObject
[override] Adds child to display list and, if not already added, the child list
TouchContainer
 Inherited
applyLayout(value:* = null):void
Apply the containers layout
TouchContainer
 Inherited
childToList(id:String, child:*):void
child appended to the childlist
TouchContainer
 Inherited
clone():*
Clone method
TouchContainer
  
dispose():void
[override] Destructor
Toggle
  
draw():void
Draws the background and x graphic in background
Toggle
 Inherited
getElementById(id:String):*
Searches CML childList by id.
TouchContainer
 Inherited
getElementsByClassName(className:String):Array
Searches the CML childList by className.
TouchContainer
 Inherited
getElementsByTagName(tagName:Class):Array
Searches the CML childList by tagName as Class.
TouchContainer
  
init():void
[override] Initializes the configuration and display of the toggle
Toggle
 Inherited
loadState(sId:* = null, recursion:Boolean = false):void
Loads state by index number.
TouchContainer
 Inherited
makeGestureList(value:XMLList):Object
Creates gestureList object from XML
TouchContainer
 Inherited
parseCML(cml:XMLList):XMLList
Parse cml for local layouts.
TouchContainer
 Inherited
postparseCML(cml:XMLList):void
Abstract method allows the setting of a postparse CML routine.
TouchContainer
 Inherited
querySelector(selector:String):*
Searches the CML childList by selector.
TouchContainer
 Inherited
querySelectorAll(selector:*):Array
Search the CML childList by selector.
TouchContainer
 Inherited
removeChild(child:DisplayObject):DisplayObject
[override] Removes child from display list and, if not already removed, the child list
TouchContainer
 Inherited
removeChildAt(index:int):DisplayObject
[override] Removes child from display list and, if not already removed, the child list
TouchContainer
 Inherited
removeChildren(beginIndex:int = 0, endIndex:int = 2147483647):void
[override] Removes children from display list and, if not already removed, the child list
TouchContainer
 Inherited
saveState(sId:* = null, recursion:Boolean = false):void
Save state by index number.
TouchContainer
 Inherited
searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists.
TouchContainer
 Inherited
method sets the dimensions of each child
TouchContainer
 Inherited
tweenState(sId:* = null, tweenTime:Number = 1):void
Tween state by stateIndex from current to given state index.
TouchContainer
 Inherited
Updates child padding within this container
TouchContainer
 Inherited
Updates child percent dimensions within this container
TouchContainer
 Inherited
updateProperties(state:* = 0):void
Updates properties from state.
TouchContainer
 Inherited
Updates child relative positions within this container
TouchContainer
Property Detail
backgroundproperty
public var background:Sprite

Defines the square background

backgroundColorproperty 
backgroundColor:uint

Sets the inside color of the background

The default value is 0x333333.


Implementation
    public function get backgroundColor():uint
    public function set backgroundColor(value:uint):void
backgroundLineAlphaproperty 
backgroundLineAlpha:Number

Sets alpha of the background line

The default value is 100.


Implementation
    public function get backgroundLineAlpha():Number
    public function set backgroundLineAlpha(value:Number):void
backgroundLineColorproperty 
backgroundLineColor:uint

Sets the color of the background line color

The default value is 0x00ff00.


Implementation
    public function get backgroundLineColor():uint
    public function set backgroundLineColor(value:uint):void
backgroundLineStokeproperty 
backgroundLineStoke:Number

Sets the background Line Stoke

The default value is 1.


Implementation
    public function get backgroundLineStoke():Number
    public function set backgroundLineStoke(value:Number):void
heightproperty 
height:Number[override]

Sets height of the display object in pixels

The default value is 100.


Implementation
    public function get height():Number
    public function set height(value:Number):void
toggleColorproperty 
toggleColor:uint

Sets the toggle color of the background

The default value is 0x00FF00.


Implementation
    public function get toggleColor():uint
    public function set toggleColor(value:uint):void
toggleGraphicproperty 
public var toggleGraphic:Sprite

The "x" graphic in the background

toggleLineStokeproperty 
toggleLineStoke:Number

Sets the toggle Line Stoke of the background

The default value is 1.


Implementation
    public function get toggleLineStoke():Number
    public function set toggleLineStoke(value:Number):void
valueproperty 
value:Boolean

Sets the current toggle state

The default value is false.


Implementation
    public function get value():Boolean
    public function set value(value:Boolean):void
widthproperty 
width:Number[override]

Sets width of the display object in pixels

The default value is 100.


Implementation
    public function get width():Number
    public function set width(value:Number):void
Constructor Detail
Toggle()Constructor
public function Toggle()

Constructor

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

Destructor

draw()method 
public function draw():void

Draws the background and x graphic in background

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

Initializes the configuration and display of the toggle