Skip to content
This repository was archived by the owner on Oct 26, 2021. It is now read-only.

Api package

Jump to bottom
mzyndul edited this page Nov 23, 2012 · 1 revision

Table of Contents

Overview 

 com.gaiaframework.api

This section covers the interface classes that make up the API package for Gaia AS3. In Gaia AS2, these methods are available on the Asset classes themselves.


Asset Interfaces

The following are the interface properties and methods for Gaia assets. For specific information on their usage, please refer to the Assets documentation.


IAsset

IAsset is the base interface from which all the concrete asset interfaces inherit, and is implemented by AbstractAsset in the Assets Package. 

 function load(...args):void;
 function abort():void;
 function getBytesLoaded():int;
 function getBytesTotal():int;
 function get percentLoaded():Number;
 function get id():String;
 function get src():String;
 function set src(value:String):void;
 function get title():String;
 function set title(value:String):void;
 function get preloadAsset():Boolean;
 function set preloadAsset(value:Boolean):void;
 function get showProgress():Boolean;
 function set showProgress(value:Boolean):void;
 function get bytes():int;
 function get order():int;
 function get node():XML;


IDisplayObject

IDisplayObject extends IAsset and contains three custom properties as well as all the properties and methods available in the DisplayObject class in Flash. 

 function get depth():String;
 function set depth(value:String):void;
 function get content():DisplayObject;


IBitmap

IBitmap extends IDisplayObject and contains all the properties available in the Bitmap class in Flash.


ISprite

ISprite extends IDisplayObject and contains all the methods and properties available in the Sprite, DisplayObjectContainer, and InteractiveObject classes in Flash. It also includes the domain property for accessing the Application Domain of the swf. 

 function get domain():String;
 function set domain(value:String):void;


IMovieClip

IMovieClip extends ISprite and contains all the methods and properties available in the MovieClip class in Flash.


IPageAsset

IPageAsset extends IMovieClip and contains all the public methods and properties available in the PageAsset class in Gaia. The following are the methods and properties you may need to access. 

 function get children():Object;
 function get assets():Object;
 function get external():Boolean;
 function get flow():String;
 function set flow(value:String):void;
 function get defaultChild():String;
 function set defaultChild(value:String):void;
 function get route():String;
 function get branch():String;
 function getParent():IPageAsset;


ISound

ISound extends IAsset and contains one custom property and three custom methods, as well as all the methods and properties available in the Sound class in Flash. 

 function get sound():Sound;
 function pause(flag:Boolean):void;
 function fadeTo(value:Number, duration:uint, onComplete: function = null):void;
 function panTo(value:Number, duration:uint, onComplete: function = null):void;
 function loadWithoutPlaying():void;


INetStream

INetStream extends IAsset and contains three custom properties and two custom methods, as well as all the methods and properties available in the NetStream class in Flash. 

 function get ns():NetStream;
 function get volume():Number;
 function set volume(volume:Number):void;
 function get pan():Number;
 function set pan(pan:Number):void;
 function fadeTo(volume:Number, duration:uint, onComplete: function = null):void;
 function panTo(pan:Number, duration:uint, onComplete: function = null):void;
 function attach(video:Video):void;


IText

IText extends IAsset. It contains a single custom property. 

 function get text():String;


IXml

IXml extends IAsset and contains a single custom property. 

 function get xml():XML;


IStyleSheet

IStyleSheet extends IAsset and contains one custom property and one custom method, as well as all the methods available in the StyleSheet class in Flash. 

 function get style():StyleSheet;
 function transformStyle(styleName:String):TextFormat;


Template Interfaces

The following are the interface properties and methods for the Gaia scaffolded template files.


IBase

IBase is the base interface from which IPage and IPreloader inherit. It contains the four Gaia methods that all pages require. 

 function transitionIn():void;
 function transitionOut():void;
 function transitionInComplete():void;
 function transitionOutComplete():void;


IPage

IPage extends IBase and is implemented by AbstractPage in the Templates Package 

 function get page():IPageAsset;
 function set page(value:IPageAsset):void;
 function get assets():Object;
 function get copy():Object;
 function onDeeplink(event:GaiaSWFAddressEvent):void;


IPreloader

IPreloader extends IBase and is implemented by AbstractPreloader in the Templates Package. Custom preloaders must implement this interface either directly or by extending AbstractPreloader(recommended). 

 function onProgress(event:AssetEvent):void;

Clone this wiki locally