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

Language Reference only
Filters: AIR 32.0 and earlier, Flash Player 32.0 and earlier, Flash Lite 4
Flex 4.6 and earlier, Flash Pro CS6 and earlier
Hide Filters
mx.automation 

IAutomationManager  - AS3 Flex

Packagesx

Top Level
adobe.utils
air.desktop
air.net
air.update
air.update.events
coldfusion.air
coldfusion.air.errors
coldfusion.air.events
coldfusion.service
coldfusion.service.events
coldfusion.service.mxml
com.adobe.acm.solutions.authoring.domain.extensions
com.adobe.acm.solutions.ccr.domain.extensions
com.adobe.consulting.pst.vo
com.adobe.dct.component
com.adobe.dct.component.datadictionary
com.adobe.dct.component.datadictionaryElement
com.adobe.dct.component.dataElementsPanel
com.adobe.dct.component.toolbars
com.adobe.dct.event
com.adobe.dct.exp
com.adobe.dct.model
com.adobe.dct.service
com.adobe.dct.service.provider
com.adobe.dct.transfer
com.adobe.dct.util
com.adobe.dct.view
com.adobe.ep.taskmanagement.domain
com.adobe.ep.taskmanagement.event
com.adobe.ep.taskmanagement.filter
com.adobe.ep.taskmanagement.services
com.adobe.ep.taskmanagement.util
com.adobe.ep.ux.attachmentlist.component
com.adobe.ep.ux.attachmentlist.domain
com.adobe.ep.ux.attachmentlist.domain.events
com.adobe.ep.ux.attachmentlist.domain.renderers
com.adobe.ep.ux.attachmentlist.skin
com.adobe.ep.ux.attachmentlist.skin.renderers
com.adobe.ep.ux.content.event
com.adobe.ep.ux.content.factory
com.adobe.ep.ux.content.handlers
com.adobe.ep.ux.content.managers
com.adobe.ep.ux.content.model.asset
com.adobe.ep.ux.content.model.preview
com.adobe.ep.ux.content.model.relation
com.adobe.ep.ux.content.model.search
com.adobe.ep.ux.content.model.toolbar
com.adobe.ep.ux.content.search
com.adobe.ep.ux.content.services
com.adobe.ep.ux.content.services.load
com.adobe.ep.ux.content.services.permissions
com.adobe.ep.ux.content.services.preview
com.adobe.ep.ux.content.services.providers
com.adobe.ep.ux.content.services.query
com.adobe.ep.ux.content.services.relationships
com.adobe.ep.ux.content.services.search.lccontent
com.adobe.ep.ux.content.services.version
com.adobe.ep.ux.content.view
com.adobe.ep.ux.content.view.components.activate
com.adobe.ep.ux.content.view.components.grid
com.adobe.ep.ux.content.view.components.grid.hover
com.adobe.ep.ux.content.view.components.grid.hover.component
com.adobe.ep.ux.content.view.components.grid.renderers
com.adobe.ep.ux.content.view.components.relationships
com.adobe.ep.ux.content.view.components.review
com.adobe.ep.ux.content.view.components.search.renderers
com.adobe.ep.ux.content.view.components.searchpod
com.adobe.ep.ux.content.view.components.toolbar
com.adobe.ep.ux.content.view.components.toolbar.controlRenderers
com.adobe.ep.ux.content.view.components.version
com.adobe.ep.ux.documentsubmit.component
com.adobe.ep.ux.documentsubmit.domain
com.adobe.ep.ux.documentsubmit.skin
com.adobe.ep.ux.taskaction.component
com.adobe.ep.ux.taskaction.domain
com.adobe.ep.ux.taskaction.domain.events
com.adobe.ep.ux.taskaction.skin
com.adobe.ep.ux.taskdetails.component
com.adobe.ep.ux.taskdetails.domain
com.adobe.ep.ux.taskdetails.skin
com.adobe.ep.ux.tasklist.component
com.adobe.ep.ux.tasklist.domain
com.adobe.ep.ux.tasklist.skin
com.adobe.ep.ux.webdocumentviewer.domain
com.adobe.exm.expression
com.adobe.exm.expression.error
com.adobe.exm.expression.event
com.adobe.exm.expression.impl
com.adobe.fiber.runtime.lib
com.adobe.fiber.services
com.adobe.fiber.services.wrapper
com.adobe.fiber.styles
com.adobe.fiber.util
com.adobe.fiber.valueobjects
com.adobe.gravity.binding
com.adobe.gravity.context
com.adobe.gravity.flex.bundleloader
com.adobe.gravity.flex.progress
com.adobe.gravity.flex.serviceloader
com.adobe.gravity.framework
com.adobe.gravity.init
com.adobe.gravity.service.bundleloader
com.adobe.gravity.service.logging
com.adobe.gravity.service.manifest
com.adobe.gravity.service.progress
com.adobe.gravity.tracker
com.adobe.gravity.ui
com.adobe.gravity.utility
com.adobe.gravity.utility.async
com.adobe.gravity.utility.error
com.adobe.gravity.utility.events
com.adobe.gravity.utility.factory
com.adobe.gravity.utility.flex.async
com.adobe.gravity.utility.logging
com.adobe.gravity.utility.message
com.adobe.gravity.utility.sequence
com.adobe.gravity.utility.url
com.adobe.guides.control
com.adobe.guides.domain
com.adobe.guides.i18n
com.adobe.guides.spark.components.skins
com.adobe.guides.spark.components.skins.mx
com.adobe.guides.spark.headers.components
com.adobe.guides.spark.headers.skins
com.adobe.guides.spark.layouts.components
com.adobe.guides.spark.layouts.skins
com.adobe.guides.spark.navigators.components
com.adobe.guides.spark.navigators.renderers
com.adobe.guides.spark.navigators.skins
com.adobe.guides.spark.util
com.adobe.guides.spark.wrappers.components
com.adobe.guides.spark.wrappers.skins
com.adobe.guides.submit
com.adobe.icc.dc.domain
com.adobe.icc.dc.domain.factory
com.adobe.icc.editors.events
com.adobe.icc.editors.handlers
com.adobe.icc.editors.managers
com.adobe.icc.editors.model
com.adobe.icc.editors.model.config
com.adobe.icc.editors.model.el
com.adobe.icc.editors.model.el.operands
com.adobe.icc.editors.model.el.operators
com.adobe.icc.enum
com.adobe.icc.external.dc
com.adobe.icc.obj
com.adobe.icc.services
com.adobe.icc.services.category
com.adobe.icc.services.config
com.adobe.icc.services.download
com.adobe.icc.services.export
com.adobe.icc.services.external
com.adobe.icc.services.formbridge
com.adobe.icc.services.fragmentlayout
com.adobe.icc.services.layout
com.adobe.icc.services.letter
com.adobe.icc.services.locator
com.adobe.icc.services.module
com.adobe.icc.services.render
com.adobe.icc.services.submit
com.adobe.icc.services.user
com.adobe.icc.token
com.adobe.icc.vo
com.adobe.icc.vo.render
com.adobe.icomm.assetplacement.controller
com.adobe.icomm.assetplacement.controller.utils
com.adobe.icomm.assetplacement.data
com.adobe.icomm.assetplacement.model
com.adobe.livecycle.assetmanager.client
com.adobe.livecycle.assetmanager.client.event
com.adobe.livecycle.assetmanager.client.handler
com.adobe.livecycle.assetmanager.client.managers
com.adobe.livecycle.assetmanager.client.model
com.adobe.livecycle.assetmanager.client.model.cms
com.adobe.livecycle.assetmanager.client.service
com.adobe.livecycle.assetmanager.client.service.search
com.adobe.livecycle.assetmanager.client.service.search.cms
com.adobe.livecycle.assetmanager.client.utils
com.adobe.livecycle.content
com.adobe.livecycle.rca.model
com.adobe.livecycle.rca.model.constant
com.adobe.livecycle.rca.model.document
com.adobe.livecycle.rca.model.participant
com.adobe.livecycle.rca.model.reminder
com.adobe.livecycle.rca.model.stage
com.adobe.livecycle.rca.service
com.adobe.livecycle.rca.service.core
com.adobe.livecycle.rca.service.core.delegate
com.adobe.livecycle.rca.service.process
com.adobe.livecycle.rca.service.process.delegate
com.adobe.livecycle.rca.token
com.adobe.livecycle.ria.security.api
com.adobe.livecycle.ria.security.service
com.adobe.mosaic.layouts
com.adobe.mosaic.layouts.dragAndDrop
com.adobe.mosaic.layouts.interfaces
com.adobe.mosaic.mxml
com.adobe.mosaic.om.constants
com.adobe.mosaic.om.events
com.adobe.mosaic.om.impl
com.adobe.mosaic.om.interfaces
com.adobe.mosaic.skinning
com.adobe.mosaic.sparklib.editors
com.adobe.mosaic.sparklib.optionMenu
com.adobe.mosaic.sparklib.scrollableMenu
com.adobe.mosaic.sparklib.scrollableMenu.skins
com.adobe.mosaic.sparklib.tabLayout
com.adobe.mosaic.sparklib.tabLayout.events
com.adobe.mosaic.sparklib.tabLayout.layouts
com.adobe.mosaic.sparklib.tabLayout.skins
com.adobe.mosaic.sparklib.text
com.adobe.mosaic.sparklib.util
com.adobe.solutions.acm.authoring.presentation
com.adobe.solutions.acm.authoring.presentation.actionbar
com.adobe.solutions.acm.authoring.presentation.common
com.adobe.solutions.acm.authoring.presentation.events
com.adobe.solutions.acm.authoring.presentation.fragment
com.adobe.solutions.acm.authoring.presentation.letter
com.adobe.solutions.acm.authoring.presentation.letter.data
com.adobe.solutions.acm.authoring.presentation.preview
com.adobe.solutions.acm.authoring.presentation.rte
com.adobe.solutions.acm.ccr.presentation
com.adobe.solutions.acm.ccr.presentation.contentcapture
com.adobe.solutions.acm.ccr.presentation.contentcapture.events
com.adobe.solutions.acm.ccr.presentation.contentcapture.preview
com.adobe.solutions.acm.ccr.presentation.datacapture
com.adobe.solutions.acm.ccr.presentation.datacapture.renderers
com.adobe.solutions.acm.ccr.presentation.pdf
com.adobe.solutions.exm
com.adobe.solutions.exm.authoring
com.adobe.solutions.exm.authoring.components.controls
com.adobe.solutions.exm.authoring.components.toolbars
com.adobe.solutions.exm.authoring.domain
com.adobe.solutions.exm.authoring.domain.expression
com.adobe.solutions.exm.authoring.domain.impl
com.adobe.solutions.exm.authoring.domain.method
com.adobe.solutions.exm.authoring.domain.variable
com.adobe.solutions.exm.authoring.enum
com.adobe.solutions.exm.authoring.events
com.adobe.solutions.exm.authoring.model
com.adobe.solutions.exm.authoring.renderer
com.adobe.solutions.exm.authoring.view
com.adobe.solutions.exm.expression
com.adobe.solutions.exm.impl
com.adobe.solutions.exm.impl.method
com.adobe.solutions.exm.method
com.adobe.solutions.exm.mock
com.adobe.solutions.exm.mock.method
com.adobe.solutions.exm.runtime
com.adobe.solutions.exm.runtime.impl
com.adobe.solutions.exm.variable
com.adobe.solutions.prm.constant
com.adobe.solutions.prm.domain
com.adobe.solutions.prm.domain.factory
com.adobe.solutions.prm.domain.impl
com.adobe.solutions.prm.domain.manager
com.adobe.solutions.prm.presentation.asset
com.adobe.solutions.prm.presentation.constant
com.adobe.solutions.prm.presentation.document
com.adobe.solutions.prm.presentation.event
com.adobe.solutions.prm.presentation.file
com.adobe.solutions.prm.presentation.project
com.adobe.solutions.prm.presentation.team
com.adobe.solutions.prm.presentation.util
com.adobe.solutions.prm.service
com.adobe.solutions.prm.services.impl
com.adobe.solutions.prm.vo
com.adobe.solutions.rca.constant
com.adobe.solutions.rca.domain
com.adobe.solutions.rca.domain.common
com.adobe.solutions.rca.domain.factory
com.adobe.solutions.rca.domain.impl
com.adobe.solutions.rca.domain.impl.manager
com.adobe.solutions.rca.domain.manager
com.adobe.solutions.rca.presentation
com.adobe.solutions.rca.presentation.comment
com.adobe.solutions.rca.presentation.constant
com.adobe.solutions.rca.presentation.event
com.adobe.solutions.rca.presentation.gantt
com.adobe.solutions.rca.presentation.gantt.ruler
com.adobe.solutions.rca.presentation.template
com.adobe.solutions.rca.presentation.template.audit
com.adobe.solutions.rca.presentation.template.definition
com.adobe.solutions.rca.presentation.template.documents
com.adobe.solutions.rca.presentation.template.stages
com.adobe.solutions.rca.presentation.util
com.adobe.solutions.rca.service
com.adobe.solutions.rca.services.impl
com.adobe.solutions.rca.vo
com.adobe.solutions.rca.vo.um
com.adobe.viewsource
fl.accessibility
fl.containers
fl.controls
fl.controls.dataGridClasses
fl.controls.listClasses
fl.controls.progressBarClasses
fl.core
fl.data
fl.display
fl.events
fl.ik
fl.lang
fl.livepreview
fl.managers
fl.motion
fl.motion.easing
fl.rsl
fl.text
fl.transitions
fl.transitions.easing
fl.video
flash.accessibility
flash.concurrent
flash.crypto
flash.data
flash.desktop
flash.display
flash.display3D
flash.display3D.textures
flash.errors
flash.events
flash.external
flash.filesystem
flash.filters
flash.geom
flash.globalization
flash.html
flash.media
flash.net
flash.net.dns
flash.net.drm
flash.notifications
flash.permissions
flash.printing
flash.profiler
flash.sampler
flash.security
flash.sensors
flash.system
flash.text
flash.text.engine
flash.text.ime
flash.ui
flash.utils
flash.xml
flashx.textLayout
flashx.textLayout.compose
flashx.textLayout.container
flashx.textLayout.conversion
flashx.textLayout.edit
flashx.textLayout.elements
flashx.textLayout.events
flashx.textLayout.factory
flashx.textLayout.formats
flashx.textLayout.operations
flashx.textLayout.utils
flashx.undo
ga.controls
ga.layouts
ga.model
ga.uiComponents
ga.util
ga.views
ga.wrappers
lc.foundation
lc.foundation.domain
lc.foundation.events
lc.foundation.ui
lc.foundation.util
lc.preloader
lc.procmgmt
lc.procmgmt.commands
lc.procmgmt.domain
lc.procmgmt.events
lc.procmgmt.formbridge
lc.procmgmt.impl
lc.procmgmt.ui.attachments
lc.procmgmt.ui.controls
lc.procmgmt.ui.controls.card
lc.procmgmt.ui.controls.renderer
lc.procmgmt.ui.help
lc.procmgmt.ui.layout
lc.procmgmt.ui.presentationmodel
lc.procmgmt.ui.process
lc.procmgmt.ui.search
lc.procmgmt.ui.startpoint
lc.procmgmt.ui.task
lc.procmgmt.ui.task.form
lc.procmgmt.ui.task.form.commands
lc.procmgmt.ui.tracking
mx.accessibility
mx.automation
mx.automation.air
mx.automation.delegates
mx.automation.delegates.advancedDataGrid
mx.automation.delegates.charts
mx.automation.delegates.containers
mx.automation.delegates.controls
mx.automation.delegates.controls.dataGridClasses
mx.automation.delegates.controls.fileSystemClasses
mx.automation.delegates.core
mx.automation.delegates.flashflexkit
mx.automation.events
mx.binding
mx.binding.utils
mx.charts
mx.charts.chartClasses
mx.charts.effects
mx.charts.effects.effectClasses
mx.charts.events
mx.charts.renderers
mx.charts.series
mx.charts.series.items
mx.charts.series.renderData
mx.charts.styles
mx.collections
mx.collections.errors
mx.containers
mx.containers.accordionClasses
mx.containers.dividedBoxClasses
mx.containers.errors
mx.containers.utilityClasses
mx.controls
mx.controls.advancedDataGridClasses
mx.controls.dataGridClasses
mx.controls.listClasses
mx.controls.menuClasses
mx.controls.olapDataGridClasses
mx.controls.scrollClasses
mx.controls.sliderClasses
mx.controls.textClasses
mx.controls.treeClasses
mx.controls.videoClasses
mx.core
mx.core.windowClasses
mx.data
mx.data.crypto
mx.data.errors
mx.data.events
mx.data.messages
mx.data.mxml
mx.data.offline.errors
mx.data.utils
mx.effects
mx.effects.easing
mx.effects.effectClasses
mx.events
mx.filters
mx.flash
mx.formatters
mx.geom
mx.graphics
mx.graphics.codec
mx.graphics.shaderClasses
mx.logging
mx.logging.errors
mx.logging.targets
mx.managers
mx.messaging
mx.messaging.channels
mx.messaging.config
mx.messaging.errors
mx.messaging.events
mx.messaging.management
mx.messaging.messages
mx.modules
mx.netmon
mx.olap
mx.olap.aggregators
mx.preloaders
mx.printing
mx.resources
mx.rpc
mx.rpc.events
mx.rpc.http
mx.rpc.http.mxml
mx.rpc.livecycle
mx.rpc.mxml
mx.rpc.remoting
mx.rpc.remoting.mxml
mx.rpc.soap
mx.rpc.soap.mxml
mx.rpc.wsdl
mx.rpc.xml
mx.skins
mx.skins.halo
mx.skins.spark
mx.skins.wireframe
mx.skins.wireframe.windowChrome
mx.states
mx.styles
mx.utils
mx.validators
org.osmf.containers
org.osmf.display
org.osmf.elements
org.osmf.events
org.osmf.layout
org.osmf.logging
org.osmf.media
org.osmf.metadata
org.osmf.net
org.osmf.net.dvr
org.osmf.net.httpstreaming
org.osmf.net.metrics
org.osmf.net.qos
org.osmf.net.rtmpstreaming
org.osmf.net.rules
org.osmf.traits
org.osmf.utils
spark.accessibility
spark.automation.delegates
spark.automation.delegates.components
spark.automation.delegates.components.gridClasses
spark.automation.delegates.components.mediaClasses
spark.automation.delegates.components.supportClasses
spark.automation.delegates.skins.spark
spark.automation.events
spark.collections
spark.components
spark.components.calendarClasses
spark.components.gridClasses
spark.components.mediaClasses
spark.components.supportClasses
spark.components.windowClasses
spark.core
spark.effects
spark.effects.animation
spark.effects.easing
spark.effects.interpolation
spark.effects.supportClasses
spark.events
spark.filters
spark.formatters
spark.formatters.supportClasses
spark.globalization
spark.globalization.supportClasses
spark.layouts
spark.layouts.supportClasses
spark.managers
spark.modules
spark.preloaders
spark.primitives
spark.primitives.supportClasses
spark.skins
spark.skins.mobile
spark.skins.mobile.supportClasses
spark.skins.spark
spark.skins.spark.mediaClasses.fullScreen
spark.skins.spark.mediaClasses.normal
spark.skins.spark.windowChrome
spark.skins.wireframe
spark.skins.wireframe.mediaClasses
spark.skins.wireframe.mediaClasses.fullScreen
spark.transitions
spark.utils
spark.validators
spark.validators.supportClasses
xd.core.axm.enterprise.view.components
xd.core.axm.enterprise.view.skins
xd.core.axm.view.components
xd.core.axm.view.components.support

