com.bourre.ioc.load.ContextPreprocessorLoader

Package	com.bourre.ioc.load
Class	public class ContextPreprocessorLoader

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

The ContextPreprocessorLoader class allow xml context pre processing from xml context nodes.

Context preprocessing order is :

ApplicationLoader.addProcessingMethod() job
ApplicationLoader.addProcessor() job
ContextPreprocessorLoader job

Example
Basic Processor to insert a node into xml context

  
  package com.project
  {
   import com.bourre.ioc.context.processor.ContextProcessor;
   
   public class TestProcessor implements ContextProcessor 
   {
    public function TestProcessor( ...args )
    {
    
    }
    
    public function process(xml : XML) : XML
    {   
     //do preprocessing here
     
     return xml;
    }
    
    public function customMethod( xml : XML ) : XML
    {
     return process( xml );
    }
   }
  }

Define preprocessing using xml context node

Preprocessor class is in current application domain and processor is ContextProcessor implementation :

  
  <preprocessor type="com.project.TestProcessor" />

Preprocessor class is not in current application domain, loads it from passed-in url ( like DLL library ) :

  
  <preprocessor type="com.project.TestProcessor" url="TestProcessorDLL.swf" />

Preprocessor class is not in current application domain and it is not a ContextProcessor object, use method attribute :

  
  <preprocessor type="com.project.TestProcessor" url="TestProcessorDLL.swf" method="customMethod" />

Instance arguments are allowed, also factory and singleton-access too.

	Method	Defined by
		ContextPreprocessorLoader(xml:*, builder:DisplayObjectBuilder) Creates new `ContextPreprocessorLoader`.	ContextPreprocessorLoader
		addEventListener(type:String, listener:Object, ... rest):Boolean Adds an event listener for the specified event type.	ContextPreprocessorLoader
		load():void Starts pre processing job.	ContextPreprocessorLoader
		removeEventListener(type:String, listener:Object):Boolean Removes the passed-in listener for listening the specified event.	ContextPreprocessorLoader
		toString():String Returns string representation of passed-in target object.	ContextPreprocessorLoader

	Method	Defined by
		fireOnCompleteEvent():void Triggered when all context pre processors are completed.	ContextPreprocessorLoader
		onProcessorComplete(event:QueueLoaderEvent):void Triggered when all context pre processors are loaded.	ContextPreprocessorLoader
		onProcessorError(event:QueueLoaderEvent):void Triggered when error occurs during pre processor dll loading.	ContextPreprocessorLoader
		onProcessorInit(event:QueueLoaderEvent):void Triggered when a pre processor dll is loaded.	ContextPreprocessorLoader

	Constant	Defined by
		onPreprocessorCompleteEVENT : String = "onPreprocessorComplete" [static] Defines the value of the `type` property of the event object for a `onPreprocessorComplete` event.	ContextPreprocessorLoader
		PROCESS_METHOD_NAME : String = "process" [static] Method name that processor must implement to transform xml context data.	ContextPreprocessorLoader

Constructor detail

ContextPreprocessorLoader

()

constructor

public function ContextPreprocessorLoader(xml:*, builder:DisplayObjectBuilder)

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Creates new ContextPreprocessorLoader.

Parameters

	`xml:*` — ApplicationLoader instance

	`builder:DisplayObjectBuilder` — IoC xml context

Method detail

addEventListener

()

method

public function addEventListener(type:String, listener:Object, ... rest):Boolean

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Adds an event listener for the specified event type. There is two behaviors for the addEventListener function :

The passed-in listener is an object : The object is added as listener only for the specified event, the object must have a function with the same name than type or at least a handleEvent function.
The passed-in listener is a function : A Delegate object is created and then added as listener for the event type. There is no restriction on the name of the function. If the rest is not empty, all elements in it is used as additional arguments into the delegate object.

Parameters

	`type:String` — name of the event for which register the listener

	`listener:Object` — object or function which will receive this event

	`... rest` — additional arguments for the function listener

Returns

Boolean — true if the function have been succesfully added as listener fot the passed-in event

fireOnCompleteEvent

()

method

protected function fireOnCompleteEvent():void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Triggered when all context pre processors are completed.

load

()

method

public function load():void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Starts pre processing job.

onProcessorComplete

()

method

protected function onProcessorComplete(event:QueueLoaderEvent):void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Triggered when all context pre processors are loaded.

Parameters

event:QueueLoaderEvent

onProcessorError

()

method

protected function onProcessorError(event:QueueLoaderEvent):void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Triggered when error occurs during pre processor dll loading.

Parameters

event:QueueLoaderEvent

onProcessorInit

()

method

protected function onProcessorInit(event:QueueLoaderEvent):void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Triggered when a pre processor dll is loaded.

Parameters

event:QueueLoaderEvent

removeEventListener

()

method

public function removeEventListener(type:String, listener:Object):Boolean

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Removes the passed-in listener for listening the specified event. The listener could be either an object or a function.

Parameters

	`type:String` — name of the event for which unregister the listener

	`listener:Object` — object or function to be unregistered

Returns

Boolean — true if the listener have been successfully removed as listener for the passed-in event

toString

()

method

public function toString():String

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Returns string representation of passed-in target object.

Returns

String — String representation of passed-in target object.

Constant detail

onPreprocessorCompleteEVENT

constant

public static const onPreprocessorCompleteEVENT:String = "onPreprocessorComplete"

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Defines the value of the type property of the event object for a onPreprocessorComplete event.

The properties of the event object have the following values:

Property	Value
`type`	Dispatched event type
Method	Value
`getTarget`	The pre processing xml data

PROCESS_METHOD_NAME

constant

public static const PROCESS_METHOD_NAME:String = "process"

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Method name that processor must implement to transform xml context data.

Used only when method attribute is not defined in preprocessor xml node.

The default value is process.

LowRA API Documentation	Annexes \| All Packages \| All Classes \| Index \| Frames No Frames
Class ContextPreprocessorLoader	Methods \| Constants