GODPAPER | All Packages | All Classes | Index | Frames No Frames |
Stage

Package | starling.display
Class | public class Stage
Inheritance | Stage DisplayObjectContainer DisplayObject EventDispatcher Object

A Stage represents the root of the display tree. Only objects that are direct or indirect children of the stage will be rendered.

This class represents the Starling version of the stage. Don't confuse it with its Flash equivalent: while the latter contains objects of the type `flash.display.DisplayObject`, the Starling stage contains only objects of the type `starling.display.DisplayObject`. Those classes are not compatible, and you cannot exchange one type with the other.

A stage object is created automatically by the `Starling` class. Don't create a Stage instance manually.

Keyboard Events

In Starling, keyboard events are only dispatched at the stage. Add an event listener directly to the stage to be notified of keyboard events.

Resize Events

When the Flash player is resized, the stage dispatches a `ResizeEvent`. The event contains properties containing the updated width and height of the Flash player.

See also

starling.events.KeyboardEvent
starling.events.ResizeEvent

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | alpha : Number The opacity of the object. | DisplayObject
|  | base : DisplayObject [read-only] The topmost object in the display tree the object is part of. | DisplayObject
|  | blendMode : String The blend mode determines how the object is blended with the objects underneath. | DisplayObject
|  | bounds : Rectangle [read-only] The bounds of the object relative to the local coordinates of the parent. | DisplayObject
|  | color : uint The background color of the stage. | Stage
|  | filter : FragmentFilter The filter that is attached to the display object. | DisplayObject
|  | hasVisibleArea : Boolean [read-only] Indicates if an object occupies any visible area. | DisplayObject
|  | height : Number The height of the object in pixels. | DisplayObject
|  | name : String The name of the display object (default: null). | DisplayObject
|  | numChildren : int [read-only] The number of children of this container. | DisplayObjectContainer
|  | parent : DisplayObjectContainer [read-only] The display object container that contains this display object. | DisplayObject
|  | pivotX : Number The x coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject
|  | pivotY : Number The y coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject
|  | root : DisplayObject [read-only] The root object the display object is connected to (i.e. | DisplayObject
|  | rotation : Number The rotation of the object in radians. | DisplayObject
|  | scaleX : Number The horizontal scale factor. | DisplayObject
|  | scaleY : Number The vertical scale factor. | DisplayObject
|  | skewX : Number The horizontal skew angle in radians. | DisplayObject
|  | skewY : Number The vertical skew angle in radians. | DisplayObject
|  | stage : Stage [read-only] The stage the display object is connected to, or null if it is not connected to the stage. | DisplayObject
|  | stageHeight : int The height of the stage coordinate system. | Stage
|  | stageWidth : int The width of the stage coordinate system. | Stage
|  | touchable : Boolean Indicates if this object (and its children) will receive touch events. | DisplayObject
|  | transformationMatrix : Matrix The transformation matrix of the object relative to its parent. | DisplayObject
|  | useHandCursor : Boolean Indicates if the mouse cursor should transform into a hand while it's over the sprite. | DisplayObject
|  | visible : Boolean The visibility of the object. | DisplayObject
|  | width : Number The width of the object in pixels. | DisplayObject
|  | x : Number The x coordinate of the object relative to the local coordinates of the parent. | DisplayObject
|  | y : Number The y coordinate of the object relative to the local coordinates of the parent. | DisplayObject

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | addChild(child:DisplayObject):DisplayObject Adds a child to the container. | DisplayObjectContainer
|  | addChildAt(child:DisplayObject, index:int):DisplayObject Adds a child to the container at a certain index. | DisplayObjectContainer
|  | addEventListener(type:String, listener:Function):void [override] | DisplayObject
|  | advanceTime(passedTime:Number):void | Stage
|  | alignPivot(hAlign:String = center, vAlign:String = center):void Moves the pivot point to a certain position within the local coordinate system of the object. | DisplayObject
|  | broadcastEvent(event:Event):void Dispatches an event on all children (recursively). | DisplayObjectContainer
|  | broadcastEventWith(type:String, data:Object = null):void Dispatches an event with the given parameters on all children (recursively). | DisplayObjectContainer
|  | contains(child:DisplayObject):Boolean Determines if a certain object is a child of the container (recursively). | DisplayObjectContainer
|  | dispatchEvent(event:Event):void Dispatches an event to all objects that have registered listeners for its type. | EventDispatcher
|  | dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void Dispatches an event with the given parameters to all objects that have registered listeners for the given type. | EventDispatcher
|  | dispose():void [override] Disposes the resources of all children. | DisplayObjectContainer
|  | drawToBitmapData(destination:BitmapData = null):BitmapData Draws the complete stage into a BitmapData object. | Stage
|  | getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override] Returns a rectangle that completely encloses the object as it appears in another coordinate system. | DisplayObjectContainer
|  | getChildAt(index:int):DisplayObject Returns a child object at a certain index. | DisplayObjectContainer
|  | getChildByName(name:String):DisplayObject Returns a child object with a certain name (non-recursively). | DisplayObjectContainer
|  | getChildIndex(child:DisplayObject):int Returns the index of a child within the container, or "-1" if it is not found. | DisplayObjectContainer
|  | getTransformationMatrix(targetSpace:DisplayObject, resultMatrix:Matrix = null):Matrix Creates a matrix that represents the transformation from the local coordinate system to another. | DisplayObject
|  | globalToLocal(globalPoint:Point, resultPoint:Point = null):Point Transforms a point from global (stage) coordinates to the local coordinate system. | DisplayObject
|  | hasEventListener(type:String):Boolean Returns if there are listeners registered for a certain event type. | EventDispatcher
|  | hitTest(localPoint:Point, forTouch:Boolean = false):DisplayObject [override] Returns the object that is found topmost beneath a point in stage coordinates, or the stage itself if nothing else is found. | Stage
|  | localToGlobal(localPoint:Point, resultPoint:Point = null):Point Transforms a point from the local coordinate system to global (stage) coordinates. | DisplayObject
|  | removeChild(child:DisplayObject, dispose:Boolean = false):DisplayObject Removes a child from the container. | DisplayObjectContainer
|  | removeChildAt(index:int, dispose:Boolean = false):DisplayObject Removes a child at a certain index. | DisplayObjectContainer
|  | removeChildren(beginIndex:int = 0, endIndex:int = -1, dispose:Boolean = false):void Removes a range of children from the container (endIndex included). | DisplayObjectContainer
|  | removeEventListener(type:String, listener:Function):void [override] | DisplayObject
|  | removeEventListeners(type:String = null):void [override] | DisplayObject
|  | removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one, and optionally disposes it. | DisplayObject
|  | render(support:RenderSupport, parentAlpha:Number):void [override] Renders the display object with the help of a support object. | DisplayObjectContainer
|  | setChildIndex(child:DisplayObject, index:int):void Moves a child to a certain index. | DisplayObjectContainer
|  | sortChildren(compareFunction:Function):void Sorts the children according to a given function (that works just like the sort function of the Vector class). | DisplayObjectContainer
|  | swapChildren(child1:DisplayObject, child2:DisplayObject):void Swaps the indexes of two children. | DisplayObjectContainer
|  | swapChildrenAt(index1:int, index2:int):void Swaps the indexes of two children. | DisplayObjectContainer

