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.impl 

ExpressionEvaluationService  - AS3 Expression Manager

Packagecom.adobe.exm.expression.impl
Classpublic class ExpressionEvaluationService
InheritanceExpressionEvaluationService Inheritance EventDispatcher Inheritance Object
Implements IExpressionEvaluationService
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)

Used to register the expression SWF and evaluate the expression using pre-loaded SWF.



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
Public Methods
 MethodDefined By
  
ExpressionEvaluationService(defaultSwfUrl:String, expressionDefinitionParamName:String)
Constructor of expression evaluation service.
ExpressionEvaluationService
 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.
EventDispatcher
 Inherited
Dispatches an event into the event flow.
EventDispatcher
  
evaluateExpression(expression:String, expressionDefinitionId:String, varsMap:Object, qualifiedClassName:String):Object
This API is used to evaluate an expression at flex side.
ExpressionEvaluationService
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
  
registerExpressionsUsingBytesLoader(expressionDefinitionId:String, swfBytes:ByteArray, lazyLoad:Boolean = false):void
Used to load swf from the specified byte array.
ExpressionEvaluationService
  
registerExpressionsUsingLoader(expressionDefinitionId:String, expressionLoader:IExpressionLoader, lazyLoad:Boolean = false):void
Used to load swf using a custom loader.
ExpressionEvaluationService
  
registerExpressionsUsingUrlLoader(expressionDefinitionId:String, swfUrl:String, urlVars:Object = null, lazyLoad:Boolean = false):void
Used to load the expression swf from the specified URL.
ExpressionEvaluationService
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
  Dispatched when the registration of the expression SWF fails.ExpressionEvaluationService
  Dispatched when the expression SWF is successfully registered.ExpressionEvaluationService
Constructor Detail

ExpressionEvaluationService

()Constructor
public function ExpressionEvaluationService(defaultSwfUrl:String, expressionDefinitionParamName:String)

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

Constructor of expression evaluation service.

Parameters
defaultSwfUrl:String — URL of the SWF.
 
expressionDefinitionParamName:String — parameter name used in SWF url.
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)

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)

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.

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)

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.