ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
mx.automation.events 

AutomationRecordEvent  - AS3 Flex
Packagemx.automation.events
Classpublic class AutomationRecordEvent
InheritanceAutomationRecordEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The AutomationRecordEvent class represents event objects that are dispatched by the AutomationManager. Used by the functional testing classes and any other classes that must record user interactions.

Learn more

Instrumenting events

Public Properties
 PropertyDefined By
  args : Array
A serialized representation of the event as an Array of it's property values.
AutomationRecordEvent
  automationObject : IAutomationObject
The delegate of the UIComponent object that is recording this event.
AutomationRecordEvent
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
  cacheable : Boolean
Contains true if this is a cacheable event, and false if not.
AutomationRecordEvent
 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
  name : String
The automation event name.
AutomationRecordEvent
  recordTriggeredByCustomHandling : Boolean
Contains true if this event current record is caused from a custom record event, and false if not.
AutomationRecordEvent
  replayableEvent : Event
The underlying interaction.
AutomationRecordEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
AutomationRecordEvent(type:String = "record", bubbles:Boolean = true, cancelable:Boolean = true, automationObject:IAutomationObject = null, replayableEvent:Event = null, args:Array = null, name:String = null, cacheable:Boolean = false, recordTriggeredByCustomHandling:Boolean = false)
Constructor.
AutomationRecordEvent
 Inherited
clone():Event
Duplicates an instance of an Event subclass.
Event
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
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
 Inherited
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns a string containing all the properties of the Event object.
Event
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  CUSTOM_RECORD : String = "customRecord"
[static] refer recordCustomAutomationEvent in IAutomationManager for the usage of this constant
AutomationRecordEvent
  RECORD : String = "record"
[static] The AutomationRecordEvent.RECORD constant defines the value of the type property of the event object for a record event.
AutomationRecordEvent
Property Detail

args

property
public var args:Array

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

A serialized representation of the event as an Array of it's property values.

automationObject

property 
public var automationObject:IAutomationObject

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The delegate of the UIComponent object that is recording this event.

cacheable

property 
public var cacheable:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Contains true if this is a cacheable event, and false if not.

name

property 
public var name:String

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The automation event name.

recordTriggeredByCustomHandling

property 
public var recordTriggeredByCustomHandling:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Contains true if this event current record is caused from a custom record event, and false if not. User can use this field to differentiate the record event triggered by the framework and the custom record. e.g if the list has the select event and currently it recors the selection details either with index or with the selected item. But user would like to record the details with both but would like to record it with the same event name, it will be pretty cumborosome to differentiate the select event triggerd by framework and the one triggered by using the recordCustomAutomationEvent() API on the automation manager. If the event was triggered using the recordCustomAutomationEvent() API this flag will be true. In all other cases framework will keep this flag with the default value

replayableEvent

property 
public var replayableEvent:Event

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The underlying interaction.

Constructor Detail

AutomationRecordEvent

()Constructor
public function AutomationRecordEvent(type:String = "record", bubbles:Boolean = true, cancelable:Boolean = true, automationObject:IAutomationObject = null, replayableEvent:Event = null, args:Array = null, name:String = null, cacheable:Boolean = false, recordTriggeredByCustomHandling:Boolean = false)

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Constructor.

Parameters
type:String (default = "record") — The event type; indicates the action that caused the event.
 
bubbles:Boolean (default = true) — Whether the event can bubble up the display list hierarchy.
 
cancelable:Boolean (default = true) — Whether the behavior associated with the event can be prevented.
 
automationObject:IAutomationObject (default = null) — Delegate of the UIComponent that is dispatching the interaction.
 
replayableEvent:Event (default = null) — Underlying event that represents the interaction.
 
args:Array (default = null) — Array of arguments that are passed to the method that is currently being recorded.
 
name:String (default = null) — Displayable name of the operation.
 
cacheable:Boolean (default = false) — true if the event should be saved in the event cache, and false if not.
 
recordTriggeredByCustomHandling:Boolean (default = false)
Constant Detail

CUSTOM_RECORD

Constant
public static const CUSTOM_RECORD:String = "customRecord"

refer recordCustomAutomationEvent in IAutomationManager for the usage of this constant

RECORD

Constant 
public static const RECORD:String = "record"

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The AutomationRecordEvent.RECORD constant defines the value of the type property of the event object for a record event.

The properties of the event object have the following values:

PropertyValue
argsArray of arguments to the method.
automationObjectDelegate of the UIComponent that is dispatching the interaction.
bubblestrue
cacheabletrue if the event should be saved in the event cache, and false if not.
cancelabletrue
currentTargetThe 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.
methodNameA displayable Name of the operation
replayableEventUnderlying event that represents the interaction.
targetThe 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.



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy