| Package | mx.automation |
| Interface | public interface IAutomationManager2 extends IAutomationManager , IEventDispatcher |
| Implementors | AutomationManager |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
More examples
Learn more
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | automationEnvironment : Object
The automation environment for this automation manager. | IAutomationManager | |
| automationEnvironmentHandlingClassName : String [write-only]
Marshalling Support(for tool): The tool class which is responsible for handling
the automation environment. | IAutomationManager2 | ||
| automationEnvironmentString : String [write-only]
The automation environment for this automation manager. | IAutomationManager2 | ||
| recording : Boolean [read-only]
Indicates whether recording is taking place. | IAutomationManager | |
| replaying : Boolean [read-only]
Indicates whether replay is taking place. | IAutomationManager | |
| 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. | IEventDispatcher | |
Marshalling Support(for tool): Adds the passed EventDetails objects to the probable
child applications in the current ApplicationDomain. | IAutomationManager2 | ||
Marshalling Support(for tool): Adds the passed EventDetails objects to the probable
parent applications in the current ApplicationDomain. | IAutomationManager2 | ||
|
Sets the automation manager to record mode. | IAutomationManager | |
|
Returns an id for the given object that can be used
with the resolveID() method. | IAutomationManager | |
|
Returns an id part for the given object that can be used in the resolveIDPart() method. | IAutomationManager | |
|
Decrement the cache counter. | IAutomationManager | |
|
Dispatches an event into the event flow. | IEventDispatcher | |
Marshalling Support(for tool): Dispatches event to all children. | IAutomationManager2 | ||
Marshalling Support(for tool): Dispatches event to parent applications. | IAutomationManager2 | ||
|
Takes the automation manager out of record mode. | IAutomationManager | |
AIR support(for tool): Returns the window with the passed id. | IAutomationManager2 | ||
AIR support(for tool): Returns the unique id of the window object. | IAutomationManager2 | ||
AIR support(for tool): Returns the unique ID of window from the automation ID part. | IAutomationManager2 | ||
AIR support(for tool): Returns the unique ID of window from the object ID. | IAutomationManager2 | ||
Marshalling Support(for tool): Returns name of the application from the part id. | IAutomationManager2 | ||
|
Returns the text to display as the type of the object. | IAutomationManager | |
|
Returns the text to display as the description for the object. | IAutomationManager | |
|
Returns all children of this object that are visible within the testing
hierarchy. | IAutomationManager | |
| getChildrenFromIDPart(obj:IAutomationObject, part:AutomationIDPart = null, ignoreShowInHierarchy:Boolean = false):Array
Returns all children of this object that are visible within the testing
hierarchy and meet the criteria in the automation part. | IAutomationManager | |
|
Returns the automation object under the given coordinate. | IAutomationManager | |
AIR support(for tool): Returns the automation object under the given coordinate in a window. | IAutomationManager2 | ||
| getParent(obj:IAutomationObject, parentToStopAt:IAutomationObject = null, ignoreShowInHierarchy:Boolean = false):IAutomationObject
Returns the next parent that is visible within the automation hierarchy. | IAutomationManager | |
Marshalling Support(for delegates):Returns array of pop up objects of the root application. | IAutomationManager2 | ||
Marshalling Support(for delegates):Returns array of pop up objects of the top level application. | IAutomationManager2 | ||
Marshalling Support(for delegates):Returns the number of pop up children of the
top level application. | IAutomationManager2 | ||
| getProperties(obj:IAutomationObject, names:Array = null, forVerification:Boolean = true, forDescription:Boolean = true):Array
Returns the values for a set of properties. | IAutomationManager | |
|
The display rectangle enclosing the DisplayObject. | IAutomationManager | |
AIR support(for tool): Used by Flex application loaded from AIR application,
to get the start point of main AIR application in screen coordinates
| IAutomationManager2 | ||
|
Returns the object implementing the IAutomationTabularData interface through which
the tabular data can be obtained. | IAutomationManager | |
Marshalling Support(for tool): Returns the index of top visible object among the passed array of objects. | IAutomationManager2 | ||
Marshalling Support(for tool): Returns unique ID of the application considering
the hierarchy using the SWFLoader information and the application name. | IAutomationManager2 | ||
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | IEventDispatcher | |
|
Increments the cache counter. | IAutomationManager | |
Marshalling Support(for tool): Returns true if the passed object is a pop up. | IAutomationManager2 | ||
|
Tests if the provided target needs to wait until a previous
operation completes. | IAutomationManager | |
|
Returns true if an object and all of its parents are visible. | IAutomationManager | |
|
Records the event. | IAutomationManager | |
|
Records the custom event. | IAutomationManager | |
Marshalling Support(for delegates): When a new application is added, application delegate
registers itself so that appropriate listeners are added to that in order to support
Marshalling. | IAutomationManager2 | ||
AIR Support(for delegates): When a FlexNativeMenu is added to a component, its delegate
registers the new FlexNativeMenu object and creates a delegate. | IAutomationManager2 | ||
AIR Support(for delegates): When a new window is added, WindowedApplication delegate registers
the new window object so that a unique id is created for that window. | IAutomationManager2 | ||
|
Removes a listener from the EventDispatcher object. | IEventDispatcher | |
|
Replays the specified event. | IAutomationManager | |
|
Resolves an id to automation objects. | IAutomationManager | |
|
Resolves an id part to an Array of automation objects. | IAutomationManager | |
|
Resolves an id part to an automation object within the parent. | IAutomationManager | |
|
Resolves an id to an automation object. | IAutomationManager | |
|
Indicates whether an automation object should be visible within
the hierarchy. | IAutomationManager | |
Marshalling Support(for delegates): Stores the drag proxy to enable
inter-application drag-drop.DragProxy created in one application should be
accessible by another application if required. | IAutomationManager2 | ||
|
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | IEventDispatcher | |
automationEnvironmentHandlingClassName | property |
automationEnvironmentHandlingClassName:String [write-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Marshalling Support(for tool): The tool class which is responsible for handling the automation environment.
Implementation
public function set automationEnvironmentHandlingClassName(value:String):voidautomationEnvironmentString | property |
automationEnvironmentString:String [write-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The automation environment for this automation manager. The automation environment provides information about the objects and properties of testable components needed for communicating with agent tools. The value of this property must implement the IAutomationEnvironment interface.
Implementation
public function set automationEnvironmentString(value:String):voidRelated API Elements
addEventListenersToAllChildApplications | () | method |
public function addEventListenersToAllChildApplications(eventDetailsArray:Array):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Marshalling Support(for tool): Adds the passed EventDetails objects to the probable child applications in the current ApplicationDomain. AutomationManager identifies the child applications in the current ApplicationDomain as and when the application is loaded, and adds appropriate listeners obtained from the passed objects.
Parameters
eventDetailsArray:Array — Array of EventDetails objects.
|
addEventListenersToAllParentApplications | () | method |
public function addEventListenersToAllParentApplications(eventDetailsArray:Array):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Marshalling Support(for tool): Adds the passed EventDetails objects to the probable parent applications in the current ApplicationDomain. AutomationManager identifies the parent applications in the current ApplicationDomain which are responsible to listen to the events from children and adds appropriate listeners obtained from the passed objects.
Parameters
eventDetailsArray:Array — Array of EventDetails objects.
|
dispatchToAllChildren | () | method |
dispatchToParent | () | method |
getAIRWindow | () | method |
public function getAIRWindow(windowId:String):DisplayObject| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
AIR support(for tool): Returns the window with the passed id.
Parameters
windowId:String — id of the window
|
DisplayObject — Window with passed id.
|
getAIRWindowUniqueID | () | method |
public function getAIRWindowUniqueID(newWindow:DisplayObject):String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
AIR support(for tool): Returns the unique id of the window object.
Parameters
newWindow:DisplayObject — window whose id is to required.
|
String — String
|
getAIRWindowUniqueIDFromAutomationIDPart | () | method |
public function getAIRWindowUniqueIDFromAutomationIDPart(objectIdPart:AutomationIDPart):String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
AIR support(for tool): Returns the unique ID of window from the automation ID part. Automation ID part has application ID and window ID.
Parameters
objectIdPart:AutomationIDPart — The AutomationIDPart from which unique ID of the window is to be obtained.
|
String |
getAIRWindowUniqueIDFromObjectIDString | () | method |
public function getAIRWindowUniqueIDFromObjectIDString(objectId:String):String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
AIR support(for tool): Returns the unique ID of window from the object ID. Object ID has application ID and window ID.
Parameters
objectId:String — The object ID from which unique ID of the window is to be obtained.
|
String |
getApplicationNameFromAutomationIDPart | () | method |
public function getApplicationNameFromAutomationIDPart(objectID:AutomationIDPart):String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Marshalling Support(for tool): Returns name of the application from the part id.
Parameters
objectID:AutomationIDPart — AutomationIDPart from which the application name is obtained.
|
String |
getElementFromPoint2 | () | method |
public function getElementFromPoint2(x:int, y:int, windowId:String):IAutomationObject| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
AIR support(for tool): Returns the automation object under the given coordinate in a window.
Parameters
x:int — The x coordinate.
| |
y:int — The y coordinate.
| |
windowId:String — The window on which the object is to be identified.
|
IAutomationObject — Automation object at that point.
|
getPopUpChildObject | () | method |
public function getPopUpChildObject(index:int):IAutomationObject| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Marshalling Support(for delegates):Returns array of pop up objects of the root application. All pop up objects created in an application are added as pop up children to the top level application of its ApplicationDomain.
Parameters
index:int — at which the object is to be retrieved
|
IAutomationObject — IAutomationObject at the given index
|
getPopUpChildren | () | method |
public function getPopUpChildren():Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Marshalling Support(for delegates):Returns array of pop up objects of the top level application. All pop up objects created in an application are added as pop up children to the top level application of its ApplicationDomain.
ReturnsArray — Array of pop up children
|
getPopUpChildrenCount | () | method |
public function getPopUpChildrenCount():Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Marshalling Support(for delegates):Returns the number of pop up children of the top level application. All pop up objects created in an application are added as pop up children to the top level application of its ApplicationDomain.
ReturnsNumber — Number of pop up children
|
getStartPointInScreenCoordinates | () | method |
public function getStartPointInScreenCoordinates(windowId:String):Point| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
AIR support(for tool): Used by Flex application loaded from AIR application, to get the start point of main AIR application in screen coordinates
Parameters
windowId:String |
Point |
getTopApplicationIndex | () | method |
public function getTopApplicationIndex(objectList:Array):int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Marshalling Support(for tool): Returns the index of top visible object among the passed array of objects. This can be used by tools to identify the topmost Application object when there are multiple objects from different applications, which belong to different ApplicationDomain or different SecurityDomain, under the mouse.
Parameters
objectList:Array — Array of objects
|
int |
getUniqueApplicationID | () | method |
public function getUniqueApplicationID():String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Marshalling Support(for tool): Returns unique ID of the application considering the hierarchy using the SWFLoader information and the application name.
ReturnsString |
isObjectPopUp | () | method |
public function isObjectPopUp(obj:IAutomationObject):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Marshalling Support(for tool): Returns true if the passed object is a pop up.
Parameters
obj:IAutomationObject — IAutomationObject
|
Boolean |
registerNewApplication | () | method |
public function registerNewApplication(application:DisplayObject):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Marshalling Support(for delegates): When a new application is added, application delegate registers itself so that appropriate listeners are added to that in order to support Marshalling.
Parameters
application:DisplayObject — Application object to be registered.
|
registerNewFlexNativeMenu | () | method |
public function registerNewFlexNativeMenu(menu:Object, sm:DisplayObject):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
AIR Support(for delegates): When a FlexNativeMenu is added to a component, its delegate registers the new FlexNativeMenu object and creates a delegate.
Parameters
menu:Object — FlexNativeMenu object to be registered.
| |
sm:DisplayObject — SystemManager of the component in which FlexNativeMenu is added.
|
registerNewWindow | () | method |
public function registerNewWindow(newWindow:DisplayObject):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
AIR Support(for delegates): When a new window is added, WindowedApplication delegate registers the new window object so that a unique id is created for that window.
Parameters
newWindow:DisplayObject — Window object to be registered.
|
storeDragProxy | () | method |
public function storeDragProxy(dragProxy:Object):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Marshalling Support(for delegates): Stores the drag proxy to enable inter-application drag-drop.DragProxy created in one application should be accessible by another application if required.
Parameters
dragProxy:Object — object
|
Mon Nov 28 2011, 06:48 AM -08:00