| Package | sekati.display |
| Class | public class DocumentPreloader |
| Inheritance | DocumentPreloader  flash.display.Sprite |
| Subclasses | SekatiPreloader |
DocumentPreloader class is an API independent shell designed to load Sekati API Document driven SWF applications.
In other words; the DocumentPreloader should be extended and used as the Main Document Class for any preloader SWF use to load an
API driven SWF.
Main methods which may be overridden and customized:
initUIIntro - initialize the look & feel of the preloader UI: must set introComplete = true when finished.initUIOutro - initialize the outro sequence of the preloader UI: must set outroComplete = true when finished.Secondary methods which may be overriden and customized:
initMovieProperties - initialize SWF movie properties (Stage, fscommand, etc).progress - invoked during the application loading process, you may use the properties percent, bytesLoaded, bytesTotalresize - invoked when the stage initializes and resizes for liquid layout preloaders.Note: that the API Application SWF Bootstrap sequence will begin once the loaded API swf is added to the stage via initApplication().
See also
| Property | Defined by | ||
|---|---|---|---|
| APPLICATION_URI : String [static]
The API Application SWF URI to be loaded (ascertained from the
config.xml). | DocumentPreloader | ||
| bytesLoaded : Number [read-only]
The number of loaded bytes of the Application SWF.
| DocumentPreloader | ||
| bytesTotal : Number [read-only]
The number of total bytes of the Application SWF.
| DocumentPreloader | ||
| CONF_URI : String [static]
The
config.xml location used by the DocumentPreloader and Document
passed via FlashVars or defaulting to xml/config.xml. | DocumentPreloader | ||
| percent : Number [read-only]
The percentage (
0 - 1 scale) of the Application SWF currently loaded. | DocumentPreloader | ||
| Property | Defined by | ||
|---|---|---|---|
| introComplete : Boolean
Property set by
initUIIntro() when the intro sequence completes. | DocumentPreloader | ||
| outroComplete : Boolean
Property set by
initUIOutro() when the outro sequence completes. | DocumentPreloader | ||
| Method | Defined by | ||
|---|---|---|---|
|
DocumentPreloader Constructor
| DocumentPreloader | ||
| Method | Defined by | ||
|---|---|---|---|
|
applicationHandler(e:Event):void
The API Appliction SWF has been loaded; wait for notification from
initUIOutro to set outroComplete. | DocumentPreloader | ||
|
configHandler(e:Event):void
The
config.xml has loaded; wait for notification from initUIIntro to set introComplete. | DocumentPreloader | ||
|
initApplication():void
Initialize the loaded API Application SWF.
| DocumentPreloader | ||
|
initApplicationLoader():void
Load the API Application SWF.
| DocumentPreloader | ||
|
initDocumentPreloader(e:Event = null):void
Initializes the preloader and movie properties when the stage becomes available.
| DocumentPreloader | ||
|
initMovieProperties():void
Initializes SWF movie properties.
| DocumentPreloader | ||
|
initPreloader(e:Event = null):void
Initialize the Document Preloader UI & load the
config.xml (invoked when the preloader SWF itself is done loading). | DocumentPreloader | ||
|
initUIIntro():void
Initialize the preloader UI intro and set
introComplete = true; when UI has completed build up. | DocumentPreloader | ||
|
initUIOutro():void
Initialize the preloader UI outro and set
outroComplete = true; when UI has completed tear down. | DocumentPreloader | ||
|
progress(e:ProgressEvent):void
API Application SWF progress handler.
| DocumentPreloader | ||
|
resize(e:Event = null):void
Stub function to invoke upon a stage resize.
| DocumentPreloader | ||
| APPLICATION_URI | property |
public static var APPLICATION_URI:String
The API Application SWF URI to be loaded (ascertained from the config.xml).
| bytesLoaded | property |
bytesLoaded:Number [read-only]The number of loaded bytes of the Application SWF.
Implementation public function get bytesLoaded():Number
| bytesTotal | property |
bytesTotal:Number [read-only]The number of total bytes of the Application SWF.
Implementation public function get bytesTotal():Number
| CONF_URI | property |
public static var CONF_URI:String
The config.xml location used by the DocumentPreloader and Document
passed via FlashVars or defaulting to xml/config.xml.
| introComplete | property |
protected var introComplete:Boolean
Property set by initUIIntro() when the intro sequence completes.
| outroComplete | property |
protected var outroComplete:Boolean
Property set by initUIOutro() when the outro sequence completes.
| percent | property |
percent:Number [read-only]
The percentage (0 - 1 scale) of the Application SWF currently loaded.
public function get percent():Number
| DocumentPreloader | () | constructor |
public function DocumentPreloader()DocumentPreloader Constructor
| applicationHandler | () | method |
protected function applicationHandler(e:Event):void
The API Appliction SWF has been loaded; wait for notification from initUIOutro to set outroComplete.
e:Event |
| configHandler | () | method |
protected function configHandler(e:Event):void
The config.xml has loaded; wait for notification from initUIIntro to set introComplete.
e:Event |
| initApplication | () | method |
protected function initApplication():voidInitialize the loaded API Application SWF.
Customization: Override this method to delay API SWF initialization, and execute any visual preloader 'outro' sequence before application initializes. If this method is not overridden, the API SWF will initialize as soon as its load completes.
| initApplicationLoader | () | method |
protected function initApplicationLoader():voidLoad the API Application SWF.
| initDocumentPreloader | () | method |
protected function initDocumentPreloader(e:Event = null):voidInitializes the preloader and movie properties when the stage becomes available.
Parameterse:Event (default = null) |
| initMovieProperties | () | method |
protected function initMovieProperties():voidInitializes SWF movie properties.
Customization: Override this method & adjust to fit your application specification.
| initPreloader | () | method |
protected function initPreloader(e:Event = null):void
Initialize the Document Preloader UI & load the config.xml (invoked when the preloader SWF itself is done loading).
e:Event (default = null) |
| initUIIntro | () | method |
protected function initUIIntro():void
Initialize the preloader UI intro and set introComplete = true; when UI has completed build up.
Customization: Override this method to execute any custom intro code for a the visual preloader.
| initUIOutro | () | method |
protected function initUIOutro():void
Initialize the preloader UI outro and set outroComplete = true; when UI has completed tear down.
Customization: Override this method to execute any custom outro code for a visual preloader.
| progress | () | method |
protected function progress(e:ProgressEvent):voidAPI Application SWF progress handler.
Customization: Override this method to execute any custom code to visualize progress in your preloader.
Parameterse:ProgressEvent |
| resize | () | method |
protected function resize(e:Event = null):voidStub function to invoke upon a stage resize.
Customization: Override this method to execute any custom resize logic as the API has yet to initialize.
Parameterse:Event (default = null) |