AutomationEvent

(Preview)

Package	mx.automation.events
Class	public class AutomationEvent
Inheritance	AutomationEvent Event Object

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The AutomationEvent 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.

More examples

Instrumenting events

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		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
		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
		AutomationEvent(type:String = "beginRecord", bubbles:Boolean = true, cancelable:Boolean = true) Constructor.	AutomationEvent
		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
		BEGIN_RECORD : String = "beginRecord" [static] The AutomationEvent.BEGIN_RECORD constant defines the value of the type property of the event object for a beginRecord event.	AutomationEvent
		END_RECORD : String = "endRecord" [static] The AutomationEvent.BEGIN_RECORD constant defines the value of the type property of the event object for a endRecord event.	AutomationEvent

Constructor Detail

()

Constructor

public function AutomationEvent(type:String = "beginRecord", bubbles:Boolean = true, cancelable:Boolean = true)

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Constructor.

Parameters

	`type:String` (default = "`beginRecord`") — 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.

Constant Detail

BEGIN_RECORD

Constant

public static const BEGIN_RECORD:String = "beginRecord"

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The AutomationEvent.BEGIN_RECORD constant defines the value of the type property of the event object for a beginRecord event.

The properties of the event object have the following values:

Property	Value
`bubbles`	true
`cacheable`	`true` if the event should be saved in the event cache, and `false` if not.
`cancelable`	true
`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`.
`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.

END_RECORD

Constant

public static const END_RECORD:String = "endRecord"

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The AutomationEvent.BEGIN_RECORD constant defines the value of the type property of the event object for a endRecord event.

The properties of the event object have the following values:

Property	Value
`bubbles`	true
`cacheable`	`true` if the event should be saved in the event cache, and `false` if not.
`cancelable`	true
`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`.
`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.

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

AutomationEvent - AS3 Flex

Classes x