Language Elements

Global Constants
Global Functions
Operators
Statements, Keywords & Directives
Special Types

Appendixes

What's New
Compiler Errors
Compiler Warnings
Run-Time Errors
Migrating to ActionScript 3
Supported Character Sets
MXML Only Tags
Motion XML Elements
Timed Text Tags
List of deprecated elements
Accessibility Implementation Constants
How to Use ActionScript Examples
Legal notices
Packagemx.automation
Interfacepublic interface IAutomationManager extends IEventDispatcher

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

The IAutomationManager interface defines the interface expected from an AutomationManager object by the automation module.

Learn more



Public Properties
 PropertyDefined By
  automationEnvironment : Object
The automation environment for this automation manager.
IAutomationManager
  recording : Boolean
[read-only] Indicates whether recording is taking place.
IAutomationManager
  replaying : Boolean
[read-only] Indicates whether replay is taking place.
IAutomationManager
Public Methods
 MethodDefined By
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
IEventDispatcher
  
Sets the automation manager to record mode.
IAutomationManager
  
Returns an id for the given object that can be used with the resolveID() method.
IAutomationManager
  
Returns an id part for the given object that can be used in the resolveIDPart() method.
IAutomationManager
  
Decrement the cache counter.
IAutomationManager
 Inherited
Dispatches an event into the event flow.
IEventDispatcher
  
