mx.automation.events

# AutomationReplayEvent - AS3 Flex

Package | mx.automation.events
Class | public class AutomationReplayEvent
Inheritance | AutomationReplayEvent Event Object

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The AutomationReplayEvent class represents event objects that are dispatched by the AutomationManager, and used by the functional testing classes and any other classes that must replay user interactions.

Learn more

Instrumenting events

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | automationObject : IAutomationObject Delegate of the UIComponent object on which this event will be replayed since the target on an event that was not really dispatched is not available. | AutomationReplayEvent
|  | bubbles : Boolean [read-only] Indicates whether an event is a bubbling event. | Event
|  | cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented. | Event
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener. | Event
|  | eventPhase : uint [read-only] The current phase in the event flow. | Event
|  | replayableEvent : Event Event to the replayed. | AutomationReplayEvent
|  | succeeded : Boolean Contains true if the replay was successful, and false if not. | AutomationReplayEvent
|  | target : Object [read-only] The event target. | Event
|  | type : String [read-only] The type of event. | Event

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | AutomationReplayEvent(type:String = "replay", bubbles:Boolean = false, cancelable:Boolean = false, automationObject:IAutomationObject = null, replayableEvent:Event = null) Constructor. | AutomationReplayEvent
|  | clone():Event Duplicates an instance of an Event subclass. | Event
|  | formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes. | Event
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event. | Event
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | preventDefault():void Cancels an event's default behavior if that behavior can be canceled. | Event
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow. | Event
|  | stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. | Event
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns a string containing all the properties of the Event object. | Event
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | REPLAY : String = "replay" [static] The AutomationReplayEvent.REPLAY constant defines the value of the type property of the event object for a replay event. | AutomationReplayEvent

Property Detail

### automationObject

property

`public var automationObject:IAutomationObject`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Delegate of the UIComponent object on which this event will be replayed since the target on an event that was not really dispatched is not available.

### replayableEvent

property

`public var replayableEvent:Event`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Event to the replayed.

### succeeded

property

`public var succeeded:Boolean`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Contains `true` if the replay was successful, and `false` if not.

Constructor Detail

### AutomationReplayEvent

()
Constructor

`public function AutomationReplayEvent(type:String = "replay", bubbles:Boolean = false, cancelable:Boolean = false, automationObject:IAutomationObject = null, replayableEvent:Event = null)`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Constructor.

Parameters

| `type:String` (default = "`replay`")`` — The event type; indicates the action that caused the event.
| `bubbles:Boolean` (default = `false`)`` — Whether the event can bubble up the display list hierarchy.
| `cancelable:Boolean` (default = `false`)`` — Whether the behavior associated with the event can be prevented.
| `automationObject:IAutomationObject` (default = `null`)`` — Delegate of the UIComponent that dispatched the interaction earlier.
| `replayableEvent:Event` (default = `null`)`` — Event that needs to be replayed.

Constant Detail

### REPLAY

Constant

`public static const REPLAY:String = "replay"`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The `AutomationReplayEvent.REPLAY` constant defines the value of the `type` property of the event object for a `replay` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`automationObject` | Delegate of the UIComponent that dispatched the interaction earlier.
`bubbles` | false
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`replayableEvent` | Event that needs to be replayed.
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00