Package | com.gestureworks.cml.elements |
Class | public class StageKit |
Inheritance | StageKit ![]() ![]() |
This class is meant to be used within CML and is not compatible with AS3.
See also
Property | Defined By | ||
---|---|---|---|
align : String
Specifies the StageAlign type. | StageKit | ||
![]() | autoShuffle : Boolean
autoshuffles
| TouchContainer | |
![]() | childList : ChildList
Returns the object's childList. | TouchContainer | |
![]() | className : String
sets the class name of displayobject
| TouchContainer | |
![]() | cloneExclusions : Vector.<String> [read-only]
Returns a list of properties to exclude when cloning this object
| TouchContainer | |
![]() | cmlIndex : int
Returns the index created by the CML parser. | TouchContainer | |
color : uint
Specifies the color of the stage. | StageKit | ||
![]() | dimensionsTo : Object
Sets the dimensions of TouchContainer to given object
| TouchContainer | |
displayFrameRate : Boolean = false
Display the frame rate
| StageKit | ||
![]() | dropShadow : 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 | ||
![]() | group : String | TouchContainer | |
height : Number [override]
Specifies the width of the screen. | StageKit | ||
![]() | heightPercent : Number
sets the height of the container
| TouchContainer | |
![]() | id : String
Returns the object's id. | TouchContainer | |
![]() | layout : *
specifies the type of layout
| TouchContainer | |
![]() | layoutList : Dictionary | TouchContainer | |
![]() | mouseChildren : Boolean [override]
sets the mousechildren value to true or false. | TouchContainer | |
![]() | paddingBottom : Number
Sets the number of pixels between the container's bottom border and the bottom of its content area. | TouchContainer | |
![]() | paddingLeft : Number
Sets the number of pixels between the component's left border and the left edge of its content area. | TouchContainer | |
![]() | paddingRight : Number
Sets the number of pixels between the component's right border and the right edge of its content area. | TouchContainer | |
![]() | paddingTop : Number
Sets the number of pixels between the container's top border and the top of its content area. | TouchContainer | |
![]() | position : *
Sets the position
| TouchContainer | |
![]() | relativeX : Boolean
When set true this containers children's x position will be laid out relatively
to each other. | TouchContainer | |
![]() | relativeY : 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 | ||
![]() | sound : String | TouchContainer | |
![]() | state : Dictionary | TouchContainer | |
![]() | stateId : *
Returns the current state id. | TouchContainer | |
![]() | toBitmap : Boolean | TouchContainer | |
width : Number [override]
Specifies the width of the screen. | StageKit | ||
![]() | widthPercent : Number
sets the width of the container
| TouchContainer |
Method | Defined By | ||
---|---|---|---|
StageKit()
Constructor
| StageKit | ||
![]() | activateTouch():void | TouchContainer | |
![]() | addAllChildren():void
method searches the child and adds to the list
| TouchContainer | |
![]() | addChild(child:DisplayObject):DisplayObject [override]
Adds child to display list and, if not already added, the child list
| TouchContainer | |
![]() | addChildAt(child:DisplayObject, index:int):DisplayObject [override]
Adds child to display list and, if not already added, the child list
| TouchContainer | |
![]() | applyLayout(value:* = null):void
Apply the containers layout
| TouchContainer | |
![]() | childToList(id:String, child:*):void
child appended to the childlist
| TouchContainer | |
![]() | clone():*
Clone method
| TouchContainer | |
dispose():void [override]
Destructor
| StageKit | ||
![]() | getElementById(id:String):*
Searches CML childList by id. | TouchContainer | |
![]() | getElementsByClassName(className:String):Array
Searches the CML childList by className. | TouchContainer | |
![]() | 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 | ||
![]() | loadState(sId:* = null, recursion:Boolean = false):void
Loads state by index number. | TouchContainer | |
![]() | makeGestureList(value:XMLList):Object
Creates gestureList object from XML
| TouchContainer | |
![]() | parseCML(cml:XMLList):XMLList
Parse cml for local layouts. | TouchContainer | |
![]() | postparseCML(cml:XMLList):void
Abstract method allows the setting of a postparse CML routine. | TouchContainer | |
![]() | querySelector(selector:String):*
Searches the CML childList by selector. | TouchContainer | |
![]() | querySelectorAll(selector:*):Array
Search the CML childList by selector. | TouchContainer | |
![]() | removeChild(child:DisplayObject):DisplayObject [override]
Removes child from display list and, if not already removed, the child list
| TouchContainer | |
![]() | removeChildAt(index:int):DisplayObject [override]
Removes child from display list and, if not already removed, the child list
| TouchContainer | |
![]() | removeChildren(beginIndex:int = 0, endIndex:int = 2147483647):void [override]
Removes children from display list and, if not already removed, the child list
| TouchContainer | |
![]() | saveState(sId:* = null, recursion:Boolean = false):void
Save state by index number. | TouchContainer | |
![]() | searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists. | TouchContainer | |
![]() | setDimensionsToChild():void
method sets the dimensions of each child
| TouchContainer | |
![]() | tweenState(sId:* = null, tweenTime:Number = 1):void
Tween state by stateIndex from current to given state index. | TouchContainer | |
![]() | updatePadding():void
Updates child padding within this container
| TouchContainer | |
![]() | updatePercentDim():void
Updates child percent dimensions within this container
| TouchContainer | |
![]() | updateProperties(state:* = 0):void
Updates properties from state. | TouchContainer | |
![]() | updateRelativePos():void
Updates child relative positions within this container
| TouchContainer |
align | property |
align:String
Specifies the StageAlign type.
public function get align():String
public function set align(value:String):void
color | property |
color:uint
Specifies the color of the stage. FlashPlayer 11.0+ only.
The default value is 0xFFFFFF //
.
public function get color():uint
public function set color(value:uint):void
displayFrameRate | property |
public var displayFrameRate:Boolean = false
Display the frame rate
escapeSprite | property |
public var escapeSprite:Boolean = false
Display sprite to exit full screen on touch
esColor | property |
public var esColor:uint = 0xFFFFFF
Escape sprite color
esX | property |
public var esX:Number = 0
Escape sprite x position
esY | property |
public var esY:Number = 0
Escape sprite y position
frameRate | property |
frameRate:Number
public function get frameRate():Number
public function set frameRate(value:Number):void
frColor | property |
public var frColor:uint = 0xFFFFFF
Frame rate color
frX | property |
public var frX:Number = 0
Frame rate x position
frY | property |
public var frY:Number = 0
Frame rate y position
fullscreen | property |
fullscreen:Boolean
Specifies whether or not to set the stage to fullscreen Choose: true or false
The default value is false
.
public function get fullscreen():Boolean
public function set fullscreen(value:Boolean):void
height | property |
height:Number
[override] Specifies the width of the screen. AIR only.
The default value is 0
.
public function get height():Number
public function set height(value:Number):void
scaleMode | property |
scaleMode:String
Specifies the scale mode for the stage.
public function get scaleMode():String
public function set scaleMode(value:String):void
width | property |
width:Number
[override] Specifies the width of the screen. AIR only.
The default value is 0
.
public function get width():Number
public function set width(value:Number):void
StageKit | () | Constructor |
public function StageKit()
Constructor
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