ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.exm.expression 

IExpressionEvaluationService  - AS3 Expression Manager

Packagecom.adobe.exm.expression
Interfacepublic interface IExpressionEvaluationService extends IEventDispatcher
Implementors ExpressionEvaluationService
Deprecated since Expression Manager 10

Language Version: ActionScript 3.0
Product Version: Expression Manager Building Block 9.5
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This Interface is used to register the expression SWF and evaluate the expression using pre-loaded swf.



Public Methods
 MethodDefined By
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
IEventDispatcher
 Inherited
Dispatches an event into the event flow.
IEventDispatcher
  
evaluateExpression(expression:String, expressionDefinitionId:String, varsMap:Object, qualifiedClassName:String):Object
This API is used to evaluate an expression at flex side.
IExpressionEvaluationService
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
IEventDispatcher
  
registerExpressionsUsingBytesLoader(expressionDefinitionId:String, swfBytes:ByteArray, lazyLoad:Boolean = false):void
This API is used to load swf from the specified byte array.
IExpressionEvaluationService
  
registerExpressionsUsingLoader(expressionDefinitionId:String, expressionLoader:IExpressionLoader, lazyLoad:Boolean = false):void
This API is used to load swf using a custom loader.
IExpressionEvaluationService
  
registerExpressionsUsingUrlLoader(expressionDefinitionId:String, swfUrl:String, urlVars:Object = null, lazyLoad:Boolean = false):void
This API is used to load the expression swf from the specified URL.
IExpressionEvaluationService
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
IEventDispatcher
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
IEventDispatcher
Events
 Event Summary Defined By
  Dispatched when the registration of the expression SWF fails.IExpressionEvaluationService
  Dispatched when the expression SWF is successfully registered.IExpressionEvaluationService
Method Detail

evaluateExpression

()method
public function evaluateExpression(expression:String, expressionDefinitionId:String, varsMap:Object, qualifiedClassName:String):Object

Language Version: ActionScript 3.0
Product Version: Expression Manager Building Block 9.5
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This API is used to evaluate an expression at flex side. Throws ExpressionEvaluationError in case Swf load is not complete or errored out.

Parameters

expression:String — expression to be evaluated.
 
expressionDefinitionId:String — unique id used to load the expression swf into flex application.
 
varsMap:Object — map containing variables used in expressions.
 
qualifiedClassName:String — Name of the AS class containing expressions. This name is passed to the generateSWF API at the time of generating swf.

Returns
Object — Evaluated value of the expression.

registerExpressionsUsingBytesLoader

()method 
public function registerExpressionsUsingBytesLoader(expressionDefinitionId:String, swfBytes:ByteArray, lazyLoad:Boolean = false):void

Language Version: ActionScript 3.0
Product Version: Expression Manager Building Block 9.5
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This API is used to load swf from the specified byte array.

Parameters

expressionDefinitionId:String — unique id used later for evaluating expressions contained in this swf.
 
swfBytes:ByteArray — byte[] containing swf.
 
lazyLoad:Boolean (default = false) — if true swf will be loaded on first expression evaluation.

registerExpressionsUsingLoader

()method 
public function registerExpressionsUsingLoader(expressionDefinitionId:String, expressionLoader:IExpressionLoader, lazyLoad:Boolean = false):void

Language Version: ActionScript 3.0
Product Version: Expression Manager Building Block 9.5
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This API is used to load swf using a custom loader. The custom loader is required to implement IExpressionLoader.

Parameters

expressionDefinitionId:String — unique id used later for evaluating expressions contained in this swf.
 
expressionLoader:IExpressionLoader — custom expression loader for loading swf.
 
lazyLoad:Boolean (default = false) — if true swf will be loaded on first expression evaluation. The default value is false.

registerExpressionsUsingUrlLoader

()method 
public function registerExpressionsUsingUrlLoader(expressionDefinitionId:String, swfUrl:String, urlVars:Object = null, lazyLoad:Boolean = false):void

Language Version: ActionScript 3.0
Product Version: Expression Manager Building Block 9.5
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This API is used to load the expression swf from the specified URL. urlVars can be used to specify URL parameters.

The swf is registered with the specified expressionDefinitionId. This id is required to be passed at the time of evaluating expressions.

Parameters

expressionDefinitionId:String — unique id used later for evaluating expressions contained in this swf.
 
swfUrl:String — url of the swf.
 
urlVars:Object (default = null) — url variables
 
lazyLoad:Boolean (default = false) — if true swf will be loaded on first expression evaluation.
Event Detail

expressionRegistrationFailure

Event
Event Object Type: com.adobe.exm.expression.event.ExpressionRegistrationFailureEvent

Language Version: ActionScript 3.0
Product Version: Expression Manager Building Block 9.5
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Dispatched when the registration of the expression SWF fails.

expressionRegistrationSuccess

Event  
Event Object Type: com.adobe.exm.expression.event.ExpressionRegistrationSuccessEvent

Language Version: ActionScript 3.0
Product Version: Expression Manager Building Block 9.5
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Dispatched when the expression SWF is successfully registered.