AutomationManager - Adobe ActionScript® 3 (AS3 Flex) API Reference

Package	mx.automation
Class	public class AutomationManager
Inheritance	AutomationManager EventDispatcher Object
Implements	IAutomationManager2, IAutomationObjectHelper, IAutomationMouseSimulator, IAutomationDebugTracer

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Provides the interface for manipulating the automation hierarchy, and for recording and replaying events.

Learn more

Understanding the automation framework
About the AutomationManager class

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		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.	EventDispatcher
		addEventListenersToAllChildApplications(eventDetailsArray:Array):void	AutomationManager
		addEventListenersToAllParentApplications(eventDetailsArray:Array):void	AutomationManager
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		dispatchToAllChildren(event:Event):void	AutomationManager
		dispatchToParent(event:Event):void	AutomationManager
		getAIRWindow(windowId:String):DisplayObject	AutomationManager
		getAIRWindowUniqueID(newWindow:DisplayObject):String	AutomationManager
		getAIRWindowUniqueIDFromAutomationIDPart(objectIdPart:AutomationIDPart):String	AutomationManager
		getAIRWindowUniqueIDFromObjectIDString(objectId:String):String	AutomationManager
		getApplicationNameFromAutomationIDPart(objectIdPart:AutomationIDPart):String	AutomationManager
		getAutomationChildrenArray(object:Object):Array	AutomationManager
		getElementFromPoint2(x:int, y:int, windowId:String):IAutomationObject	AutomationManager
		getMemberFromPartOrObject(part:Object, obj:Object, name:String):Object	AutomationManager
		getPopUpChildObject(index:int):IAutomationObject	AutomationManager
		getPopUpChildren():Array	AutomationManager
		getPopUpChildrenCount():Number	AutomationManager
		getPropertyValueFromPart(part:Object, obj:Object, pd:IAutomationPropertyDescriptor, relativeParent:IAutomationObject = null):Object	AutomationManager
		getStartPointInScreenCoordinates(windowId:String):Point	AutomationManager
		getTopApplicationIndex(objectList:Array):int	AutomationManager
		getUniqueApplicationID():String	AutomationManager
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		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
		marhsalledBeginRecordHandler(event:Event):void	AutomationManager
		marhsalledEndRecordHandler(event:Event):void	AutomationManager
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		recordAutomatableEvent(recorder:IAutomationObject, event:Event, cacheable:Boolean = false):void Dispatch the event as a replayable event.	AutomationManager
		recordCustomAutomationEvent(event:AutomationRecordEvent):Boolean	AutomationManager
		registerNewApplication(application:DisplayObject):void	AutomationManager
		registerNewFlexNativeMenu(menu:Object, sm:DisplayObject):void	AutomationManager
		registerNewWindow(newWindow:DisplayObject):void	AutomationManager
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		storeDragProxy(dragProxy:Object):void	AutomationManager
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		traceMessage(className:String, methodName:String, message:String):void	AutomationManager
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Event		Summary	Defined By
		activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
		deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher

Public Constants

	Constant		Defined By
		airWindowIndicatorPropertyName : String = "isAIRWindow" [static]	AutomationManager

Method Detail

addEventListenersToAllChildApplications

()

method

public function addEventListenersToAllChildApplications(eventDetailsArray:Array):void

Parameters

eventDetailsArray:Array

addEventListenersToAllParentApplications

()

method

public function addEventListenersToAllParentApplications(eventDetailsArray:Array):void

Parameters

eventDetailsArray:Array

dispatchToAllChildren

()

method

public function dispatchToAllChildren(event:Event):void

Parameters

event:Event

dispatchToParent

()

method

public function dispatchToParent(event:Event):void

Parameters

event:Event

getAIRWindow

()

method

public function getAIRWindow(windowId:String):DisplayObject

Parameters

windowId:String

Returns

DisplayObject

getAIRWindowUniqueID

()

method

public function getAIRWindowUniqueID(newWindow:DisplayObject):String

Parameters

newWindow:DisplayObject

Returns

String

getAIRWindowUniqueIDFromAutomationIDPart

()

method

public function getAIRWindowUniqueIDFromAutomationIDPart(objectIdPart:AutomationIDPart):String

Parameters

objectIdPart:AutomationIDPart

Returns

String

getAIRWindowUniqueIDFromObjectIDString

()

method

public function getAIRWindowUniqueIDFromObjectIDString(objectId:String):String

Parameters

objectId:String

Returns

String

getApplicationNameFromAutomationIDPart

()

method

public function getApplicationNameFromAutomationIDPart(objectIdPart:AutomationIDPart):String

Parameters

objectIdPart:AutomationIDPart

Returns

String

getAutomationChildrenArray

()

method

