Packagecom.gestureworks.cml.elements
Classpublic class Attract
InheritanceAttract Inheritance TouchContainer Inheritance com.gestureworks.core.TouchSprite

The AttractKit creates an attract screen that is removed during touch and displayed after a timout period.

        var a:AttractKit = new AttractKit;
        a.addChild(img1);
        a.addChild(img2);
        a.init();
        a.addChild();
        
     

See also

Container


Public Properties
 PropertyDefined By
  attractState : Boolean
The current attract state (false = closed, true = open)
Attract
 InheritedautoShuffle : Boolean
autoshuffles
TouchContainer
  _autoupdate : Boolean = false
Automatically updates attract screen to stage size.
Attract
  autoupdate : Boolean
Attract
  center : Boolean
Sets whether or not to center chidren
Attract
 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
 Inheritedheight : Number
[override] sets the height of the container
TouchContainer
 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
  timeout : Number
Sets the amount of time in seconds before the program times out and the attract screen pops up.
Attract
 InheritedtoBitmap : Boolean
TouchContainer
  tweenFades : Boolean
Sets whether or not to fade the attract screen in and out.
Attract
  tweenTime : Number
The duration of the tween in seconds
Attract
 Inheritedwidth : Number
[override] sets the width of the container
TouchContainer
 InheritedwidthPercent : Number
sets the width of the container
TouchContainer
Protected Properties
 PropertyDefined By
 InheritedcmlGestureList : Object
TouchContainer
Public Methods
 MethodDefined By
  
Constructor
Attract
 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
Attract
 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] CML callback initialisation
Attract
 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
  
updateLayout(event:Event = null):void
Updates the child x and y position to the center of the stage
Attract
 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
_autoupdateproperty
public var _autoupdate:Boolean = false

Automatically updates attract screen to stage size. This adds an event listener to the stage which listens for resize events, and adjust accordingly.

The default value is false.

attractStateproperty 
attractState:Boolean

The current attract state (false = closed, true = open)


Implementation
    public function get attractState():Boolean
    public function set attractState(value:Boolean):void
autoupdateproperty 
autoupdate:Boolean


Implementation
    public function get autoupdate():Boolean
    public function set autoupdate(value:Boolean):void
centerproperty 
center:Boolean

Sets whether or not to center chidren


Implementation
    public function get center():Boolean
    public function set center(value:Boolean):void
timeoutproperty 
timeout:Number

Sets the amount of time in seconds before the program times out and the attract screen pops up.


Implementation
    public function get timeout():Number
    public function set timeout(value:Number):void
tweenFadesproperty 
tweenFades:Boolean

Sets whether or not to fade the attract screen in and out.


Implementation
    public function get tweenFades():Boolean
    public function set tweenFades(value:Boolean):void
tweenTimeproperty 
tweenTime:Number

The duration of the tween in seconds


Implementation
    public function get tweenTime():Number
    public function set tweenTime(value:Number):void
Constructor Detail
Attract()Constructor
public function Attract()

Constructor

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

Destructor

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

CML callback initialisation

updateLayout()method 
public function updateLayout(event:Event = null):void

Updates the child x and y position to the center of the stage

Parameters

event:Event (default = null)