Takes the automation manager out of record mode.
IAutomationManager
  
Returns the text to display as the type of the object.
IAutomationManager
  
Returns the text to display as the description for the object.
IAutomationManager
  
getChildren(obj:IAutomationObject, ignoreShowInHierarchy:Boolean = false):Array
Returns all children of this object that are visible within the testing hierarchy.
IAutomationManager
  
getChildrenFromIDPart(obj:IAutomationObject, part:AutomationIDPart = null, ignoreShowInHierarchy:Boolean = false):Array
Returns all children of this object that are visible within the testing hierarchy and meet the criteria in the automation part.
IAutomationManager
  
Returns the automation object under the given coordinate.
IAutomationManager
  
getParent(obj:IAutomationObject, parentToStopAt:IAutomationObject = null, ignoreShowInHierarchy:Boolean = false):IAutomationObject
Returns the next parent that is visible within the automation hierarchy.
IAutomationManager
  
getProperties(obj:IAutomationObject, names:Array = null, forVerification:Boolean = true, forDescription:Boolean = true):Array
Returns the values for a set of properties.
IAutomationManager
  
The display rectangle enclosing the DisplayObject.
IAutomationManager
  
Returns the object implementing the IAutomationTabularData interface through which the tabular data can be obtained.
IAutomationManager
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
IEventDispatcher
  
