ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
mx.automation 

IAutomationObjectHelper  - AS3 Flex
Packagemx.automation
Interfacepublic interface IAutomationObjectHelper
Implementors AutomationManager

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The IAutomationObjectHelper interface defines helper methods for IAutomationObjects.

Learn more

Understanding the automation framework

Public Properties
 PropertyDefined 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
 MethodDefined By
  
addSynchronization(isComplete:Function, target:Object = null):void
Adds a synchronization object to the automation manager.
IAutomationObjectHelper
  
getAutomationComposite(obj:IAutomationObject):IAutomationObject
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
  
helpResolveIDPart(parent:IAutomationObject, part:Object):Array
Returns an Array of children within a parent which match the id.
IAutomationObjectHelper
  
isAutomationComposite(obj:IAutomationObject):Boolean
Determines whether an object is a composite or not.
IAutomationObjectHelper
  
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.
IAutomationObjectHelper
  
replayClickOffStage():Boolean
Replays a click event outside of the main drawing area.
IAutomationObjectHelper
  
replayKeyboardEvent(to:IEventDispatcher, event:KeyboardEvent):Boolean
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
  
replayMouseEvent(target:IEventDispatcher, event:MouseEvent):Boolean
Dispatches a MouseEvent while simulating mouse capture.
IAutomationObjectHelper
Property Detail

recording

property
recording:Boolean  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Indicates whether recording is taking place, true, or not, false.



Implementation
    public function get recording():Boolean

replaying

property 
replaying:Boolean  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Indicates whether replay is taking place, true, or not, false.



Implementation
    public function get replaying():Boolean
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) — 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

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.

Returns
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) — 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.

Returns
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) — 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.

Returns
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.

Returns
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.

Returns
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) — Mouse event.

Returns
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.

Returns
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.

Returns
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) — Boolean indicating whether Shift key pressed.
 
shiftKey:Boolean (default = false) — Boolean indicating whether Alt key pressed.
 
altKey:Boolean (default = false)

Returns
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.

Returns
Boolean — true if the event was dispatched.



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy