true to start loading
* just after loader instanciation.
* @param url URL request for 'applicationContext' file
* to load.
*/
public function ApplicationLoader( rootTarget : DisplayObjectContainer,
autoExecute : Boolean = false,
url : URLRequest = null )
{
setListenerType( ApplicationLoaderListener );
_oRootTarget = rootTarget;
setURL( url ? url : ApplicationLoader.DEFAULT_URL );
initQueryURL( );
initContext( );
_aVariables = new Array( );
_aMethods = new Array( );
_aProcessor = new Array( );
setApplicationAssembler( new DefaultApplicationAssembler( ) );
_initParserCollection( );
if ( autoExecute ) execute( );
}
/**
* Returns ApplicationAssembler used in by this loader.
*/
public function getApplicationAssembler() : ApplicationAssembler
{
return _oApplicationAssembler;
}
/**
* Sets the ApplicationAssembler to use by this loader.
*/
public function setApplicationAssembler( assembler : ApplicationAssembler ) : void
{
_oApplicationAssembler = assembler;
}
/**
* Returns parser collection used by assembler.
*/
public function getParserCollection() : ParserCollection
{
return _oParserCollection;
}
/**
* Sets the parsers collection to use in order to build context.
*/
public function setParserCollection( pc : ParserCollection ) : void
{
_oParserCollection = pc;
}
/**
* Sets new pair name / value for variable replacement when context
* file will be laoded.
*
* @param name Name of the variable to replace.
* @param value New value for this variable.
*
* @example Variable definition somewhere in the xml context :
*
*
* ${POSITION_X}
*
*
* @example Setting this variable using setVariable() method :
* * * rtLoader.setVariable( "POSITION_X", 200 ); **/ public function setVariable( name : String, value : Object ) : void { _aVariables.push( new Variable( name, value ) ); } /** * Adds new preprocessing method. * *
Preprocessing act after xml loading and before context parsing.
* Used to transform context data on fly.
* * var oLoader : ApplicationLoader = new ApplicationLoader( this, false ); * oLoader.addProcessingMethod( ProcessingHelper.changeObjectAttribute, "cross", "visible", "false" ); * oLoader.addProcessingMethod( ProcessingHelper.changePropertyValue, "cross", "x", 600 ); * oLoader.addProcessingMethod( ProcessingHelper.addResource, "newStyle", "myStyle.css" ); ** * @see com.bourre.ioc.context.processor.ProcessingHelper */ public function addProcessingMethod( processingMethod : Function, ...args ) : void { var d : Delegate = new Delegate( processingMethod ); d.setArgumentsArray( args ); _aMethods.push( d ); } /** * Adds new pre processing processor. * *
Preprocessing act after xml loading and before context parsing.
* Used to transform context data on fly.
* * var oLoader : ApplicationLoader = new ApplicationLoader( this, false ); * oLoader.addProcessor( new LocalisationProcessor() ); **/ public function addProcessor( processor : ContextProcessor ) : void { _aProcessor.push( processor ); } /** * Returns the
DisplayObjectBuilder used by this loader
* to load and build all context elements.
*/
public function getDisplayObjectBuilder() : DisplayObjectBuilder
{
return _oDisplayObjectBuilder;
}
/**
* Sets the DisplayObjectBuilder to use by this loader
* to load and build all context elements.
*/
public function setDisplayObjectBuilder( displayObjectBuilder : DisplayObjectBuilder ) : void
{
_oDisplayObjectBuilder = displayObjectBuilder;
}
/**
* Adds the passed-in listener as listener for all
* events dispatched by loader.
*
* @param listener ApplicationLoaderListener instance.
*/
public function addApplicationLoaderListener( listener : ApplicationLoaderListener ) : Boolean
{
return addListener( listener );
}
/**
* Removes the passed-in listener object from loader.
*
* @param listener ApplicationLoaderListener instance.
*/
public function removeApplicationLoaderListener( listener : ApplicationLoaderListener ) : Boolean
{
return removeListener( listener );
}
/**
* Starts loading.
*
* @param url (optional) URL request for 'applicationContext' file
* to load.
* @paam context (optional) LoaderContext definition.
*/
override public function load( url : URLRequest = null, context : LoaderContext = null ) : void
{
if ( url != null ) setURL( url );
if ( getURL( ).url.length > 0 )
{
var cl : ContextLoader = new ContextLoader( );
cl.setURL( getURL( ) );
cl.addEventListener( ContextLoaderEvent.onLoadInitEVENT, _onContextLoaderLoadInit );
cl.addEventListener( ContextLoaderEvent.onLoadProgressEVENT, this );
cl.addEventListener( ContextLoaderEvent.onLoadTimeOutEVENT, this );
cl.addEventListener( ContextLoaderEvent.onLoadErrorEVENT, this );
fireOnApplicationState( ApplicationLoaderEvent.LOAD_STATE );
cl.load( getURL( ), context );
}
else
{
var msg : String = this + ".load() can't retrieve file url.";
PixlibDebug.ERROR( msg );
throw new NullPointerException( msg );
}
}
/**
* @private
*
* Parses the loaded xml.
*
* Checks for context include before parsing the context.
*/ public function parseContext( xml : * ) : void { if ( getDisplayObjectBuilder( ) == null ) setDisplayObjectBuilder( new DefaultDisplayObjectBuilder( ) ); runPreprocessor( xml ); } /** * Starts IoC pre processing. * * @param xml IoC xml context * * @see #onPreprossorComplete() */ public function runPreprocessor( xml : * ) : void { fireOnApplicationState( ApplicationLoaderEvent.PREPROCESS_STATE ); xml = preprocess( xml ); var cl : ContextPreprocessorLoader = new ContextPreprocessorLoader( xml, getDisplayObjectBuilder( ) ); cl.addEventListener( ContextPreprocessorLoader.onPreprocessorCompleteEVENT, onPreprossorComplete ); cl.load( ); } /** * Preprocessing is completed. * *Starts the IoC parsing.
* * @param xml IoC xml context * * @see #processParsing() */ public function onPreprossorComplete( event : BasicEvent ) : void { processParsing( XML( event.getTarget() ) ); } /** * Parses the xml context. * *Include files are loaded and preprocessing is done.
*/ public function processParsing( xml : * ) : void { ChannelListenerExpert.getInstance( ).release( ); ConstructorExpert.getInstance( ).release( ); MethodExpert.getInstance( ).release( ); PropertyExpert.getInstance( ).release( ); ResourceExpert.getInstance( ).release( ); var cp : ContextParser = new ContextParser( getParserCollection( ) ); cp.addEventListener( ContextParserEvent.onContextParsingEndEVENT, _onContextParsingEnd ); if ( getDisplayObjectBuilder( ) == null ) setDisplayObjectBuilder( new DefaultDisplayObjectBuilder( ) ); if ( isAntiCache( ) ) getDisplayObjectBuilder( ).setAntiCache( true ); getDisplayObjectBuilder( ).setRootTarget( _oRootTarget ); getApplicationAssembler( ).setDisplayObjectBuilder( getDisplayObjectBuilder( ) ); fireOnApplicationState( ApplicationLoaderEvent.PARSE_STATE ); if( ApplicationLoader.DEBUG_LOADING_ENABLED ) //ADD TO LOWRA { PixlibDebug.DEBUG( this + ":: xml context to parse" ); PixlibDebug.DEBUG( xml.toString( ) ); } cp.parse( xml ); } /** * BroadcastsApplicationLoaderEvent.onApplicationStartEVENT
* event type when xml is parsed.
*/
public function fireOnApplicationStart() : void
{
fireEvent( new ApplicationLoaderEvent( ApplicationLoaderEvent.onApplicationStartEVENT, this ) );
}
/**
* Broadcasts ApplicationLoaderEvent.onApplicationStateEVENT when IOC engine
* processing change his state ( DLL, Resources, GFX, etc. )
*/
public function fireOnApplicationState( state : String ) : void
{
var e : ApplicationLoaderEvent = new ApplicationLoaderEvent( ApplicationLoaderEvent.onApplicationStateEVENT, this );
e.setApplicationState( state );
fireEvent( e );
}
/**
* Broadcasts ApplicationLoaderEvent.onApplicationParsedEVENT
* event type when xml is parsed.
*/
public function fireOnApplicationParsed() : void
{
fireEvent( new ApplicationLoaderEvent( ApplicationLoaderEvent.onApplicationParsedEVENT, this ) );
}
/**
* Broadcasts ApplicationLoaderEvent.onApplicationObjectsBuiltEVENT
* event type when all elements in xml are built.
*/
public function fireOnObjectsBuilt() : void
{
fireEvent( new ApplicationLoaderEvent( ApplicationLoaderEvent.onApplicationObjectsBuiltEVENT, this ) );
}
/**
* Broadcasts ApplicationLoaderEvent.onApplicationChannelsAssignedEVENT
* event type when all plugin channels are initialized.
*/
public function fireOnChannelsAssigned() : void
{
fireEvent( new ApplicationLoaderEvent( ApplicationLoaderEvent.onApplicationChannelsAssignedEVENT, this ) );
}
/**
* Broadcasts ApplicationLoaderEvent.onApplicationMethodsCalledEVENT
* event type when all method-call are executed.
*/
public function fireOnMethodsCalled() : void
{
fireEvent( new ApplicationLoaderEvent( ApplicationLoaderEvent.onApplicationMethodsCalledEVENT, this ) );
}
/**
* Broadcasts ApplicationLoaderEvent.onApplicationInitEVENT
* event type when application is ready.
*/
public function fireOnApplicationInit() : void
{
fireEvent( new ApplicationLoaderEvent( ApplicationLoaderEvent.onApplicationInitEVENT, this ) );
fireOnApplicationState( ApplicationLoaderEvent.RUN_STATE );
if( _oProxy != null ) removeListener( _oProxy );
release();
PluginExpert.getInstance( ).notifyAllPlugins( );
}
//------------------------------------
// Loader callbacks
//------------------------------------
/**
* @inheritdoc
*/
public function onLoadStart( e : LoaderEvent ) : void
{
fireEvent( e );
}
/**
* @inheritdoc
*/
public function onLoadInit( e : LoaderEvent ) : void
{
fireEvent( e );
}
/**
* @inheritdoc
*/
public function onLoadProgress( e : LoaderEvent ) : void
{
fireEvent( e );
}
/**
* @inheritdoc
*/
public function onLoadTimeOut( e : LoaderEvent ) : void
{
fireEvent( e );
}
/**
* @inheritdoc
*/
public function onLoadError( e : LoaderEvent ) : void
{
fireEvent( e );
PixlibDebug.ERROR( e.getErrorMessage( ) );
}
//------------------------------------
// DisplayObjectExpert callbacks
//------------------------------------
/**
* @inheritDoc
*/
public function onBuildDisplayObject( e : DisplayObjectEvent ) : void
{
if( DEBUG_LOADING_ENABLED )
PixlibDebug.INFO( "onBuildDisplayObject()" );
}
/**
* @inheritDoc
*/
public function onDisplayObjectBuilderLoadStart( e : DisplayObjectBuilderEvent ) : void
{
fireOnApplicationStart( );
}
/**
* @inheritDoc
*/
public function onDisplayLoaderInit( e : ValueObjectEvent ) : void
{
if( DEBUG_LOADING_ENABLED )
PixlibDebug.INFO( "Display Loader ready" );
_oProxy = new DisplayLoaderProxy( e.getTarget( ) as DisplayObjectContainer, e.getValueObject() as DisplayLoaderInfo );
addListener( _oProxy );
}
/**
* @inheritDoc
*/
public function onDLLLoadStart( e : DisplayObjectBuilderEvent ) : void
{
fireOnApplicationState( ApplicationLoaderEvent.DLL_STATE );
}
/**
* @inheritDoc
*/
public function onDLLLoadInit( e : DisplayObjectBuilderEvent ) : void
{
if( DEBUG_LOADING_ENABLED )
PixlibDebug.INFO( "onDLLLoadInit()" );
}
/**
* @inheritDoc
*/
public function onRSCLoadStart( e : DisplayObjectBuilderEvent ) : void
{
fireOnApplicationState( ApplicationLoaderEvent.RSC_STATE );
}
/**
* @inheritDoc
*/
public function onRSCLoadInit( e : DisplayObjectBuilderEvent ) : void
{
if( DEBUG_LOADING_ENABLED )
PixlibDebug.INFO( "onRSCLoadInit()" );
}
/**
* @inheritDoc
*/
public function onDisplayObjectLoadStart( e : DisplayObjectBuilderEvent ) : void
{
fireOnApplicationState( ApplicationLoaderEvent.GFX_STATE );
}
/**
* @inheritDoc
*/
public function onDisplayObjectLoadInit( e : DisplayObjectBuilderEvent ) : void
{
if( DEBUG_LOADING_ENABLED )
PixlibDebug.INFO( "onDisplayObjectLoadInit()" );
}
/**
* @inheritDoc
*/
public function onDisplayObjectBuilderLoadInit( e : DisplayObjectBuilderEvent ) : void
{
fireOnApplicationParsed( );
fireOnApplicationState( ApplicationLoaderEvent.BUILD_STATE );
ConstructorExpert.getInstance( ).buildAllObjects( );
fireOnObjectsBuilt( );
ChannelListenerExpert.getInstance( ).assignAllChannelListeners( );
fireOnChannelsAssigned( );
try
{
MethodExpert.getInstance( ).callAllMethods( );
fireOnMethodsCalled( );
}
catch( err : Error )
{
PixlibDebug.ERROR( MethodExpert.getInstance( ) + " callAllmethods failed" );
}
finally
{
fireOnApplicationInit( );
}
}
//--------------------------------------------------------------------
// Protected methods
//--------------------------------------------------------------------
/**
* Do preprocessing actions on xml context before parsing.
*
* @param xml Content to process
*/
protected function preprocess( xml : XML ) : XML
{
fireOnApplicationState( ApplicationLoaderEvent.PREPROCESS_STATE );
//Variables
if( _aVariables.length > 0 )
{
var src : String = xml.toString( );
for each (var variable : Variable in _aVariables)
{
src = src.split( variable.name ).join( variable.value );
}
xml = new XML( src );
}
//Methods
for each (var method : Delegate in _aMethods)
{
method.setArgumentsArray( [ xml ].concat( method.getArguments( ) ) );
var mr : XML = xml;
try
{
mr = method.callFunction( );
}
catch( e : Error )
{
}
finally
{
xml = mr;
}
}
//Processors
for each (var processor : ContextProcessor in _aProcessor )
{
var pr : XML = xml;
try
{
pr = processor.process( xml );
}
catch( e : Error )
{
}
finally
{
xml = pr;
}
}
return xml;
}
/**
* Retreives Query URL.
*
* Uses query URL to overwrite existing Flashvars for exemple.
*/ protected function initQueryURL() : void { if( ExternalInterface.available ) { var url : String = ExternalInterface.call( "eval", "document.location.href" ); var args : String = url.split( "?" )[1]; if ( args != null ) { args = args.split( "#" )[0]; //SWFAddress deep link exception var params : Array = args.split( "&" ); for (var i : int = 0; i < params.length ; i++) { var pair : Array = params[i].split( "=" ); if( DEBUG_LOADING_ENABLED ) PixlibDebug.DEBUG( this + "::registred dynamic flashvars ::" + pair[0] + " -> " + pair[1] ); var key : String = FlashVarsUtil.FLASHVARS + pair[0]; if( !BeanFactory.getInstance( ).isRegistered( key ) ) { BeanFactory.getInstance( ).register( key, pair[1] ); } } } } } /** * */ protected function initContext( ) : void { var param : Object; try { param = _oRootTarget.root.loaderInfo.parameters; } catch( e : Error ) { param = {}; } finally { var contextFile : String; if( BeanFactory.getInstance( ).isRegistered( FlashVarsUtil.getContextFileKey( ) ) ) { contextFile = BeanFactory.getInstance( ).locate( FlashVarsUtil.getContextFileKey( ) ) as String; } else { contextFile = param.hasOwnProperty( FlashVarsUtil.CONTEXT_FILE ) ? param[ FlashVarsUtil.CONTEXT_FILE ] : DEFAULT_CONTEXT_FILE; BeanFactory.getInstance().register( FlashVarsUtil.getContextFileKey(), contextFile ); } var contextPath : String; if( BeanFactory.getInstance( ).isRegistered( FlashVarsUtil.getConfigPathKey( ) ) ) { contextPath = BeanFactory.getInstance( ).locate( FlashVarsUtil.getConfigPathKey( ) ) as String; } else { contextPath = param.hasOwnProperty( FlashVarsUtil.CONFIG_PATH ) ? param[ FlashVarsUtil.CONFIG_PATH ] : DEFAULT_CONFIG_PATH; BeanFactory.getInstance().register( FlashVarsUtil.getConfigPathKey(), contextPath ); } var contextURL : URLRequest = new URLRequest( contextPath + contextFile ); setURL( contextURL ); PixlibDebug.DEBUG( this + "::load context " + contextURL.url ); } } protected function _initParserCollection() : void { var pc : ParserCollection = new ParserCollection( ); pc.push( new LoaderParser( getApplicationAssembler( ) ) ); pc.push( new DLLParser( getApplicationAssembler( ) ) ); pc.push( new RSCParser( getApplicationAssembler( ) ) ); pc.push( new DisplayObjectParser( getApplicationAssembler( ) ) ); pc.push( new ObjectParser( getApplicationAssembler( ) ) ); setParserCollection( pc ); } protected function _onContextLoaderLoadInit( e : ContextLoaderEvent ) : void { e.getContextLoader( ).removeListener( this ); parseContext( e.getContext( ) ); } protected function _onContextParsingEnd( e : ContextParserEvent ) : void { e.getContextParser( ).removeEventListener( ContextParserEvent.onContextParsingEndEVENT, this ); getDisplayObjectBuilder( ).addListener( this ); getDisplayObjectBuilder( ).execute( ); } override protected function getLoaderEvent( type : String, errorMessage : String = "" ) : LoaderEvent { return new ApplicationLoaderEvent( type, this, errorMessage ); } } } internal class Variable { private var _name : String; private var _value : Object; public function get name( ) : String { return _name; } public function get value( ) : String { return _value.toString( ); } public function Variable( name : String, value : Object ) { _name = "${" + name + "}"; _value = value; } }