| Package | mx.automation |
| Interface | public interface IAutomationObject |
| Implementors | UIComponent, UITextField |
| Property | Defined by | ||
|---|---|---|---|
| automationDelegate : Object
The delegate object that is handling the automation-related functionality.
| IAutomationObject | ||
| automationName : String
Name that can be used as an identifier for this object.
| 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 | ||
| 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 | ||
| Method | Defined by | ||
|---|---|---|---|
|
createAutomationIDPart(child:IAutomationObject):Object
Returns a set of properties that identify the child within
this container.
| IAutomationObject | ||
|
getAutomationChildAt(index:int):IAutomationObject
Provides the automation object at the specified index.
| IAutomationObject | ||
|
replayAutomatableEvent(event:Event):Boolean
Replays the specified event.
| IAutomationObject | ||
|
resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided.
| IAutomationObject | ||
| automationDelegate | property |
automationDelegate:Object [read-write]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
| automationName | property |
automationName:String [read-write]Name that can be used as an identifier for this object.
Implementation public function get automationName():String
public function set automationName(value:String):void
| automationTabularData | property |
automationTabularData:Object [read-only]
An implementation of the IAutomationTabularData interface, which
can be used to retrieve the data.
public function get automationTabularData():Object
| automationValue | property |
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.
Implementation public function get automationValue():Array
| numAutomationChildren | property |
numAutomationChildren:int [read-only]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 [read-write]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.
public function get showInAutomationHierarchy():Boolean
public function set showInAutomationHierarchy(value:Boolean):void
| createAutomationIDPart | () | method |
public function createAutomationIDPart(child:IAutomationObject):ObjectReturns a set of properties that identify the child within this container. These values should not change during the lifespan of the application.
Parameterschild:IAutomationObject — Child for which to provide the id.
|
Object — Sets of properties describing the child which can
later be used to resolve the component.
|
| getAutomationChildAt | () | method |
public function getAutomationChildAt(index:int):IAutomationObjectProvides the automation object at the specified index. This list should not include any children that are composites.
Parametersindex:int — The index of the child to return
|
IAutomationObject —
The child at the specified index.
|
| replayAutomatableEvent | () | method |
public function replayAutomatableEvent(event:Event):BooleanReplays the specified event. A component author should probably call super.replayAutomatableEvent in case default replay behavior has been defined in a superclass.
Parametersevent:Event — The event to replay.
|
Boolean — true if a replay was successful.
|
| resolveAutomationIDPart | () | method |
public function resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided. The id is a set
of properties as provided by the createAutomationIDPart() method.
criteria:Object — Set of properties describing the child.
The criteria can contain regular expression values
resulting in multiple children being matched.
|
Array — Array of children that matched the criteria
or null if no children could not be resolved.
|