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

IExpression  - AS3 Expression Manager

Packagecom.adobe.solutions.exm.authoring.domain.expression
Interfacepublic interface IExpression extends IEventDispatcher

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

Represents an expression object for authoring purposes.



Public Properties
 PropertyDefined By
  assignedTo : String
Returns the variable this expression is assigned to, or null if the expression is not assigned to any variable.
IExpression
  description : String
Returns a human-readable verbose description for this expression.
IExpression
  displayName : String
Returns a human-readable display-text for this expression.
IExpression
  expression : String
Returns the actual expression string represented by this expression.
IExpression
  id : String
[read-only] Returns the unique ID of this expression.
IExpression
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
  
Fires an asynchronous operation for creating this expression in the expression repository.
IExpression
  
Fires an asynchronous operation for deleting this expression from the expression repository.
IExpression
 Inherited
Dispatches an event into the event flow.
IEventDispatcher
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
IEventDispatcher
  
Returns the list of variables referenced inside this expression.
IExpression
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
IEventDispatcher
  
Fires an asynchronous operation for updating this expression in the expression repository.
IExpression
  
Validates this expression for syntactic correctness.
IExpression
 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 expression is successfully created in the expression repository.IExpression
  Dispatched when the expression is successfully deleted from the expression repository.IExpression
  Dispatched when an error occurs while creating/updating/deleting the expression in the expression repository.IExpression
  Dispatched when the expression is successfully updated in the expression repository.IExpression
Property Detail

assignedTo

property
assignedTo:String

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

Returns the variable this expression is assigned to, or null if the expression is not assigned to any variable.



Implementation
    public function get assignedTo():String
    public function set assignedTo(value:String):void

description

property 
description:String

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

Returns a human-readable verbose description for this expression.



Implementation
    public function get description():String
    public function set description(value:String):void

displayName

property 
displayName:String

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

Returns a human-readable display-text for this expression.



Implementation
    public function get displayName():String
    public function set displayName(value:String):void

expression

property 
expression:String

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

Returns the actual expression string represented by this expression.



Implementation
    public function get expression():String
    public function set expression(value:String):void

id

property 
id:String  [read-only]

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

Returns the unique ID of this expression.



Implementation
    public function get id():String
Method Detail

createExpression

()method
public function createExpression():void

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

Fires an asynchronous operation for creating this expression in the expression repository. Returns immediately and causes the current object to later dispatch one of the following events:

  • If the operation succeeds, an event with name "expressionCreateEvent" of type ExpressionCreateEvent. The 'expression' property of the event will be a reference to the current expression object.
  • If the operation fails, an event with name "expressionErrorEvent" of type ErrorEvent. The 'error' property on the event will contain the actual error thrown by the operation.

deleteExpression

()method 
public function deleteExpression():void

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

Fires an asynchronous operation for deleting this expression from the expression repository. Returns immediately and causes the current object to later dispatch one of the following events:

  • If the operation succeeds, an event with name "expressionDeleteEvent" of type ExpressionDeleteEvent. The 'expression' property of the event will be a reference to the current expression object.
  • If the operation fails, an event with name "expressionErrorEvent" of type ErrorEvent. The 'error' property on the event will contain the actual error thrown by the operation.

referencedVariables

()method 
public function referencedVariables():IList

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

Returns the list of variables referenced inside this expression.

Returns
IList — A list of string variable-names corresponding to the variables referenced inside this expression.

updateExpression

()method 
public function updateExpression():void

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

Fires an asynchronous operation for updating this expression in the expression repository. Returns immediately and causes the current object to later dispatch one of the following events:

  • If the operation succeeds, an event with name "expressionUpdateEvent" of type ExpressionUpdateEvent. The 'expression' property of the event will be a reference to the current expression object.
  • If the operation fails, an event with name "expressionErrorEvent" of type ErrorEvent. The 'error' property on the event will contain the actual error thrown by the operation.

validate

()method 
public function validate():ExpressionValidationResult

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

Validates this expression for syntactic correctness.

Returns
ExpressionValidationResult — An ExpressionValidationResult instance encapsulating the result of validation.
Event Detail

expressionCreateEvent

Event
Event Object Type: com.adobe.solutions.exm.authoring.domain.expression.ExpressionCreateEvent

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

Dispatched when the expression is successfully created in the expression repository.

expressionDeleteEvent

Event  
Event Object Type: com.adobe.solutions.exm.authoring.domain.expression.ExpressionDeleteEvent

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

Dispatched when the expression is successfully deleted from the expression repository.

expressionErrorEvent

Event  
Event Object Type: com.adobe.solutions.exm.authoring.domain.ErrorEvent

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

Dispatched when an error occurs while creating/updating/deleting the expression in the expression repository.

expressionUpdateEvent

Event  
Event Object Type: com.adobe.solutions.exm.authoring.domain.expression.ExpressionUpdateEvent

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

Dispatched when the expression is successfully updated in the expression repository.