| Package | com.jeffdePascale.fosfr.core |
| Class | public class FosfrBaseClass |
| Inheritance | FosfrBaseClass  flash.events.EventDispatcher |
| Subclasses | Fosfr, FosfrLite |
FosfrBaseClass instantiates instances of the Debug and Tracking classes.
See also
| Property | Defined by | ||
|---|---|---|---|
| debug : Debug
[read-only]
An instance of the Fosfr
Debug class. | FosfrBaseClass | ||
| flashVars : Object [read-only]
An object containg variables passed in via the
FlashVars parameter of the SWF embed. | FosfrBaseClass | ||
| fosfrNotification : FosfrNotification
[read-only]
| FosfrBaseClass | ||
| local : Boolean [read-only]
A Boolean value, passed in via flashVars, specifying whether the SWF file is running locally.
| FosfrBaseClass | ||
| projectName : String [read-only]
A string value of the name of the project, as specified in the configuration XML file's
projectName node. | FosfrBaseClass | ||
| rootFolder : String [read-only]
A string value, passed in via flashVars, specifying where the root of the SWF folder structure is relative to the embed.
| FosfrBaseClass | ||
| siteParameters : XMLList [read-only]
An object pulled from the configuration xml file's
siteParameters node, if applicable. | FosfrBaseClass | ||
| tracking : Tracking
[read-only]
An instance of the Fosfr
Tracking class. | FosfrBaseClass | ||
| urlInfo : URLInfo
[read-only]
An instance of the
URLInfo class. | FosfrBaseClass | ||
| version : String [read-only]
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 | ||
| Property | Defined by | ||
|---|---|---|---|
| xmlListTools : XMLListTools | FosfrBaseClass | ||
| Method | Defined by | ||
|---|---|---|---|
|
FosfrBaseClass(__displayObj:FosfrInitializeSWFPrototype)
Instantiates an instance of the
FosfrInitializeSWFPrototype class. | FosfrBaseClass | ||
|
loadConfig(_configPath:String):void
Loads the configuration xml file at the url specified.
| FosfrBaseClass | ||
| Event | Summary | Defined by | ||
|---|---|---|---|---|
| Dispatched when the configuration file has been loaded and parsing has begun. | FosfrBaseClass | |||
| Dispatched when Fosfr has completed initialization. | FosfrBaseClass | |||
| Constant | Defined by | ||
|---|---|---|---|
| BUILD : String = "104" [static]
| FosfrBaseClass | ||
| VERSION : String = ".8 BETA" [static]
The version release number of Fosfr.
| FosfrBaseClass | ||
| debug | property |
debug:Debug [read-only]
An instance of the Fosfr Debug class.
public function get debug():Debug
See also
| flashVars | property |
flashVars:Object [read-only]
An object containg variables passed in via the FlashVars parameter of the SWF embed.
public function get flashVars():Object
| fosfrNotification | property |
fosfrNotification:FosfrNotification [read-only]Implementation
public function get fosfrNotification():FosfrNotification
| local | property |
local:Boolean [read-only]A Boolean value, passed in via flashVars, specifying whether the SWF file is running locally. Set to true to disable server specific functionality, such as SWFAddress.
The default value is null.
public function get local():Boolean
See also
| projectName | property |
projectName:String [read-only]
A string value of the name of the project, as specified in the configuration XML file's projectName node.
The default value is an empty string.
public function get projectName():String
| rootFolder | property |
rootFolder:String [read-only]A string value, passed in via flashVars, specifying where the root of the SWF folder structure is relative to the embed. Utilized internally as well throughout Fosfr for pathing to the appropriate SWF assets.
The default value is true.
public function get rootFolder():String
See also
| siteParameters | property |
siteParameters:XMLList [read-only]
An object pulled from the configuration xml file's siteParameters node, if applicable.
The default value is null.
public function get siteParameters():XMLList
| tracking | property |
tracking:Tracking [read-only]
An instance of the Fosfr Tracking class.
public function get tracking():Tracking
See also
| urlInfo | property |
urlInfo:URLInfo [read-only]
An instance of the URLInfo class.
public function get urlInfo():URLInfo
See also
| version | property |
version:String [read-only]
A string value for the version number of the project, as specified in the version attribute of the configration XML file's projectName node.
public function get version():String
| xmlListTools | property |
protected var xmlListTools:XMLListTools
| FosfrBaseClass | () | constructor |
public function FosfrBaseClass(__displayObj:FosfrInitializeSWFPrototype)
Instantiates an instance of the FosfrInitializeSWFPrototype class.
__displayObj:FosfrInitializeSWFPrototype — A reference to the stage of the SWF file.
|
| loadConfig | () | method |
public function loadConfig(_configPath:String):voidLoads the configuration xml file at the url specified.
Parameters_configPath:String — The url of the configuration xml file, relative to the rootFolder property.
|
See also
| configLoaded | event |
com.jeffdePascale.fosfr.core.FosfrEvent
com.jeffdePascale.fosfr.core.FosfrEvent.CONFIG_LOADED
Dispatched when the configuration file has been loaded and parsing has begun.
The FosfrEvent.CONFIG_LOADED constant defines the value of the type property of the event object for a configLoaded event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
type | "configLoaded" |
bubbles | A Boolean value. |
cancelable | A Boolean value. |
| init | event |
com.jeffdePascale.fosfr.core.FosfrEvent
com.jeffdePascale.fosfr.core.FosfrEvent.INIT
Dispatched when Fosfr has completed initialization.
The FosfrEvent.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 | "init" |
bubbles | A Boolean value. |
cancelable | A Boolean value. |
| BUILD | constant |
public static const BUILD:String = "104"
| VERSION | constant |
public static const VERSION:String = ".8 BETA"The version release number of Fosfr.