| Package | com.gaiaframework.api |
| Interface | public interface IPageAsset extends IMovieClip, ISprite, IDisplayObject, IAsset, flash.events.IEventDispatcher |
PageAsset. PageAsset extends MovieClipAsset.
See also
| Property | Defined by | ||
|---|---|---|---|
 | accessibilityProperties : AccessibilityProperties | IDisplayObject | |
| alpha : Number | IDisplayObject | |
| assetArray : Array [read-only]
Returns an array of the assets in the order they are listed in the site.xml.
| IPageAsset | ||
| assetPath : String
Use this attribute to set the folder paths for all assets of that page.
| IPageAsset | ||
| assets : Object
A hash of the Page's assets (stored by their id).
| IPageAsset | ||
| blendMode : String | IDisplayObject | |
| branch : String [read-only]
Returns the page's branch, starting from the index page.
| IPageAsset | ||
| buttonMode : Boolean | ISprite | |
| bytes : int
Returns the bytes attribute value set in the
site.xml for byte-accurate preloading. | IAsset | |
| cacheAsBitmap : Boolean | IDisplayObject | |
| children : Object [read-only]
A hash of the Page's child Pages (stored by their id).
| IPageAsset | ||
| container : DisplayObject
[read-only] BitmapSpriteAssets return the Sprite containing the Loader and MovieClipAssets return the Loader.
| ISprite | |
| content : MovieClip
Returns the loader.content MovieClip.
| IMovieClip | |
| contextMenu : ContextMenu | ISprite | |
| copy : Object [read-only]
A hash of the Page's copy (stored by their id).
| IPageAsset | ||
| currentFrame : int | IMovieClip | |
| currentLabel : String | IMovieClip | |
| currentLabels : Array | IMovieClip | |
| defaultChild : String
This is set to the first child of the Page from the site.xml structure by default.
| IPageAsset | ||
| depth : String
Specifies the depth container the asset is assigned to.
| IDisplayObject | |
| domain : String
Specifies the ApplicationDomain the Asset should load into.
| ISprite | |
| doubleClickEnabled : Boolean | ISprite | |
| dropTarget : DisplayObject | ISprite | |
| enabled : Boolean | IMovieClip | |
| external : Boolean [read-only]
Returns true if the page is external, and false if the page is internal.
| IPageAsset | ||
| filters : Array | IDisplayObject | |
| flow : String
Returns the custom flow the page uses.
| IPageAsset | ||
| focusRect : Object | ISprite | |
| framesLoaded : int | IMovieClip | |
| graphics : Graphics | ISprite | |
| height : Number | IDisplayObject | |
| hitArea : Sprite | ISprite | |
| id : String
Returns the ID as set in
site.xml. | IAsset | |
| landing : Boolean
If you want to override Gaia's default behavior of loading the default child of a page branch, set landing="true" and Gaia will stop on this page if you tell it to goto this page.
| IPageAsset | ||
| loader : Loader
Returns the loader.
| IDisplayObject | |
| mask : DisplayObject | IDisplayObject | |
| menu : Boolean
Returns a Boolean whether the page will appear in the context menu.
| IPageAsset | ||
| mouseChildren : Boolean | ISprite | |
| mouseEnabled : Boolean | ISprite | |
| mouseX : Number | IDisplayObject | |
| mouseY : Number | IDisplayObject | |
| name : String | IDisplayObject | |
| node : XML
Returns the raw XML node of the asset
| IAsset | |
| numChildren : int | ISprite | |
| opaqueBackground : Object | IDisplayObject | |
| order : int
Returns the load order and position of the asset relative to other assets of the page.
| IAsset | |
| parent : DisplayObjectContainer | IDisplayObject | |
| percentLoaded : Number
Returns the bytesLoaded / bytesTotal.
| IAsset | |
| preloadAsset : Boolean
Specifies a value of
true if the asset is set to preload, or false if it is on-demand. | IAsset | |
| root : DisplayObject | IDisplayObject | |
| rotation : Number | IDisplayObject | |
| route : String [read-only]
Returns the route of the page if set in the site.xml.
| IPageAsset | ||
| scale9Grid : Rectangle | IDisplayObject | |
| scaleX : Number | IDisplayObject | |
| scaleY : Number | IDisplayObject | |
| scrollRect : Rectangle | IDisplayObject | |
| showProgress : Boolean
Specifies whether the asset will cause the asset preloader to appear when loaded on-demand.
| IAsset | |
| soundTransform : SoundTransform | ISprite | |
| src : String
Returns the source path of the asset.
| IAsset | |
| stage : Stage | IDisplayObject | |
| tabChildren : Boolean | ISprite | |
| tabEnabled : Boolean | ISprite | |
| tabIndex : int | ISprite | |
| title : String
Specifies the title of the asset.
| IAsset | |
| totalFrames : int | IMovieClip | |
| trackAsMenu : Boolean | IMovieClip | |
| transform : Transform | IDisplayObject | |
| useHandCursor : Boolean | ISprite | |
| visible : Boolean | IDisplayObject | |
| width : Number | IDisplayObject | |
| window : String
If the page is external (src attribute is not a swf or a javascript method), you can define the target window it will open up in.
| IPageAsset | ||
| x : Number | IDisplayObject | |
| y : Number | IDisplayObject | |
| Method | Defined by | ||
|---|---|---|---|
|
abort():void
Used to manually abort an on-demand asset load.
| IAsset | |
|
addChild(child:DisplayObject):DisplayObject
| ISprite | |
|
addChildAt(child:DisplayObject, index:int):DisplayObject
| ISprite | |
|
areInaccessibleObjectsUnderPoint(point:Point):Boolean
| ISprite | |
|
contains(child:DisplayObject):Boolean
| ISprite | |
|
getBounds(obj:DisplayObject):Rectangle
| IDisplayObject | |
|
getBytesLoaded():int
Returns the loaded bytes of the file.
| IAsset | |
|
getBytesTotal():int
Returns the total bytes of the file.
| IAsset | |
|
getChildAt(index:int):DisplayObject
| ISprite | |
|
getChildByName(name:String):DisplayObject
| ISprite | |
|
getChildIndex(child:DisplayObject):int
| ISprite | |
|
getObjectsUnderPoint(point:Point):Array
| ISprite | |
|
[read-only] This method returns the page's parent PageAsset.
| IPageAsset | ||
|
getRect(obj:DisplayObject):Rectangle
| IDisplayObject | |
|
globalToLocal(point:Point):Point
| IDisplayObject | |
|
gotoAndPlay(value:Object):void
| IMovieClip | |
|
gotoAndStop(value:Object):void
| IMovieClip | |
|
hitTestObject(obj:DisplayObject):Boolean
| IDisplayObject | |
|
hitTestPoint(px:Number, py:Number, shapeFlag:Boolean = false):Boolean
| IDisplayObject | |
|
load(... args):void
Used to load assets on-demand.
| IAsset | |
|
localToGlobal(point:Point):Point
| IDisplayObject | |
|
nextFrame():void
| IMovieClip | |
|
play():void
| IMovieClip | |
|
prevFrame():void
| IMovieClip | |
|
removeChild(child:DisplayObject):DisplayObject
| ISprite | |
|
removeChildAt(index:int):DisplayObject
| ISprite | |
|
setChildIndex(child:DisplayObject, index:int):void
| ISprite | |
|
startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void
| ISprite | |
|
stop():void
| IMovieClip | |
|
stopDrag():void
| ISprite | |
|
swapChildren(child1:DisplayObject, child2:DisplayObject):void
| ISprite | |
|
swapChildrenAt(index1:int, index2:int):void
| ISprite | |
| assetArray | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesassetArray:Array [read-only]Returns an array of the assets in the order they are listed in the site.xml. This getter creates the array on the fly every time in order to support dynamically added assets, so make sure you store a reference to it when iterating through it, otherwise you will be recreating the Array every iteration - not good!
var assetArray:Array = page.assetArray;
var len:int = assetArray.length;
for (var i:int = 0; i < len; i++)
{
trace(assetArray[i]);
}
public function get assetArray():Array
| assetPath | property |
assetPath:String [read-write]Use this attribute to set the folder paths for all assets of that page. All assets inside this page will load from this folder path so you can organize your assets without bloating your site.xml. Make sure your assetPath ends in a forward slash! You can use ../ in the asset node src attribute to go up to parent folders. This trumps the site node assetPath for the page that it is set on.
Implementation public function get assetPath():String
public function set assetPath(value:String):void
| assets | property |
assets:Object [read-write]A hash of the Page's assets (stored by their id).
Implementation public function get assets():Object
public function set assets(value:Object):void
| branch | property |
branch:String [read-only]Returns the page's branch, starting from the index page.
Implementation public function get branch():String
| children | property |
children:Object [read-only]A hash of the Page's child Pages (stored by their id).
Implementation public function get children():Object
| copy | property |
copy:Object [read-only]A hash of the Page's copy (stored by their id).
Implementation public function get copy():Object
See also
| defaultChild | property |
defaultChild:String [read-write]This is set to the first child of the Page from the site.xml structure by default. You can set this during runtime. One good use for this is if an intro page is the first child of a Page and you want to not go back to the intro from then on if you navigate to the intro page's parent page, you can set the parent's defaultChild to another of its children. This is also helpful during development if you want Gaia to go straight to a specific child.
Implementation public function get defaultChild():String
public function set defaultChild(value:String):void
| external | property |
external:Boolean [read-only]Returns true if the page is external, and false if the page is internal.
Implementation public function get external():Boolean
| flow | property |
flow:String [read-write]Returns the custom flow the page uses. This is null by default.
Implementation public function get flow():String
public function set flow(value:String):void
| landing | property |
landing:Boolean [read-write]If you want to override Gaia's default behavior of loading the default child of a page branch, set landing="true" and Gaia will stop on this page if you tell it to goto this page.
Implementation public function get landing():Boolean
public function set landing(value:Boolean):void
| menu | property |
menu:Boolean [read-write]Returns a Boolean whether the page will appear in the context menu. true if the page appears in the context menu, and false if not.
Implementation public function get menu():Boolean
public function set menu(value:Boolean):void
| route | property |
route:String [read-only]Returns the route of the page if set in the site.xml. If you don't want the page's title to be its "pretty URL", or if your page title contains a special character which cannot be displayed in the address bar (such as non-Latin characters), set the value of this attribute for the page's url in the address bar. Routes must be unique and can only be applied to terminal pages (pages that have no children).
Implementation public function get route():String
See also
| window | property |
window:String [read-write]If the page is external (src attribute is not a swf or a javascript method), you can define the target window it will open up in. The default is "_self". If you want it to open in a new window, use "_blank".
Implementation public function get window():String
public function set window(value:String):void
| getParent | () | method |
public function getParent():IPageAsset[read-only] This method returns the page's parent PageAsset.
ReturnsIPageAsset |