| Package | com.jeffdePascale.fosfr |
| Class | public dynamic class FosfrSubSWF |
| Inheritance | FosfrSubSWF  FosfrSWFPrototype FosfrPrototype flash.display.MovieClip |
FosfrSubSWF class is one of three classes used when implementing Fosfr as a full site build, along with FosfrMainSWF and FosfrShellSWF.
FosfrSubSWF functions as a base class for each sub section of the site (called subSWF's in Fosfr).
FosfrSubSWF as a document class.
package {
import com.jeffdePascale.fosfr.FosfrSubSWF;
public class SubSWFExample extends FosfrSubSWF{
public function SubSWFExample() {
}
public override function init():void {
//begin your code here
}
}
}
| Property | Defined by | ||
|---|---|---|---|
| fullName : String
an optional full string name value for the SubSWF file, utilized by the
SWFAddressHandler instance in the fosfr.navigation branch. | FosfrSubSWF | ||
| sectionID : uint [read-only]
The unit ID value the SWF file in relation to the
fosfr.navigation.navArray instance, which tracks subSWF files. | FosfrSubSWF | ||
| varObj : Object [read-only]
An object, optionally passed on instatiation of the FosfrSubSWF file.
| FosfrSubSWF | ||
| Method | Defined by | ||
|---|---|---|---|
| FosfrSubSWF | |||
|
attachFosfr(__fosfr:Fosfr):void
| FosfrSubSWF | ||
 |
debug(str:*):void
provides a document class level shortcut to the
fosfr.debug.update() method. | FosfrPrototype | |
|
handleSubLink(address:Array):void
Handles the return of subLink data from the
SWFAddressHandler instance in the fosfr.navigation branch. | FosfrSubSWF | ||
|
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 | |
|
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 | |
|
setSubLink(address:Array):void
| FosfrSubSWF | ||
|
track(tag:String, forceMethod:String = null, ... args):void
provides a document class level shortcut to the
fosfr.tracking.track() method. | FosfrPrototype | |
|
unload():void
Automatically called by
FosfrSubSWF when a NavigationEvent.UNLOAD is dispatched from the fosfr.navigation.Navigation class, this method may be overriden to perform custom unload procedures. | FosfrSubSWF | ||
|
unloadComplete():void
Automatically called by
FosfrSubSWF upon completion of the unload method, this method must be manually called if the unload method is overriden. | FosfrSubSWF | ||
| fullName | property |
Hide Inherited Public Methods
Show Inherited Public Methodspublic var fullName:String
an optional full string name value for the SubSWF file, utilized by the SWFAddressHandler instance in the fosfr.navigation branch.
See also
| sectionID | property |
sectionID:uint [read-only]
The unit ID value the SWF file in relation to the fosfr.navigation.navArray instance, which tracks subSWF files.
public function get sectionID():uint
See also
| varObj | property |
varObj:Object [read-only]An object, optionally passed on instatiation of the FosfrSubSWF file. Useful for passing parameters to the loaded SubSWF.
The default value is null.
public function get varObj():Object
See also
| FosfrSubSWF | () | constructor |
public function FosfrSubSWF()
| attachFosfr | () | method |
| handleSubLink | () | method |
public function handleSubLink(address:Array):void
Handles the return of subLink data from the SWFAddressHandler instance in the fosfr.navigation branch. Override this method to handle subLink data.
address:Array — the string value of the subLink passed from the SWFAddressHandler instance.
|
See also
| setSubLink | () | method |
public function setSubLink(address:Array):voidParameters
address:Array |
| unload | () | method |
public function unload():void
Automatically called by FosfrSubSWF when a NavigationEvent.UNLOAD is dispatched from the fosfr.navigation.Navigation class, this method may be overriden to perform custom unload procedures. Call unloadComplete() at the completion of the manual unload process to notify the navigation class to comlete the unload process. This method is useful both for animation purposes as well as manual garbage collection.
See also
| unloadComplete | () | method |
public function unloadComplete():void
Automatically called by FosfrSubSWF upon completion of the unload method, this method must be manually called if the unload method is overriden.
See also