Packagecom.jeffdePascale.fosfr
Classpublic dynamic class FosfrShellSWF
InheritanceFosfrShellSWF Inheritance FosfrSWFPrototype Inheritance FosfrPrototype Inheritance flash.display.MovieClip

One of the core implementation classes for the Fosfr framework, the FosfrShellSWF class is one of three classes used when implementing Fosfr as a full site build, along with FosfrMainSWF and FosfrSubSWF.

FosfrShellSWF functions as the holder for the core graphical assets for the site, generally including all assets that are persistent through all sections of the site, such as background and navigation. It also house the holder clip for the subSWF files being loaded in, and preloading of FosfrSubSWF files, and should be used to house the preloader visual element itself as well for these elements if it is seperate from the one housed in the FosfrMainSWF file. Add event listeners to the SubSWFPrequel instance to receive information about the preload events. For more information, see the documentation for Prequel at http://www.jeffdepascale.com/blog/documentation


Example
The following code shows a typical implementation of FosfrShellSWF as a document class. Listeners have been added to the prequel instance for preloading purposes as well. 
 
 package  {
    
      import flash.events.Event;
      import com.jeffdePascale.prequel.PrequelEvent;
      import com.jeffdePascale.fosfr.FosfrShellSWF;
    
      public class ShellSWFExample extends FosfrShellSWF{
 
          public function ShellSWFExample() {
          }
 
       public override function init():void {
           subSWFPrequel.addEventListener(PrequelEvent.PROGRESS, eProgressHandler);
           subSWFPrequel.addEventListener(Event.COMPLETE, eCompleteHandler);
       }
    
          private function eCompleteHandler(e:Event):void {
           debug("subSWF complete");
       }
    
          private function eProgressHandler(e:PrequelEvent):void {
           debug(e.totalPercent);
       }
    } 
    }


Public Properties
 PropertyDefined by
  subSWFPrequel : Prequel
[read-only] An instance of the Prequel class instantiated in the ShellLoader class of the fosfr.navigation package.
FosfrShellSWF
Public Methods
 MethodDefined by
  
FosfrShellSWF()
Creates a new FosfrShellSWF instance.
FosfrShellSWF
 Inherited
debug(str:*):void
provides a document class level shortcut to the fosfr.debug.update() method.
FosfrPrototype
 Inherited
init():void
Called automatically upon completion of the initialization process by Fosfr, this method should be overriden and used as the starting point for the SWF file.
FosfrPrototype
 Inherited
loadSubSWF(target:*, deepLink:Array = null, loadVariables:Object = null, skipPreload:Boolean = false, preloadArray:Array = null, swfAddressChange:Boolean = true, forcedFullPageName:String = null):void
provides a document class level shortcut to the fosfr.navigation.subLoader.load() method.
FosfrSWFPrototype
 Inherited
track(tag:String, forceMethod:String = null, ... args):void
provides a document class level shortcut to the fosfr.tracking.track() method.
FosfrPrototype
Property detail
subSWFPrequelproperty
subSWFPrequel:Prequel  [read-only]

An instance of the Prequel class instantiated in the ShellLoader class of the fosfr.navigation package.

Implementation
    public function get subSWFPrequel():Prequel
Constructor detail
FosfrShellSWF()constructor
public function FosfrShellSWF()

Creates a new FosfrShellSWF instance.