Packagecom.gestureworks.cml.elements
Classpublic class StageKit
InheritanceStageKit Inheritance TouchContainer Inheritance com.gestureworks.core.TouchSprite

The Stage provides access to the stage from CML.

This class is meant to be used within CML and is not compatible with AS3.

See also

flash.display.stage


Public Properties
 PropertyDefined By
  align : String
Specifies the StageAlign type.
StageKit
 InheritedautoShuffle : Boolean
autoshuffles
TouchContainer
 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
  color : uint
Specifies the color of the stage.
StageKit
 InheriteddimensionsTo : Object
Sets the dimensions of TouchContainer to given object
TouchContainer
  displayFrameRate : Boolean = false
Display the frame rate
StageKit
 InheriteddropShadow : Boolean
Sets the drop shadow effect
TouchContainer
  escapeSprite : Boolean = false
Display sprite to exit full screen on touch
StageKit
  esColor : uint = 0xFFFFFF
Escape sprite color
StageKit
  esX : Number = 0
Escape sprite x position
StageKit
  esY : Number = 0
Escape sprite y position
StageKit
  frameRate : Number
StageKit
  frColor : uint = 0xFFFFFF
Frame rate color
StageKit
  frX : Number = 0
Frame rate x position
StageKit
  frY : Number = 0
Frame rate y position
StageKit
  fullscreen : Boolean
Specifies whether or not to set the stage to fullscreen Choose: true or false
StageKit
 Inheritedgroup : String
TouchContainer
  height : Number
[override] Specifies the width of the screen.
StageKit
 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
  scaleMode : String
Specifies the scale mode for the stage.
StageKit
 Inheritedsound : String
TouchContainer
 Inheritedstate : Dictionary
TouchContainer
 InheritedstateId : *
Returns the current state id.
TouchContainer
 InheritedtoBitmap : Boolean
TouchContainer
  width : Number
[override] Specifies the width of the screen.
StageKit
 InheritedwidthPercent : Number
sets the width of the container
TouchContainer
Protected Properties
 PropertyDefined By
 InheritedcmlGestureList : Object
TouchContainer
Public Methods
 MethodDefined By
  
Constructor
StageKit
 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
StageKit
 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] This method provides the stage width and height and also the fullscreen depending on the condition
StageKit
 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
alignproperty
align:String

Specifies the StageAlign type.


Implementation
    public function get align():String
    public function set align(value:String):void
colorproperty 
color:uint

Specifies the color of the stage. FlashPlayer 11.0+ only.

The default value is 0xFFFFFF //.


Implementation
    public function get color():uint
    public function set color(value:uint):void
displayFrameRateproperty 
public var displayFrameRate:Boolean = false

Display the frame rate

escapeSpriteproperty 
public var escapeSprite:Boolean = false

Display sprite to exit full screen on touch

esColorproperty 
public var esColor:uint = 0xFFFFFF

Escape sprite color

esXproperty 
public var esX:Number = 0

Escape sprite x position

esYproperty 
public var esY:Number = 0

Escape sprite y position

frameRateproperty 
frameRate:Number


Implementation
    public function get frameRate():Number
    public function set frameRate(value:Number):void
frColorproperty 
public var frColor:uint = 0xFFFFFF

Frame rate color

frXproperty 
public var frX:Number = 0

Frame rate x position

frYproperty 
public var frY:Number = 0

Frame rate y position

fullscreenproperty 
fullscreen:Boolean

Specifies whether or not to set the stage to fullscreen Choose: true or false

The default value is false.


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

Specifies the width of the screen. AIR only.

The default value is 0.


Implementation
    public function get height():Number
    public function set height(value:Number):void
scaleModeproperty 
scaleMode:String

Specifies the scale mode for the stage.


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

Specifies the width of the screen. AIR only.

The default value is 0.


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

Constructor

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

Destructor

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

This method provides the stage width and height and also the fullscreen depending on the condition