mx.automation

# AutomationHelper - AS3 Flex

Package | mx.automation
Class | public class AutomationHelper
Inheritance | AutomationHelper Object

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Helper class used to call appropriate methods based on whether the current app is an AIR app or a Flex app.

Learn more

Understanding the automation framework

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
--- | --- | ---
|  | AutomationHelper() Constructor | AutomationHelper
|  | getActiveWindow(windowId:String):Object [static] Returns the current active window in case of AIR app, top level application otherwise. | AutomationHelper
|  | getAirHelperClass(className:String):Class [static] Returns the helper class used for AIR automation (AirFunctionsHelper). | AutomationHelper
|  | getAppTitle():String [static] Returns the title in case of AIR app, empty string otherwise. | AutomationHelper
|  | getMainApplication():Object [static] Returns the top level application. | AutomationHelper
|  | getStageStartPointInScreenCoords(windowId:String):Point [static] Returns the start point in screen coordinates. | AutomationHelper
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isAirClassLoaded():Boolean [static] Returns false if AIR helper class (AirFunctionsHelper) is not loaded. | AutomationHelper
|  | isCurrentAppAir():Boolean [static] Returns true if the current application is an AIR app, false otherwise. | AutomationHelper
|  | 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
|  | isRequiredAirClassPresent():Boolean [static] Returns false if AIR helper class (mx.automation.air.AirFunctionsHelper) is not found. | AutomationHelper
|  | isRequiredSparkClassPresent():Boolean [static] | AutomationHelper
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | registerSystemManager(sm1:ISystemManager):void [static] Sets the system manager using which the root application is determined. | AutomationHelper
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | 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
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Constructor Detail

### AutomationHelper

()
Constructor

`public function AutomationHelper()`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Constructor

Method Detail

### getActiveWindow

()
method

`public static function getActiveWindow(windowId:String):Object`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Returns the current active window in case of AIR app, top level application otherwise.

Parameters

| `windowId:String`

Returns

| `Object`

### getAirHelperClass

()
method

`public static function getAirHelperClass(className:String):Class`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Returns the helper class used for AIR automation (AirFunctionsHelper).

Parameters

| `className:String`

Returns

| `Class`

### getAppTitle

()
method

`public static function getAppTitle():String`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Returns the title in case of AIR app, empty string otherwise.

Returns

| `String`

### getMainApplication

()
method

`public static function getMainApplication():Object`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Returns the top level application.

Returns

| `Object`

### getStageStartPointInScreenCoords

()
method

`public static function getStageStartPointInScreenCoords(windowId:String):Point`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Returns the start point in screen coordinates.

Parameters

| `windowId:String`

Returns

| `Point`

### isAirClassLoaded

()
method

`public static function isAirClassLoaded():Boolean`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Returns false if AIR helper class (AirFunctionsHelper) is not loaded.

Returns

| `Boolean`

### isCurrentAppAir

()
method

`public static function isCurrentAppAir():Boolean`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Returns true if the current application is an AIR app, false otherwise.

Returns

| `Boolean`

### isRequiredAirClassPresent

()
method

`public static function isRequiredAirClassPresent():Boolean`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Returns false if AIR helper class (mx.automation.air.AirFunctionsHelper) is not found.

Returns

| `Boolean`

### isRequiredSparkClassPresent

()
method

`public static function isRequiredSparkClassPresent():Boolean`

Returns

| `Boolean`

### registerSystemManager

()
method

`public static function registerSystemManager(sm1:ISystemManager):void`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Sets the system manager using which the root application is determined.

Parameters

| `sm1:ISystemManager`

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