| Package | mx.automation |
| Interface | public interface IAutomationObjectHelper |
| Implementors | AutomationManager |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Learn more
Public Properties
| 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 | ||
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Adds a synchronization object to the automation manager. | IAutomationObjectHelper | ||
Returns the parent of the composite 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 | ||
helpCreateIDPartWithRequiredProperties(parent:IAutomationObject, child:IAutomationObject, properties:Array, 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 an 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 outside of the main drawing area. | 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 | ||
Property Detail
recording | property |
replaying | property |
Method Detail
addSynchronization | () | method |
public function addSynchronization(isComplete:Function, target:Object = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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)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| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns the parent of the composite object.
Parameters
obj:IAutomationObject — Composite object.
|
IAutomationObject — The parent IAutomationObject of the composite object.
|
helpCreateIDPart | () | method |
public function helpCreateIDPart(parent:IAutomationObject, child:IAutomationObject, automationNameCallback:Function = null, automationIndexCallback:Function = null):AutomationIDPart| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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)automationName.
| |
automationIndexCallback:Function (default = null)automationIndex.
|
AutomationIDPart — An AutomationIDPart object representing the child within the parent.
|
helpCreateIDPartWithRequiredProperties | () | method |
public function helpCreateIDPartWithRequiredProperties(parent:IAutomationObject, child:IAutomationObject, properties:Array, automationNameCallback:Function = null, automationIndexCallback:Function = null):AutomationIDPart| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
| |
properties:Array — which needs to be considered for creating the id.
| |
automationNameCallback:Function (default = null)automationName.
| |
automationIndexCallback:Function (default = null)automationIndex.
|
AutomationIDPart — An AutomationIDPart object representing the child within the parent.
|
helpResolveIDPart | () | method |
public function helpResolveIDPart(parent:IAutomationObject, part:Object):Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Determines whether an object is a composite or not. If an object is not reachable through the automation APIs from the top application then it is considered to be a composite.
Parameters
obj:IAutomationObject — The object.
|
Boolean — true if the object is a composite.
|
replayClick | () | method |
public function replayClick(to:IEventDispatcher, sourceEvent:MouseEvent = null):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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) |
Boolean — true if the events were dispatched.
|
replayClickOffStage | () | method |
public function replayClickOffStage():Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Replays a click event outside of the main drawing area.
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| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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) | |
shiftKey:Boolean (default = false) | |
altKey:Boolean (default = false) |
Boolean — true if the events were dispatched.
|
replayMouseEvent | () | method |
public function replayMouseEvent(target:IEventDispatcher, event:MouseEvent):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatches a MouseEvent while simulating mouse capture.
Parameters
target:IEventDispatcher — Event dispatcher.
| |
event:MouseEvent — Mouse event.
|
Boolean — true if the event was dispatched.
|
Mon Nov 28 2011, 06:48 AM -08:00