Packagecom.jeffdePascale.fosfr.navigation.loaders
Classpublic class NavLoaderPrototype
InheritanceNavLoaderPrototype Inheritance flash.events.EventDispatcher
SubclassesShellLoader, SubLoader

The prototype class for the ShellLoader and SubLoader classes. Handles preloading and loading of all files loaded into a Fosfr project. Contains an implementation of Prequel for handling of Preload functionality. For more information, see the documentation for Prequel at


Public Properties
 PropertyDefined by
  available : Boolean
NavLoaderPrototype
  loaderContext : LoaderContext
The LoaderContext to be used for the Loader instance.
NavLoaderPrototype
  loaderState : String
[read-only] A string value from the LoaderSate class, defining what the current state the loader is in.
NavLoaderPrototype
  loadID : int
[read-only] The ID value of the SubSWF file currently being loaded, relative to the NavArray instance in the fosfr.navigation class.
NavLoaderPrototype
  loadURL : String
[read-only] 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
[read-only] Boolean value, specifies whether the preload actions were skipped on this load occurrence.
NavLoaderPrototype
  prequel : Prequel
[read-only] The instance of the Prequel class utlized in the load process.
NavLoaderPrototype
Public Methods
 MethodDefined by
  
NavLoaderPrototype(_fosfr:Fosfr)
Creates an instance of the NavLoaderPrototype class
NavLoaderPrototype
  
advanceLoader():void
NavLoaderPrototype
Protected Methods
 MethodDefined by
  
resetProperties():void
NavLoaderPrototype
Events
 EventSummaryDefined by
  
complete
Dispatched when the loading process has completed.NavLoaderPrototype
  
init
Dispatched when the loading process has started.NavLoaderPrototype
  
preloadComplete
Dispatched when the preload process has completed.NavLoaderPrototype
  
preloadInit
Dispatched when the preload process has started.NavLoaderPrototype
Property detail
availableproperty
public var available:Boolean
loaderContextproperty 
public var loaderContext:LoaderContext

The LoaderContext to be used for the Loader instance.

loaderStateproperty 
loaderState:String  [read-only]

A string value from the LoaderSate class, defining what the current state the loader is in.

The default value is com.jeffdePascale.fosfr.navigation.loaders.LoaderState.IDLE.

Implementation
    public function get loaderState():String

See also

com.jeffdePascale.fosfr.navigation.loaders.LoaderState
loadIDproperty 
loadID:int  [read-only]

The ID value of the SubSWF file currently being loaded, relative to the NavArray instance in the fosfr.navigation class.

Implementation
    public function get loadID():int
loadURLproperty 
loadURL:String  [read-only]

The full relative URL of the file currently being loaded.

Implementation
    public function get loadURL():String
pauseAfterPreloadproperty 
public var 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.

The default value is false.

pauseBeforePreloadproperty 
public var 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.

The default value is false.

preloadSkippedproperty 
preloadSkipped:Boolean  [read-only]

Boolean value, specifies whether the preload actions were skipped on this load occurrence.

The default value is false.

Implementation
    public function get preloadSkipped():Boolean
prequelproperty 
prequel:Prequel  [read-only]

The instance of the Prequel class utlized in the load process.

Implementation
    public function get prequel():Prequel
Constructor detail
NavLoaderPrototype()constructor
public function NavLoaderPrototype(_fosfr:Fosfr)

Creates an instance of the NavLoaderPrototype class

Parameters
_fosfr:Fosfr — an instance of the Fosfr class.

See also

com.jeffdePascale.fosfr.core.Fosfr
Method detail
advanceLoader()method
public function advanceLoader():void
resetProperties()method 
protected function resetProperties():void
Event detail
completeevent 
Event object type: com.jeffdePascale.fosfr.navigation.loaders.NavLoaderEvent
NavLoaderEvent.type property = com.jeffdePascale.fosfr.navigation.loaders.NavLoaderEvent.COMPLETE

Dispatched when the loading process has completed.

The NavLoaderEvent.COMPLETE constant defines the value of the type property of the event object for a complete event.

The properties of the event object have the following values:

Property Value
type "complete"
bubbles A Boolean value.
cancelable A Boolean value.
id an int value specifying the ID of the SWF file in relation to the Navigation class's NavArray instance. If the file being loaded is a FosfrShellSWF file, the value is -1.
initevent  
Event object type: com.jeffdePascale.fosfr.navigation.loaders.NavLoaderEvent
NavLoaderEvent.type property = com.jeffdePascale.fosfr.navigation.loaders.NavLoaderEvent.INIT

Dispatched when the loading process has started.

The NavLoaderEvent.INIT constant defines the value of the type property of the event object for a init event.

The properties of the event object have the following values:

Property Value
type "complete"
bubbles A Boolean value.
cancelable A Boolean value.
id an int value specifying the ID of the SWF file in relation to the Navigation class's NavArray instance. If the file being loaded is a FosfrShellSWF file, the value is -1.
preloadCompleteevent  
Event object type: com.jeffdePascale.fosfr.navigation.loaders.NavLoaderEvent
NavLoaderEvent.type property = com.jeffdePascale.fosfr.navigation.loaders.NavLoaderEvent.PRELOAD_COMPLETE

Dispatched when the preload process has completed.

The NavLoaderEvent.PRELOAD_COMPLETE constant defines the value of the type property of the event object for a preloadComplete event.

The properties of the event object have the following values:

Property Value
type "complete"
bubbles A Boolean value.
cancelable A Boolean value.
id an int value specifying the ID of the SWF file in relation to the Navigation class's NavArray instance. If the file being loaded is a FosfrShellSWF file, the value is -1.
preloadInitevent  
Event object type: com.jeffdePascale.fosfr.navigation.loaders.NavLoaderEvent
NavLoaderEvent.type property = com.jeffdePascale.fosfr.navigation.loaders.NavLoaderEvent.PRELOAD_INIT

Dispatched when the preload process has started.

The NavLoaderEvent.PRELOAD_INIT constant defines the value of the type property of the event object for a preloadInit event.

The properties of the event object have the following values:

Property Value
type "complete"
bubbles A Boolean value.
cancelable A Boolean value.
id an int value specifying the ID of the SWF file in relation to the Navigation class's NavArray instance. If the file being loaded is a FosfrShellSWF file, the value is -1.