Events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | added | Dispatched when an object is added to a parent. | DisplayObject
|  | addedToStage | Dispatched when an object is connected to the stage (directly or indirectly). | DisplayObject
|  | enterFrame | Dispatched once every frame on every object that is connected to the stage. | DisplayObject
|  | keyDown | Dispatched when a key on the keyboard is pressed. | DisplayObject
|  | keyUp | Dispatched when a key on the keyboard is released. | DisplayObject
|  | removed | Dispatched when an object is removed from its parent. | DisplayObject
|  | removedFromStage | Dispatched when an object is removed from the stage and won't be rendered any longer. | DisplayObject
|  | resize | Dispatched when the Flash container is resized. | Stage
|  | touch | Dispatched when an object is touched. | DisplayObject

Property Detail

color | property

`color:uint`

The background color of the stage.

Implementation
`public function get color():uint`
`public function set color(value:uint):void`

stageHeight | property |

`stageHeight:int`

The height of the stage coordinate system. Change it to scale its contents relative to the `viewPort` property of the Starling object.

Implementation
`public function get stageHeight():int`
`public function set stageHeight(value:int):void`

stageWidth | property |

`stageWidth:int`

The width of the stage coordinate system. Change it to scale its contents relative to the `viewPort` property of the Starling object.

Implementation
`public function get stageWidth():int`
`public function set stageWidth(value:int):void`
Method Detail

advanceTime | () | method

`public function advanceTime(passedTime:Number):void`

Parameters

| `passedTime:Number`

drawToBitmapData | () | method |

`public function drawToBitmapData(destination:BitmapData = null):BitmapData`

Draws the complete stage into a BitmapData object. If you don't pass a parameter, the object will be created for you. If you pass a BitmapData object to the method, it should have the size of the back buffer (which is accessible via the respective properties on the Starling instance).

Parameters

| `destination:BitmapData` (default = `null`)``

Returns

| `BitmapData`

hitTest | () | method |

`override public function hitTest(localPoint:Point, forTouch:Boolean = false):DisplayObject`

Returns the object that is found topmost beneath a point in stage coordinates, or the stage itself if nothing else is found.

Parameters

| `localPoint:Point`
| `forTouch:Boolean` (default = `false`)``

Returns

| `DisplayObject`

Event Detail

resize | Event

Event Object Type: `starling.events.ResizeEvent`

Dispatched when the Flash container is resized.

Thu Jan 16 2014, 01:11 PM +08:00