Increments the cache counter.
IAutomationManager
  
Tests if the provided target needs to wait until a previous operation completes.
IAutomationManager
  
Returns true if an object and all of its parents are visible.
IAutomationManager
  
recordAutomatableEvent(recorder:IAutomationObject, event:Event, cacheable:Boolean = false):void
Records the event.
IAutomationManager
  
Records the custom event.
IAutomationManager
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
IEventDispatcher
  
Replays the specified event.
IAutomationManager
  
resolveID(rid:AutomationID, currentParent:IAutomationObject = null):Array
Resolves an id to automation objects.
IAutomationManager
  
Resolves an id part to an Array of automation objects.
IAutomationManager
  
Resolves an id part to an automation object within the parent.
IAutomationManager
  
Resolves an id to an automation object.
IAutomationManager
  
Indicates whether an automation object should be visible within the hierarchy.
IAutomationManager
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
IEventDispatcher
Property Detail

automationEnvironment

property
automationEnvironment:Object

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

The automation environment for this automation manager. The automation environment provides information about the objects and properties of testable components needed for communicating with agent tools.

The value of this property must implement the IAutomationEnvironment interface.



Implementation
    public function get automationEnvironment():Object
    public function set automationEnvironment(value:Object):void

Related API Elements

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.



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.



Implementation
    public function get replaying():Boolean
