mx.automation.delegates.core

# UIComponentAutomationImpl - AS3 Flex

Package | mx.automation.delegates.core
Class | public class UIComponentAutomationImpl
Inheritance | UIComponentAutomationImpl EventDispatcher Object
Implements | IAutomationObject
Subclasses | AdvancedDataGridGroupItemRendererAutomationImpl, AdvancedListBaseContentHolderAutomationImpl, AlertFormAutomationImpl, AxisRendererAutomationImpl, ButtonAutomationImpl, ChartBaseAutomationImpl, ComboBaseAutomationImpl, ContainerAutomationImpl, DateChooserAutomationImpl, DragManagerAutomationImpl, FileSystemDataGridNameColumnRendererAutomationImpl, LabelAutomationImpl, LegendAutomationImpl, LegendItemAutomationImpl, ListBaseContentHolderAutomationImpl, ListItemRendererAutomationImpl, MenuBarAutomationImpl, MenuBarItemAutomationImpl, MenuItemRendererAutomationImpl, NumericStepperAutomationImpl, OLAPDataGridGroupRendererAutomationImpl, ProgressBarAutomationImpl, RepeaterAutomationImpl, ScrollBarAutomationImpl, ScrollControlBaseAutomationImpl, SeriesAutomationImpl, SliderAutomationImpl, SparkDefaultItemRendererAutomationImpl, SparkGroupBaseAutomationImpl, SparkPopUpAnchorAutomationImpl, SparkRichEditableTextAutomationImpl, SparkSkinnableComponentAutomationImpl, SparkTextBaseAutomationImpl, SparkVideoDisplayAutomationImpl, SWFLoaderAutomationImpl, TextInputAutomationImpl, TileListItemRendererAutomationImpl, ToolTipAutomationImpl, TreeItemRendererAutomationImpl, VideoDisplayAutomationImpl

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Defines the methods and properties required to perform instrumentation for the UIComponent class.

Related API Elements

mx.core.UIComponent

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | automationEnabled : Boolean [read-only] | UIComponentAutomationImpl
|  | automationName : String Name that can be used as an identifier for this object. | UIComponentAutomationImpl
|  | automationOwner : DisplayObjectContainer [read-only] | UIComponentAutomationImpl
|  | automationParent : DisplayObjectContainer [read-only] | UIComponentAutomationImpl
|  | automationValue : Array [read-only] This value generally corresponds to the rendered appearance of the object and should be usable for correlating the identifier with the object as it appears visually within the application. | UIComponentAutomationImpl
|  | automationVisible : Boolean [read-only] | UIComponentAutomationImpl
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | uiComponent : DisplayObject Returns the component instance associated with this delegate instance. | UIComponentAutomationImpl

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | UIComponentAutomationImpl(obj:UIComponent) Constructor. | UIComponentAutomationImpl
|  | 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
|  | dispatchEvent(event:Event):Boolean Dispatches an event into the event flow. | EventDispatcher
|  | 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
|  | init(root:DisplayObject):void [static] Registers the delegate class for a component class with automation manager. | UIComponentAutomationImpl
|  | 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
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | 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
|  | 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
|  | 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

Protected Methods

| Method | Defined By
--- | --- | ---
|  | addLayoutCompleteSynchronization():void Sets up an automation synchronization with the Layout Manager's UPDATE_COMPLETE event. | UIComponentAutomationImpl
|  | addMouseEvent(obj:DisplayObject, event:String, handler:Function, useCapture:Boolean = false, priority:int = 0, useWeekRef:Boolean = false):void | UIComponentAutomationImpl
|  | componentInitialized():void Method which gets called after the component has been initialized. | UIComponentAutomationImpl
|  | removeMouseEvent(obj:DisplayObject, event:String, handler:Function, useCapture:Boolean = false):void | UIComponentAutomationImpl

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

Property Detail

### automationEnabled

property

`automationEnabled:Boolean` [read-only]

Implementation
`public function get automationEnabled():Boolean`

### automationName

property

`automationName:String`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Name that can be used as an identifier for this object.

Implementation
`public function get automationName():String`
`public function set automationName(value:String):void`

### automationOwner

property

`automationOwner:DisplayObjectContainer` [read-only]

Implementation
`public function get automationOwner():DisplayObjectContainer`

### automationParent

property

`automationParent:DisplayObjectContainer` [read-only]

Implementation
`public function get automationParent():DisplayObjectContainer`

### automationValue

property

`automationValue:Array` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

This value generally corresponds to the rendered appearance of the object and should be usable for correlating the identifier with the object as it appears visually within the application.

Implementation
`public function get automationValue():Array`

### automationVisible

property

`automationVisible:Boolean` [read-only]

Implementation
`public function get automationVisible():Boolean`

### uiComponent

property

`uiComponent:DisplayObject`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Returns the component instance associated with this delegate instance.

Implementation
`public function get uiComponent():DisplayObject`
`public function set uiComponent(value:DisplayObject):void`
Constructor Detail

### UIComponentAutomationImpl

()
Constructor

`public function UIComponentAutomationImpl(obj:UIComponent)`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Constructor.

Parameters

| `obj:UIComponent` — UIComponent object to be automated.

Method Detail

### addLayoutCompleteSynchronization

()
method

`protected function addLayoutCompleteSynchronization():void`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Sets up an automation synchronization with the Layout Manager's UPDATE_COMPLETE event. When certain actions are being replayed automation needs to wait before it can replay the next event. This wait is required to allow the framework to complete actions requested by the component. Normally a layout manager update complte event signals end of all updates. This method adds syncrhonization which gets signaled as complete when update_complete event is received.

### addMouseEvent

()
method

`protected function addMouseEvent(obj:DisplayObject, event:String, handler:Function, useCapture:Boolean = false, priority:int = 0, useWeekRef:Boolean = false):void`

Parameters

| `obj:DisplayObject`
| `event:String`
| `handler:Function`
| `useCapture:Boolean` (default = `false`)``
| `priority:int` (default = `0`)``
| `useWeekRef:Boolean` (default = `false`)``

### componentInitialized

()
method

`protected function componentInitialized():void`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Method which gets called after the component has been initialized. This can be used to access any sub-components and act on them.

### init

()
method

`public static function init(root:DisplayObject):void`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Registers the delegate class for a component class with automation manager.

Parameters

| `root:DisplayObject` — DisplayObject object representing the application root.

### removeMouseEvent

()
method

`protected function removeMouseEvent(obj:DisplayObject, event:String, handler:Function, useCapture:Boolean = false):void`

Parameters

| `obj:DisplayObject`
| `event:String`
| `handler:Function`
| `useCapture:Boolean` (default = `false`)``

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