Packagecom.jeffdePascale.fosfr.core
Classpublic class Fosfr
InheritanceFosfr Inheritance FosfrBaseClass Inheritance flash.events.EventDispatcher

Instantiates an instance of the complete Fosfr framework, including the Navigation branch. Implemented in the FosfrMainSWF class.

See also

com.jeffdePascale.fofr.FosfrMainSWF


Public Properties
 PropertyDefined by
 Inheriteddebug : Debug
An instance of the Fosfr Debug class.
FosfrBaseClass
 InheritedflashVars : Object
An object containg variables passed in via the FlashVars parameter of the SWF embed.
FosfrBaseClass
 InheritedfosfrNotification : FosfrNotification
FosfrBaseClass
 Inheritedlocal : Boolean
A Boolean value, passed in via flashVars, specifying whether the SWF file is running locally.
FosfrBaseClass
  mainSWF : FosfrMainSWF
[read-only] The stage of the SWF.
Fosfr
  navigation : Navigation
[read-only] An instance of the Navigation class
Fosfr
 InheritedprojectName : String
A string value of the name of the project, as specified in the configuration XML file's projectName node.
FosfrBaseClass
 InheritedrootFolder : String
A string value, passed in via flashVars, specifying where the root of the SWF folder structure is relative to the embed.
FosfrBaseClass
  shellSWF : FosfrShellSWF
An instance of the FosfrShellSWF class that correlates to the active FosfrShellSWF file loaded in to the FosfrMainSWF file.
Fosfr
 InheritedsiteParameters : XMLList
An object pulled from the configuration xml file's siteParameters node, if applicable.
FosfrBaseClass
  subSWF : FosfrSubSWF
An instance of the FosfrSubSWF class that correlates to the active FosfrSubSWF file loaded in to the FosfrShellSWF file.
Fosfr
 Inheritedtracking : Tracking
An instance of the Fosfr Tracking class.
FosfrBaseClass
 InheritedurlInfo : URLInfo
An instance of the URLInfo class.
FosfrBaseClass
 Inheritedversion : String
A string value for the version number of the project, as specified in the version attribute of the configration XML file's projectName node.
FosfrBaseClass
Protected Properties
 PropertyDefined by
 InheritedxmlListTools : XMLListTools
FosfrBaseClass
Public Methods
 MethodDefined by
  
Instantiates an instance of the Fosfr class.
Fosfr
 Inherited
loadConfig(_configPath:String):void
Loads the configuration xml file at the url specified.
FosfrBaseClass
Events
 EventSummaryDefined by
 Inherited Dispatched when the configuration file has been loaded and parsing has begun.FosfrBaseClass
 Inherited Dispatched when Fosfr has completed initialization.FosfrBaseClass
Public Constants
 ConstantDefined by
 InheritedBUILD : String = "104"
[static]
FosfrBaseClass
 InheritedVERSION : String = ".8 BETA"
[static] The version release number of Fosfr.
FosfrBaseClass
Property detail
mainSWFproperty
mainSWF:FosfrMainSWF  [read-only]

The stage of the SWF.

Implementation
    public function get mainSWF():FosfrMainSWF
navigationproperty 
navigation:Navigation  [read-only]

An instance of the Navigation class

Implementation
    public function get navigation():Navigation

See also

shellSWFproperty 
public var shellSWF:FosfrShellSWF

An instance of the FosfrShellSWF class that correlates to the active FosfrShellSWF file loaded in to the FosfrMainSWF file. This property allows access to the SWF file via the fosfr framework by referencing fosfr.shell from anywhere within the project.

See also

subSWFproperty 
public var subSWF:FosfrSubSWF

An instance of the FosfrSubSWF class that correlates to the active FosfrSubSWF file loaded in to the FosfrShellSWF file. This property allows access to the SWF file via the fosfr framework by referencing fosfr.subSWF from anywhere within the project.

See also

Constructor detail
Fosfr()constructor
public function Fosfr(_displayObj:FosfrInitializeSWFPrototype)

Instantiates an instance of the Fosfr class.

Parameters
_displayObj:FosfrInitializeSWFPrototype — A reference to the stage of the SWF file.