Method Detail

beginRecording

()method
public function beginRecording():void

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

Sets the automation manager to record mode.

createID

()method 
public function createID(obj:IAutomationObject, relativeToParent:IAutomationObject = null):AutomationID

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

Returns an id for the given object that can be used with the resolveID() method.

Parameters

obj:IAutomationObject — Automation object.
 
relativeToParent:IAutomationObject (default = null) — Parent of the automation object.

Returns
AutomationID — AutomationID object which represents the Automation object.

createIDPart

()method 
public function createIDPart(obj:IAutomationObject, parent:IAutomationObject = null):AutomationIDPart

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

Returns an id part for the given object that can be used in the resolveIDPart() method.

Parameters

obj:IAutomationObject — The automation object.
 
parent:IAutomationObject (default = null) — Parent of the automation object.

Returns
AutomationIDPart — AutomationIDPart object which represents the Automation object.

decrementCacheCounter

()method 
public function decrementCacheCounter(clearNow:Boolean = false):int

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

Decrement the cache counter. The cache is cleared when the count reaches zero.

Parameters

clearNow:Boolean (default = false) — If true, clear the cache regardless of the cache counter.

Returns
int — Current cache counter.

endRecording

()method 
public function endRecording():void

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

Takes the automation manager out of record mode.

getAutomationClassName

