| Package | mx.automation |
| Interface | public interface IAutomationObjectHelper |
| Property | Defined By | ||
|---|---|---|---|
| recording : Boolean
[read-only]
Indicates whether recording is taking place, true,
or not, false.
| IAutomationObjectHelper | ||
| replaying : Boolean
[read-only]
Indicates whether replay is taking place, true,
or not, false.
| IAutomationObjectHelper | ||
| Method | Defined By | ||
|---|---|---|---|
|
Adds a synchronization object to the automation manager.
| IAutomationObjectHelper | ||
|
Returns the parent which is compositing the given object.
| IAutomationObjectHelper | ||
|
helpCreateIDPart(parent:IAutomationObject, child:IAutomationObject, automationNameCallback:Function = null, automationIndexCallback:Function = null):AutomationIDPart
Creates an id for a given child within a parent.
| IAutomationObjectHelper | ||
|
Returns an Array of children within a parent which match the id.
| IAutomationObjectHelper | ||
|
Determines whether a object is a composite or not.
| IAutomationObjectHelper | ||
|
Dispatches a MouseEvent.MOUSE_DOWN, MouseEvent.MOUSE_UP,
and MouseEvent.CLICK from the specified IInteractionReplayer with the
specified modifiers.
| IAutomationObjectHelper | ||
|
Replays a click event somewhere off the edge of the stage.
| IAutomationObjectHelper | ||
|
Dispatches a KeyboardEvent.KEY_DOWN and
KeyboardEvent.KEY_UP event
for the specified KeyboardEvent object.
| IAutomationObjectHelper | ||
|
replayKeyDownKeyUp(to:IEventDispatcher, keyCode:uint, ctrlKey:Boolean = false, shiftKey:Boolean = false, altKey:Boolean = false):Boolean
Dispatches a KeyboardEvent.KEY_DOWN and
KeyboardEvent.KEY_UP event
from the specified IInteractionReplayer, for the specified key, with the
specified modifiers.
| IAutomationObjectHelper | ||
|
Dispatches a MouseEvent while simulating mouse capture.
| IAutomationObjectHelper | ||
| recording | property |
recording:Boolean [read-only]
Indicates whether recording is taking place, true,
or not, false.
public function get recording():Boolean
| replaying | property |
replaying:Boolean [read-only]
Indicates whether replay is taking place, true,
or not, false.
public function get replaying():Boolean
| addSynchronization | () | method |
public function addSynchronization(isComplete:Function, target:Object = null):void
Adds a synchronization object to the automation manager.
The automation manager waits until the isComplete method
returns true
before proceeding with the next replay event.
Parameters
isComplete:Function — Function that indicates whether the synchronized
operation is completed.
|
|
target:Object (default = null) — If null, all replay is stalled until
the isComplete method returns true,
otherwise the automation manager will only wait
if the next operation is on the target.
|
| getAutomationComposite | () | method |
public function getAutomationComposite(obj:IAutomationObject):IAutomationObject
Returns the parent which is compositing the given object.
Parameters
obj:IAutomationObject — Object whose compositing parent is to be determined.
|
IAutomationObject — The parent IAutomationObject.
|
| helpCreateIDPart | () | method |
public function helpCreateIDPart(parent:IAutomationObject, child:IAutomationObject, automationNameCallback:Function = null, automationIndexCallback:Function = null):AutomationIDPart
Creates an id for a given child within a parent.
Parameters
parent:IAutomationObject — Parent of object for which to create and id.
|
|
child:IAutomationObject — Object for which to create an id.
|
|
automationNameCallback:Function (default = null) — A user-supplied function used
to determine the child's automationName.
|
|
automationIndexCallback:Function (default = null) — A user-supplied function used
to determine the child's automationIndex.
|
AutomationIDPart — An AutomationIDPart object representing the child within the parent.
|
| helpResolveIDPart | () | method |
public function helpResolveIDPart(parent:IAutomationObject, part:Object):Array
Returns an Array of children within a parent which match the id.
Parameters
parent:IAutomationObject — Parent object under which the id needs to be resolved.
|
|
part:Object — AutomationIDPart object representing the child.
|
Array — Array of children which match the id of part.
|
| isAutomationComposite | () | method |
public function isAutomationComposite(obj:IAutomationObject):Boolean
Determines whether a object is a composite or not. If a object is not reachable through the automation APIs from the top application then it is considered to be a composite.
Parameters
obj:IAutomationObject — Object whose compositeness is to be determined.
|
Boolean —
true if the object is a composite.
|
| replayClick | () | method |
public function replayClick(to:IEventDispatcher, sourceEvent:MouseEvent = null):Boolean
Dispatches a MouseEvent.MOUSE_DOWN, MouseEvent.MOUSE_UP,
and MouseEvent.CLICK from the specified IInteractionReplayer with the
specified modifiers.
Parameters
to:IEventDispatcher — Event dispatcher.
|
|
sourceEvent:MouseEvent (default = null) — Mouse event.
|
Boolean —
true if the events were dispatched.
|
| replayClickOffStage | () | method |
public function replayClickOffStage():Boolean
Replays a click event somewhere off the edge of the stage.
use this method to simulate the mouseDownOutside event.
Boolean —
true if the event was dispatched.
|
| replayKeyboardEvent | () | method |
public function replayKeyboardEvent(to:IEventDispatcher, event:KeyboardEvent):Boolean
Dispatches a KeyboardEvent.KEY_DOWN and
KeyboardEvent.KEY_UP event
for the specified KeyboardEvent object.
Parameters
to:IEventDispatcher — Event dispatcher.
|
|
event:KeyboardEvent — Keyboard event.
|
Boolean —
true if the events were dispatched.
|
| replayKeyDownKeyUp | () | method |
public function replayKeyDownKeyUp(to:IEventDispatcher, keyCode:uint, ctrlKey:Boolean = false, shiftKey:Boolean = false, altKey:Boolean = false):Boolean
Dispatches a KeyboardEvent.KEY_DOWN and
KeyboardEvent.KEY_UP event
from the specified IInteractionReplayer, for the specified key, with the
specified modifiers.
Parameters
to:IEventDispatcher — Key code for key pressed.
|
|
keyCode:uint — Boolean indicating whether Ctrl key pressed.
|
|
ctrlKey:Boolean (default = false) — Boolean indicating whether Shift key pressed.
|
|
shiftKey:Boolean (default = false) — Boolean indicating whether Alt key pressed.
|
|
altKey:Boolean (default = false) |
Boolean —
true if the events were dispatched.
|
| replayMouseEvent | () | method |
public function replayMouseEvent(target:IEventDispatcher, event:MouseEvent):Boolean
Dispatches a MouseEvent while simulating mouse capture.
Parameters
target:IEventDispatcher — Event dispatcher.
|
|
event:MouseEvent — Mouse event.
|
Boolean —
true if the event was dispatched.
|