| Package | com.jeffdePascale.fosfr.navigation.loaders |
| Class | public class SubLoader |
| Inheritance | SubLoader NavLoaderPrototype flash.events.EventDispatcher |
See also
| Property | Defined by | ||
|---|---|---|---|
![]() | available : Boolean | NavLoaderPrototype | |
| isLoading : Boolean [read-only]
Boolean, specifies whether a SubSWF file is currently loading.
| SubLoader | ||
![]() | loaderContext : LoaderContext
The LoaderContext to be used for the Loader instance.
| NavLoaderPrototype | |
![]() | loaderState : String
A string value from the
LoaderSate class, defining what the current state the loader is in. | NavLoaderPrototype | |
![]() | loadID : int
The ID value of the SubSWF file currently being loaded, relative to the
NavArray instance in the fosfr.navigation class. | NavLoaderPrototype | |
![]() | loadURL : String
The full relative URL of the file currently being loaded.
| NavLoaderPrototype | |
![]() | pauseAfterPreload : Boolean
Boolean value, specifies whether to complete the loading process after the preload has completed or to hold at the end of the preload state until
advanceLoader() is called. | NavLoaderPrototype | |
![]() | pauseBeforePreload : Boolean
Boolean value, specifies whether to start the preloading process after a load is initialized or to hold at the intialized state until
advanceLoader() is called. | NavLoaderPrototype | |
![]() | preloadSkipped : Boolean
Boolean value, specifies whether the preload actions were skipped on this load occurrence.
| NavLoaderPrototype | |
![]() | prequel : Prequel
The instance of the Prequel class utlized in the load process.
| NavLoaderPrototype | |
| Method | Defined by | ||
|---|---|---|---|
|
Creates an instance of the
SubLoader class. | SubLoader | ||
![]() |
advanceLoader():void
| NavLoaderPrototype | |
|
load(target:*, __deepLink:Array = null, __loadVariables:Object = null, _skipPreload:Boolean = false, preloadArray:Array = null, swfAddressChange:Boolean = true, forcedFullPageName:String = null):void
Begins the loading process for the file specified in the str parameter.
| SubLoader | ||
|
unloadSubSWF():void
Unloads the currently loaded SubSWF without loading a replacement.
| SubLoader | ||
| Method | Defined by | ||
|---|---|---|---|
|
finalizeLoad():void
| SubLoader | ||
![]() |
resetProperties():void
| NavLoaderPrototype | |
| isLoading | property |
isLoading:Boolean [read-only]Boolean, specifies whether a SubSWF file is currently loading.
Implementation public function get isLoading():Boolean
| SubLoader | () | constructor |
public function SubLoader(_fosfr:Fosfr)
Creates an instance of the SubLoader class.
_fosfr:Fosfr — An instance of the Fosfr class.
|
See also
| finalizeLoad | () | method |
protected override function finalizeLoad():void
| load | () | method |
public function load(target:*, __deepLink:Array = null, __loadVariables:Object = null, _skipPreload:Boolean = false, preloadArray:Array = null, swfAddressChange:Boolean = true, forcedFullPageName:String = null):void
Begins the loading process for the file specified in the str parameter. The extension ".swf" is automatically applied to the string value, and the rootFolder property of the Fosfr class is respected.
target:* — a string value minus the ".swf" file extension of a FosfrSubSWF based file to be loaded. Alternatively, the numerical identifier from the Navigation.navArray instance may be used.
|
|
__deepLink:Array (default = null) — optional; An object passed on instatiation of the FosfrSubSWF file. Useful for passing parameters to the loaded SubSWF. Defaults to null.
|
|
__loadVariables:Object (default = null) — optional; specifies whether preloading should be skipped during the load process. Defaults to false.
|
|
_skipPreload:Boolean (default = false) — optional; specifies whether swfAddress events should be dispatched for loading of the SubSWF file. Defaults to true.
|
|
preloadArray:Array (default = null) — forcedFullPageName A string value to add to the NavArray element for this file, overriding the value specified in the configuration file, specifying what is displayed in the Title for the site for this SubSWF if enableSWFAddress is set to true in the Navigation class.
|
|
swfAddressChange:Boolean (default = true) |
|
forcedFullPageName:String (default = null) |
See also
| unloadSubSWF | () | method |
public function unloadSubSWF():voidUnloads the currently loaded SubSWF without loading a replacement.