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

ExpressionBuilderEvent  - AS3 Expression Manager

Packagecom.adobe.solutions.exm.authoring.events
Classpublic class ExpressionBuilderEvent
InheritanceExpressionBuilderEvent Inheritance Event Inheritance Object

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

The ExpressionBuilderEvent class represents events that are dispatched on Expression Builder Toolbar.



Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
  expression : IExpression
Selected Expression
ExpressionBuilderEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
ExpressionBuilderEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)
Constructor.
ExpressionBuilderEvent
  
[override] Duplicates an instance of an Event subclass.
ExpressionBuilderEvent
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns a string containing all the properties of the Event object.
Event
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  CANCEL_EXPRESSION : String = "cancelExpression"
[static] The ExpressionBuilderEvent.CANCEL_EXPRESSION constant defines the value of the type property of the event object for an event that is dispatched when the agent clicks the Cancel button of a Expression Controlbar in Expression Builder UI.
ExpressionBuilderEvent
  EXPRESSION_CREATION_COMPLETED : String = "expressionCreationCompleted"
[static] The ExpressionBuilderEvent.EXPRESSION_CREATION_COMPLETED constant defines the value of the type property of the event object for an event that is dispatched when the agent clicks the Complete(OK) button of a Expression Controlbar in Expression Builder UI.
ExpressionBuilderEvent
  SAVE_EXPRESSION : String = "saveExpression"
[static] The ExpressionBuilderEvent.SAVE_EXPRESSION constant defines the value of the type property of the event object for an event that is dispatched when the agent clicks the Save button of a Expression Toolbar in Expression Builder UI.
ExpressionBuilderEvent
  UPDATE_EXPRESSION : String = "updateExpression"
[static] The ExpressionBuilderEvent.UPDATE_EXPRESSION constant defines the value of the type property of the event object for an event that is dispatched when the agent clicks the Update button of a Expression Toolbar in Expression Builder UI.
ExpressionBuilderEvent
  VALLIDATE_EXPRESSION : String = "validateExpression"
[static] The ExpressionBuilderEvent.VALLIDATE_EXPRESSION constant defines the value of the type property of the event object for an event that is dispatched when the agent clicks the Valiate button of a Expression Toolbar in Expression Builder UI.
ExpressionBuilderEvent
Property Detail

expression

property
public var expression:IExpression

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

Selected Expression

Constructor Detail

ExpressionBuilderEvent

()Constructor
public function ExpressionBuilderEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)

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

Constructor.

Parameters
type:String
 
bubbles:Boolean (default = false)
 
cancelable:Boolean (default = false)
Method Detail

clone

()method
override public function clone():Event

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

Duplicates an instance of an Event subclass.

Returns a new Event object that is a copy of the original instance of the Event object. You do not normally call clone(); the EventDispatcher class calls it automatically when you redispatch an event—that is, when you call dispatchEvent(event) from a handler that is handling event.

The new Event object includes all the properties of the original.

When creating your own custom Event class, you must override the inherited Event.clone() method in order for it to duplicate the properties of your custom class. If you do not set all the properties that you add in your event subclass, those properties will not have the correct values when listeners handle the redispatched event.

In this example, PingEvent is a subclass of Event and therefore implements its own version of clone().

     class PingEvent extends Event {
         var URL:String;
         
     public override function clone():Event {
              return new PingEvent(type, bubbles, cancelable, URL);
        }
     }
     

Returns
Event — A new Event object that is identical to the original.
Constant Detail

CANCEL_EXPRESSION

Constant
public static const CANCEL_EXPRESSION:String = "cancelExpression"

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

The ExpressionBuilderEvent.CANCEL_EXPRESSION constant defines the value of the type property of the event object for an event that is dispatched when the agent clicks the Cancel button of a Expression Controlbar in Expression Builder UI.

EXPRESSION_CREATION_COMPLETED

Constant 
public static const EXPRESSION_CREATION_COMPLETED:String = "expressionCreationCompleted"

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

The ExpressionBuilderEvent.EXPRESSION_CREATION_COMPLETED constant defines the value of the type property of the event object for an event that is dispatched when the agent clicks the Complete(OK) button of a Expression Controlbar in Expression Builder UI.

SAVE_EXPRESSION

Constant 
public static const SAVE_EXPRESSION:String = "saveExpression"

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

The ExpressionBuilderEvent.SAVE_EXPRESSION constant defines the value of the type property of the event object for an event that is dispatched when the agent clicks the Save button of a Expression Toolbar in Expression Builder UI.

UPDATE_EXPRESSION

Constant 
public static const UPDATE_EXPRESSION:String = "updateExpression"

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

The ExpressionBuilderEvent.UPDATE_EXPRESSION constant defines the value of the type property of the event object for an event that is dispatched when the agent clicks the Update button of a Expression Toolbar in Expression Builder UI.

VALLIDATE_EXPRESSION

Constant 
public static const VALLIDATE_EXPRESSION:String = "validateExpression"

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

The ExpressionBuilderEvent.VALLIDATE_EXPRESSION constant defines the value of the type property of the event object for an event that is dispatched when the agent clicks the Valiate button of a Expression Toolbar in Expression Builder UI.