public function getAutomationChildrenArray(object:Object):Array

Parameters

object:Object

Returns

Array

getElementFromPoint2

()

method

public function getElementFromPoint2(x:int, y:int, windowId:String):IAutomationObject

Parameters

	`x:int`

	`y:int`

	`windowId:String`

Returns

IAutomationObject

getMemberFromPartOrObject

()

method

public function getMemberFromPartOrObject(part:Object, obj:Object, name:String):Object

Parameters

	`part:Object`

	`obj:Object`

	`name:String`

Returns

Object

getPopUpChildObject

()

method

public function getPopUpChildObject(index:int):IAutomationObject

Parameters

index:int

Returns

IAutomationObject

getPopUpChildren

()

method

public function getPopUpChildren():Array

Returns

Array

getPopUpChildrenCount

()

method

public function getPopUpChildrenCount():Number

Returns

Number

getPropertyValueFromPart

()

method

 public function getPropertyValueFromPart(part:Object, obj:Object, pd:IAutomationPropertyDescriptor, relativeParent:IAutomationObject = null):Object

Parameters

	`part:Object`

	`obj:Object`

	`pd:IAutomationPropertyDescriptor`

	`relativeParent:IAutomationObject` (default = `null`)

Returns

Object

getStartPointInScreenCoordinates

()

method

public function getStartPointInScreenCoordinates(windowId:String):Point

Parameters

windowId:String

Returns

Point

getTopApplicationIndex

()

method

public function getTopApplicationIndex(objectList:Array):int

Parameters

objectList:Array

Returns

int

getUniqueApplicationID

()

method

public function getUniqueApplicationID():String

Returns

String

marhsalledBeginRecordHandler

()

method

public function marhsalledBeginRecordHandler(event:Event):void

Parameters

event:Event

marhsalledEndRecordHandler

()

method

public function marhsalledEndRecordHandler(event:Event):void

Parameters

event:Event

recordAutomatableEvent

()

method

public function recordAutomatableEvent(recorder:IAutomationObject, event:Event, cacheable:Boolean = false):void

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Dispatch the event as a replayable event. Causes the ReplayableEventEvent with REPLAYABLE_EVENT type to be fired. However, this method will not attempt the dispatch if there are no listeners.

Parameters

	`recorder:IAutomationObject` — The IEventReplayer dispatching this event since event.target may not be accurate

	`event:Event` — The event that represents the replayable event.

	`cacheable:Boolean` (default = `false`)

recordCustomAutomationEvent

()

method

public function recordCustomAutomationEvent(event:AutomationRecordEvent):Boolean

Parameters

event:AutomationRecordEvent

Returns

Boolean

registerNewApplication

()

method

public function registerNewApplication(application:DisplayObject):void

Parameters

application:DisplayObject

registerNewFlexNativeMenu

()

method

public function registerNewFlexNativeMenu(menu:Object, sm:DisplayObject):void

Parameters

	`menu:Object`

	`sm:DisplayObject`

registerNewWindow

()

method

public function registerNewWindow(newWindow:DisplayObject):void

Parameters

newWindow:DisplayObject

storeDragProxy

()

method

public function storeDragProxy(dragProxy:Object):void

Parameters

dragProxy:Object

traceMessage

()

method

public function traceMessage(className:String, methodName:String, message:String):void

Parameters

	`className:String`

	`methodName:String`

	`message:String`

Constant Detail

airWindowIndicatorPropertyName

Constant

public static const airWindowIndicatorPropertyName:String = "isAIRWindow"

AutomationManager - AS3 Flex

Classes x

addEventListenersToAllChildApplications

addEventListenersToAllParentApplications

dispatchToAllChildren

dispatchToParent

getAIRWindow

getAIRWindowUniqueID

getAIRWindowUniqueIDFromAutomationIDPart

getAIRWindowUniqueIDFromObjectIDString

getApplicationNameFromAutomationIDPart

getAutomationChildrenArray

getElementFromPoint2

getMemberFromPartOrObject

getPopUpChildObject

getPopUpChildren

getPopUpChildrenCount

getPropertyValueFromPart

getStartPointInScreenCoordinates

getTopApplicationIndex

getUniqueApplicationID

marhsalledBeginRecordHandler

marhsalledEndRecordHandler

recordAutomatableEvent

recordCustomAutomationEvent

registerNewApplication

registerNewFlexNativeMenu

registerNewWindow

storeDragProxy

traceMessage

airWindowIndicatorPropertyName

mx.automation AutomationManager - AS3 Flex		Properties \| Properties \| Constructor \| Methods \| Global Constants \| Events \| Styles \| Skin Parts \| Skin States \| Effects \| Constants \| Global Functions \| Functions \| Interfaces \| Classes \| Examples