()method 
public function getAutomationClassName(obj:IAutomationObject):String

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

Returns the text to display as the type of the object.

Parameters

obj:IAutomationObject — Automation object.

Returns
String — Type of the object.

getAutomationName

()method 
public function getAutomationName(obj:IAutomationObject):String

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

Returns the text to display as the description for the object.

Parameters

obj:IAutomationObject — Automation object.

Returns
String — Text description of the Automation object.

getChildren

()method 
public function getChildren(obj:IAutomationObject, ignoreShowInHierarchy:Boolean = false):Array

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

Returns all children of this object that are visible within the testing hierarchy. If a child is not visible within the hierarchy, returns the children of the invisible child.

Parameters

obj:IAutomationObject — Object for which to get the children.
 
ignoreShowInHierarchy:Boolean (default = false)

Returns
Array — Array of children.

getChildrenFromIDPart

()method 
public function getChildrenFromIDPart(obj:IAutomationObject, part:AutomationIDPart = null, ignoreShowInHierarchy:Boolean = false):Array

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

Returns all children of this object that are visible within the testing hierarchy and meet the criteria in the automation part. If a child is not visible within the hierarchy, this method returns the children of the invisible child.

Parameters

obj:IAutomationObject — Object for which to get the children.
 
part:AutomationIDPart (default = null) — Criteria of which children to return.
 
