Packagecom.jeffdePascale.fosfr.core
Classpublic class ConfigLoader
InheritanceConfigLoader Inheritance flash.events.EventDispatcher

Handles the load process for the configuration xml file for Fosfr, and returns an XML object to the Fosfr instance for parsing. Utilizes an instance of the URLLoader class.

See also

com.jeffdePascale.fosfr.core.FosfrBaseClass

Public Methods
 MethodDefined by
  
ConfigLoader(_fosfr:FosfrBaseClass)
Instantiates the ConfigLoader class.
ConfigLoader
  
load(configURL:String):void
Begins the loading process of the configuration XML file.
ConfigLoader
Events
 EventSummaryDefined by
  
complete
Dispatched when the loading process has completed in the ConfigLoader class.ConfigLoader
Constructor detail
ConfigLoader()constructor
public function ConfigLoader(_fosfr:FosfrBaseClass)

Instantiates the ConfigLoader class.

Parameters
_fosfr:FosfrBaseClass — An instance of the Fosfr framework.
Method detail
load()method
public function load(configURL:String):void

Begins the loading process of the configuration XML file.

Parameters
configURL:String — the url of the configuration XML, relative the SWF file. this method integrates the 'rootFolder' value in the Fosfr instance to determine relative file location. See FosfrBaseClass for more details.
Event detail
completeevent 
Event object type: com.jeffdePascale.fosfr.core.ConfigLoaderEvent
ConfigLoaderEvent.type property = com.jeffdePascale.fosfr.core.ConfigLoaderEvent.COMPLETE

Dispatched when the loading process has completed in the ConfigLoader class.

The ConfigLoaderEvent.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.
configXML an XML object containing the loaded configuration file.