Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
IAutomationObject

Package | mx.automation
Interface | public interface IAutomationObject
Implementors | FlexNativeMenu, UIComponent, UIFTETextField, UITextField

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The IAutomationObject interface defines the interface for a delegate object that implements automation for a component.

Public Properties

| Property | Defined By
--- | --- | ---
|  | automationDelegate : Object The delegate object that is handling the automation-related functionality. | IAutomationObject
|  | automationEnabled : Boolean [read-only] True if this component is enabled for automation, false otherwise. | IAutomationObject
|  | automationName : String Name that can be used as an identifier for this object. | IAutomationObject
|  | automationOwner : DisplayObjectContainer [read-only] The owner of this component for automation purposes. | IAutomationObject
|  | automationParent : DisplayObjectContainer [read-only] The parent of this component for automation purposes. | IAutomationObject
|  | automationTabularData : Object [read-only] An implementation of the IAutomationTabularData interface, which can be used to retrieve the data. | IAutomationObject
|  | 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. | IAutomationObject
|  | automationVisible : Boolean [read-only] True if this component is visible for automation, false otherwise. | IAutomationObject
|  | numAutomationChildren : int [read-only] The number of automation children this container has. | IAutomationObject
|  | showInAutomationHierarchy : Boolean A flag that determines if an automation object shows in the automation hierarchy. | IAutomationObject

Public Methods

| Method | Defined By
--- | --- | ---
|  | createAutomationIDPart(child:IAutomationObject):Object Returns a set of properties that identify the child within this container. | IAutomationObject
|  | createAutomationIDPartWithRequiredProperties(child:IAutomationObject, properties:Array):Object Returns a set of properties as automation IDs that identify the child within this container. | IAutomationObject
|  | getAutomationChildAt(index:int):IAutomationObject Provides the automation object at the specified index. | IAutomationObject
|  | getAutomationChildren():Array Provides the automation object list . | IAutomationObject
|  | replayAutomatableEvent(event:Event):Boolean Replays the specified event. | IAutomationObject
|  | resolveAutomationIDPart(criteria:Object):Array Resolves a child by using the id provided. | IAutomationObject

Property Detail

automationDelegate | property

`automationDelegate:Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The delegate object that is handling the automation-related functionality. Automation sets this when it creates the delegate object.

Implementation
`public function get automationDelegate():Object`
`public function set automationDelegate(value:Object):void`

automationEnabled | property |

`automationEnabled:Boolean` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 9, AIR 1.1

True if this component is enabled for automation, false otherwise.

Implementation
`public function get automationEnabled():Boolean`

See also

mx.core.IUIComponent.enabled

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]

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 9, AIR 1.1

The owner of this component for automation purposes.

Implementation
`public function get automationOwner():DisplayObjectContainer`

See also

mx.core.IVisualElement.owner

automationParent | property |

`automationParent:DisplayObjectContainer` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 9, AIR 1.1

The parent of this component for automation purposes.

Implementation
`public function get automationParent():DisplayObjectContainer`

See also

mx.core.IVisualElement.parent

automationTabularData | property |

`automationTabularData:Object` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

An implementation of the `IAutomationTabularData` interface, which can be used to retrieve the data.

Implementation
`public function get automationTabularData():Object`

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]

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 9, AIR 1.1

True if this component is visible for automation, false otherwise.

Implementation
`public function get automationVisible():Boolean`

See also

flash.display.DisplayObject.visible

numAutomationChildren | property |

`numAutomationChildren:int` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The number of automation children this container has. This sum should not include any composite children, though it does include those children not significant within the automation hierarchy.

Implementation
`public function get numAutomationChildren():int`

showInAutomationHierarchy | property |

`showInAutomationHierarchy:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

A flag that determines if an automation object shows in the automation hierarchy. Children of containers that are not visible in the hierarchy appear as children of the next highest visible parent. Typically containers used for layout, such as boxes and Canvas, do not appear in the hierarchy.

Some controls force their children to appear in the hierarchy when appropriate. For example a List will always force item renderers, including boxes, to appear in the hierarchy. Implementers must support setting this property to `true`.

Implementation
`public function get showInAutomationHierarchy():Boolean`
`public function set showInAutomationHierarchy(value:Boolean):void`
Method Detail

createAutomationIDPart | () | method

`public function createAutomationIDPart(child:IAutomationObject):Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Returns a set of properties that identify the child within this container. These values should not change during the lifespan of the application.

Parameters

| `child:IAutomationObject` — Child for which to provide the id.

Returns

| `Object` — Sets of properties describing the child which can later be used to resolve the component.

createAutomationIDPartWithRequiredProperties | () | method |

`public function createAutomationIDPartWithRequiredProperties(child:IAutomationObject, properties:Array):Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Returns a set of properties as automation IDs that identify the child within this container. These values should not change during the lifespan of the application

Parameters

| `child:IAutomationObject` — Child for which to provide the id.
| `properties:Array` — which needs to be considered for forming the Id.

Returns

| `Object` — Sets of properties describing the child which can later be used to resolve the component.

getAutomationChildAt | () | method |

`public function getAutomationChildAt(index:int):IAutomationObject`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Provides the automation object at the specified index. This list should not include any children that are composites.

Parameters

| `index:int` — The index of the child to return

Returns

| `IAutomationObject` — The child at the specified index.

getAutomationChildren | () | method |

`public function getAutomationChildren():Array`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Provides the automation object list . This list does not include any children that are composites.

Returns

| `Array` — the automation children.

replayAutomatableEvent | () | method |

`public function replayAutomatableEvent(event:Event):Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Replays the specified event. A component author should probably call super.replayAutomatableEvent in case default replay behavior has been defined in a superclass.

Parameters

| `event:Event` — The event to replay.

Returns

| `Boolean` — `true` if a replay was successful.

resolveAutomationIDPart | () | method |

`public function resolveAutomationIDPart(criteria:Object):Array`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Resolves a child by using the id provided. The id is a set of properties as provided by the `createAutomationIDPart()` method.

Parameters

| `criteria:Object` — Set of properties describing the child. The criteria can contain regular expression values resulting in multiple children being matched.

Returns

| `Array` — Array of children that matched the criteria or `null` if no children could not be resolved.

Sun Mar 5 2017, 03:42 PM +11:00