ignoreShowInHierarchy:Boolean (default = false) — Boolean that determines whether object is ignored within the automation hierarchy. The default value is false.

Returns
Array — Array of children matching the criteria.

getElementFromPoint

()method 
public function getElementFromPoint(x:int, y:int):IAutomationObject

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

Returns the automation object under the given coordinate.

Parameters

x:int — The x coordinate.
 
y:int — The y coordinate.

Returns
IAutomationObject — Automation object at that point.

getParent

()method 
public function getParent(obj:IAutomationObject, parentToStopAt:IAutomationObject = null, ignoreShowInHierarchy:Boolean = false):IAutomationObject

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

Returns the next parent that is visible within the automation hierarchy.

Parameters

obj:IAutomationObject — Automation object.
 
parentToStopAt:IAutomationObject (default = null) — Parent of the given automation object.
 
ignoreShowInHierarchy:Boolean (default = false) — Boolean that determines whether object is ignored within the automation hierarchy. The default value is false.

Returns
IAutomationObject — Nearest parent of the object visible within the automation hierarchy.

getProperties

()method 
public function getProperties(obj:IAutomationObject, names:Array = null, forVerification:Boolean = true, forDescription:Boolean = true):Array

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

Returns the values for a set of properties.

Parameters

obj:IAutomationObject — Object for which to get the properties.
 
names:Array (default = null) — Names of the properties to evaluate on the object.
 
forVerification:Boolean (default = true) — If true, only include verification properties.
 
forDescription:Boolean (default = true) — If true, only include description properties.

Returns
Array — Array of objects that contain each property value and descriptor.

getRectangle

()method 
public function getRectangle(obj:DisplayObject):Array

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

The display rectangle enclosing the DisplayObject.

Parameters

obj:DisplayObject — DisplayObject whose rectangle is desired.

Returns
Array — An array of four integers: top, left, width and height.

getTabularData

()method 
public function getTabularData(obj:IAutomationObject):mx.automation:IAutomationTabularData

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

Returns the object implementing the IAutomationTabularData interface through which the tabular data can be obtained.

Parameters

obj:IAutomationObject — An IAutomationObject.

Returns
mx.automation:IAutomationTabularData — An object implementing the IAutomationTabularData interface.

incrementCacheCounter

()method 
public function incrementCacheCounter():int

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

Increments the cache counter. The automation mechanism caches both an object's properties and its children. The cache exists for both performance reasons, and so that an objects state prior to a recording can be captured. Each call to the incrementCacheCounter() method increments a counter and each call to the decrementCacheCounter() method decrements the cache counter. When the counter reaches zero the cache is cleared.

It's important that testing tools only use the cache when they are certain that the state of the Flex application is frozen and the user cannot interact with it. For example, when an automation event is recorded, a testing tool might need to make several calls to the getChildren() method or the getProperties() method to create a testing script line. To do this, it would wrap all the calls up in start/stop cache calls.

Internally, the AutomationManager forcibly clears the cache before an end-user interaction that might trigger an automation event. It then increments the cache counter and decrements the counter after the automation event is dispatched. Testing tools can prevent the count from reaching zero by calling the incrementCacheCounter() method in their record handler.

Returns
int — the current cache counter.

isSynchronized

()method 
public function isSynchronized(target:IAutomationObject):Boolean

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

Tests if the provided target needs to wait until a previous operation completes.

Parameters

target:IAutomationObject — Target to check for synchronization or null to synchronize on any running operations.

Returns
Booleantrue if synchronization is complete, false otherwise.

isVisible

()method 
public function isVisible(obj:DisplayObject):Boolean

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

Returns true if an object and all of its parents are visible.

Parameters

obj:DisplayObject — DisplayObject.

Returns
Booleantrue if an object and all of its parents are visible.

recordAutomatableEvent

()method 
public function recordAutomatableEvent(recorder:IAutomationObject, event:Event, cacheable:Boolean = false):void

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

Records the event.

Parameters

recorder:IAutomationObject — The automation object on which the event is to be recorded.
 
event:Event — The actual event which needs to be recorded.
 
cacheable:Boolean (default = false) — Controls the caching of the event that is recorded. During a mouse-down, mouse-up sequence, the automation mechanism tries to record the most important or suitable event rather than all the events. For example, if you have a List control which has a button in its item renderer. When the user clicks on the button, the automation mechanism only records the click event for the button, but ignores the select event generated from the List control.

recordCustomAutomationEvent

()method 
public function recordCustomAutomationEvent(customEvent:AutomationRecordEvent):Boolean

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

Records the custom event.

Parameters

customEvent:AutomationRecordEvent — - The AutomationRecordEvent that specifies that it is a custom evnet; the type is customRecord. For example, if you want to record a custom event without writing a delegate and providing the details in an environment file, you can use this interface to record the custom event. You should listen to the AutomationPlaybackEvent, handle the replay, and prevent the default on the AutomationPlaybackEvent.

Returns
Boolean

replayAutomatableEvent

()method 
public function replayAutomatableEvent(event:AutomationReplayEvent):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 call the super.replayAutomatableEvent() method in case default replay behavior has been defined in a superclass.

Parameters

event:AutomationReplayEvent — Event to replay.

Returns
Booleantrue if the replay was successful.

resolveID

()method 
public function resolveID(rid:AutomationID, currentParent:IAutomationObject = null):Array

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

Resolves an id to automation objects.

Parameters

rid:AutomationID — Automation id of the automation object.
 
currentParent:IAutomationObject (default = null) — Current parent of the automation object.

Returns
Array — An Array containing all the objects matching the rid.

resolveIDPart

()method 
public function resolveIDPart(parent:IAutomationObject, part:AutomationIDPart):Array

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

Resolves an id part to an Array of automation objects.

Parameters

parent:IAutomationObject — Parent of the automation object.
 
part:AutomationIDPart — id part of the automation object.

Returns
Array — Array of automation objects which match part.

resolveIDPartToSingleObject

()method 
public function resolveIDPartToSingleObject(parent:IAutomationObject, part:AutomationIDPart):IAutomationObject

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

Resolves an id part to an automation object within the parent.

Parameters

parent:IAutomationObject — Parent of the automation object.
 
part:AutomationIDPart — id part of the automation object.

Returns
IAutomationObject — IAutomationObject which matches with the part. If no object is found or multiple objects are found, throw an exception.

resolveIDToSingleObject

()method 
public function resolveIDToSingleObject(rid:AutomationID, currentParent:IAutomationObject = null):IAutomationObject

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

Resolves an id to an automation object.

Parameters

rid:AutomationID — Automation id of the automation object.
 
currentParent:IAutomationObject (default = null) — Current parent of the automation object.

Returns
IAutomationObject — IAutomationObject which matches with the rid. If no object is found or multiple objects are found, this method throws an exception.

showInHierarchy

()method 
public function showInHierarchy(obj:IAutomationObject):Boolean

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

Indicates whether an automation object should be visible within the hierarchy.

Parameters

obj:IAutomationObject — The automation object.

Returns
Booleantrue if the object should be shown within the automation hierarchy.