(仅限 Flex 数据可视化)
mx.automation
接口public interface IAutomationManager extends IEventDispatcher

IAutomationManager 接口定义自动化模块希望从 AutomationManager 对象获得的接口。



公共属性
 属性定义方
  automationEnvironment : Object
此自动化管理器的自动化环境。
IAutomationManager
  recording : Boolean
[只读 (read-only)] 通过返回 ture 或 false 来指示是否进行了录制。
IAutomationManager
  replaying : Boolean
[只读 (read-only)] 通过返回 true 或 false 来指示是否进行了重放。
IAutomationManager
公共方法
 方法定义方
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
使用 EventDispatcher 对象注册事件侦听器对象,以使侦听器能够接收事件通知。
IEventDispatcher
  
将自动化管理器设置为录制模式。
IAutomationManager
  
返回可与 resolveID() 方法一起使用的给定对象的 ID。
IAutomationManager
  
返回可在 resolveIDPart 中使用的给定对象的 ID 部分。
IAutomationManager
  
减少缓存计数器计数。
IAutomationManager
 Inherited
将事件调度到事件流中。
IEventDispatcher
  
使自动化管理器进入取消录制模式。
IAutomationManager
  
返回将显示为对象类型的文本。
IAutomationManager
  
返回将显示为对象说明的文本。
IAutomationManager
  
getChildren(obj:IAutomationObject, ignoreShowInHierarchy:Boolean = false):Array
返回此对象的所有在测试层次中可见的子项。
IAutomationManager
  
getChildrenFromIDPart(obj:IAutomationObject, part:AutomationIDPart = null, ignoreShowInHierarchy:Boolean = false):Array
返回此对象的所有在测试层次中可见并符合自动化部分中条件的子项。
IAutomationManager
  
返回给定坐标下的自动化对象。
IAutomationManager
  
getParent(obj:IAutomationObject, parentToStopAt:IAutomationObject = null, ignoreShowInHierarchy:Boolean = false):IAutomationObject
返回下一个在自动化层次中可见的父项。
IAutomationManager
  
getProperties(obj:IAutomationObject, names:Array = null, forVerification:Boolean = true, forDescription:Boolean = true):Array
返回一组属性的值。
IAutomationManager
  
将 DisplayObject 围起来的显示矩形。
IAutomationManager
  
返回实现 IAutomationTabularData 接口的对象,通过此接口可以获得表格数据。
IAutomationManager
 Inherited
检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。
IEventDispatcher
  
增加缓存计数器计数。
IAutomationManager
  
如果提供的目标需要等到上一操作完成,则进行测试。
IAutomationManager
  
如果某个对象及其所有父项都可见,则返回 ture。
IAutomationManager
  
recordAutomatableEvent(recorder:IAutomationObject, event:Event, cacheable:Boolean = false):void
录制事件。
IAutomationManager
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
从 EventDispatcher 对象中删除侦听器。
IEventDispatcher
  
重放指定的事件。
IAutomationManager
  
resolveID(rid:AutomationID, currentParent:IAutomationObject = null):Array
解析针对多个自动化对象的某个 ID。
IAutomationManager
  
将 ID 部分解析为自动化对象的 Array。
IAutomationManager
  
将 ID 部分解析为父项中的自动化对象。
IAutomationManager
  
解析某个自动化对象的 ID。
IAutomationManager
  
指示自动化对象是否应在层次中可见。
IAutomationManager
 Inherited
检查是否用此 EventDispatcher 对象或其任何始祖为指定事件类型注册了事件侦听器。
IEventDispatcher
属性详细信息
automationEnvironment属性
automationEnvironment:Object  [读写]

此自动化管理器的自动化环境。自动化环境提供了有关与代理工具进行通信所需的可测试组件的对象和属性的信息。此属性的值必须实现 IAutomationEnvironment 接口。



实现
    public function get automationEnvironment():Object
    public function set automationEnvironment(value:Object):void

另请参见

recording属性 
recording:Boolean  [只读 (read-only)]

通过返回 truefalse 来指示是否进行了录制。



实现
    public function get recording():Boolean
replaying属性 
replaying:Boolean  [只读 (read-only)]

通过返回 truefalse 来指示是否进行了重放。



实现
    public function get replaying():Boolean
方法详细信息
beginRecording()方法
public function beginRecording():void

将自动化管理器设置为录制模式。

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

返回可与 resolveID() 方法一起使用的给定对象的 ID。

参数

obj:IAutomationObject — 自动化对象。
 
relativeToParent:IAutomationObject (default = null) — 自动化对象的父项。

返回
AutomationID — 表示自动化对象的 AutomationID 对象。
createIDPart()方法 
public function createIDPart(obj:IAutomationObject, parent:IAutomationObject = null):AutomationIDPart

返回可在 resolveIDPart 中使用的给定对象的 ID 部分。

参数

obj:IAutomationObject — 自动化对象。
 
parent:IAutomationObject (default = null) — 自动化对象的父项。

返回
AutomationIDPart — 表示自动化对象的 AutomationIDPart 对象。
decrementCacheCounter()方法 
public function decrementCacheCounter(clearNow:Boolean = false):int

减少缓存计数器计数。计数达到零时,将清除缓存。

参数

clearNow:Boolean (default = false) — 如果为 true,则无论缓存计数器是多少都会清除缓存。

返回
int — 当前缓存计数器。
endRecording()方法 
public function endRecording():void

使自动化管理器进入取消录制模式。

getAutomationClassName()方法 
public function getAutomationClassName(obj:IAutomationObject):String

返回将显示为对象类型的文本。

参数

obj:IAutomationObject — 自动化对象。

返回
String — 对象的类型。
getAutomationName()方法 
public function getAutomationName(obj:IAutomationObject):String

返回将显示为对象说明的文本。

参数

obj:IAutomationObject — 自动化对象。

返回
String — 自动化对象的文本说明。
getChildren()方法 
public function getChildren(obj:IAutomationObject, ignoreShowInHierarchy:Boolean = false):Array

返回此对象的所有在测试层次中可见的子项。如果某个子项在层次中不可见,则将返回不可见子项的子项。

参数

obj:IAutomationObject — 为其获取子项的对象。
 
ignoreShowInHierarchy:Boolean (default = false)

返回
Array — 子项的数组。
getChildrenFromIDPart()方法 
public function getChildrenFromIDPart(obj:IAutomationObject, part:AutomationIDPart = null, ignoreShowInHierarchy:Boolean = false):Array

返回此对象的所有在测试层次中可见并符合自动化部分中条件的子项。如果某个子项在层次中不可见,则此方法将返回不可见子项的子项。

参数

obj:IAutomationObject — 为其获取子项的对象。
 
part:AutomationIDPart (default = null) — 用于确定要返回哪些子项的条件。
 
ignoreShowInHierarchy:Boolean (default = false) — 用于确定是否在自动化层次中忽略对象的布尔值。默认值为 false

返回
Array — 符合条件的子项的数组。
getElementFromPoint()方法 
public function getElementFromPoint(x:int, y:int):IAutomationObject

返回给定坐标下的自动化对象。

参数

x:int — x 坐标。
 
y:int — y 坐标。

返回
IAutomationObject — 该点处的自动化对象。
getParent()方法 
public function getParent(obj:IAutomationObject, parentToStopAt:IAutomationObject = null, ignoreShowInHierarchy:Boolean = false):IAutomationObject

返回下一个在自动化层次中可见的父项。

参数

obj:IAutomationObject — 自动化对象。
 
parentToStopAt:IAutomationObject (default = null) — 给定自动化对象的父项。
 
ignoreShowInHierarchy:Boolean (default = false) — 用于确定是否在自动化层次中忽略对象的布尔值。默认值为 false

返回
IAutomationObject — 自动化层次中可见对象的最近父项。
getProperties()方法 
public function getProperties(obj:IAutomationObject, names:Array = null, forVerification:Boolean = true, forDescription:Boolean = true):Array

返回一组属性的值。

参数

obj:IAutomationObject — 为其获取属性的对象。
 
names:Array (default = null) — 用于评估对象的属性的名称。
 
forVerification:Boolean (default = true) — 如果为 true,则仅包含验证属性。
 
forDescription:Boolean (default = true) — 如果为 true,则仅包含描述属性。

返回
Array — 包含各个属性值及描述符的对象数组。
getRectangle()方法 
public function getRectangle(obj:DisplayObject):Array

将 DisplayObject 围起来的显示矩形。

参数

obj:DisplayObject — 具有所需矩形的 DisplayObject。

返回
Array — 包含四个整数的数组:上边界、左边界、宽度和高度。
getTabularData()方法 
public function getTabularData(obj:IAutomationObject):IAutomationTabularData

返回实现 IAutomationTabularData 接口的对象,通过此接口可以获得表格数据。

参数

obj:IAutomationObject — IAutomationObject。

返回
IAutomationTabularData — 实现 IAutomationTabularData 接口的对象。
incrementCacheCounter()方法 
public function incrementCacheCounter():int

增加缓存计数器计数。自动化机制缓存的对象的属性和子项。出于性能原因使用缓存,以便在录制之前捕获对象状态。每次调用 incrementCacheCounter() 方法都会增加计数器计数,而每次调用 decrementCacheCounter() 方法都会减少缓存计数器计数。计数器达到零时,将清除缓存。

仅当确定 Flex 应用程序处于冻结状态且用户无法与之交互时,测试工具才能使用缓存,这一点很重要。例如,录制自动化事件时,测试工具可能需要多次调用 getChildren() 方法或 getProperties() 方法以创建测试脚本行。为此,它会在开始/停止缓存调用中完成所有调用。

在最终用户交互可能触发自动化事件之前,AutomationManager 会在内部强制清除缓存。然后它增加缓存计数器计数,并在调度自动化事件后减少计数器计数。测试工具可通过调用其录制处理函数中的增量来阻止计数达到零。

返回
int — 当前缓存计数器。
isSynchronized()方法 
public function isSynchronized(target:IAutomationObject):Boolean

如果提供的目标需要等到上一操作完成,则进行测试。

参数

target:IAutomationObject — 目标是检查同步;或者设为 null 以同步任何运行的操作。

返回
Boolean — 如果同步完成,则为 true,否则为 false
isVisible()方法 
public function isVisible(obj:DisplayObject):Boolean

如果某个对象及其所有父项都可见,则返回 true

参数

obj:DisplayObject — DisplayObject.

返回
Boolean — 如果某个对象及其所有父项都可见,则返回 true
recordAutomatableEvent()方法 
public function recordAutomatableEvent(recorder:IAutomationObject, event:Event, cacheable:Boolean = false):void

录制事件。

参数

recorder:IAutomationObject — 在其上录制事件的自动化对象。
 
event:Event — 需要录制的实际事件。
 
cacheable:Boolean (default = false) — 用于控制应录制的事件的缓存。在按下、释放鼠标的过程中,自动化机制会尝试录制最重要或最合适的事件而不是所有事件。例如,假设您已安装 List 控件,在其项目渲染器中有一个按钮。用户单击此按钮时,自动化机制仅录制该按钮的 click 事件,而忽略从 List 控件生成的 select 事件。

replayAutomatableEvent()方法 
public function replayAutomatableEvent(event:AutomationReplayEvent):Boolean

重放指定的事件。如果已在 superclass 中定义默认重放行为,组件作者应调用 super.replayAutomatableEvent() 方法。

参数

event:AutomationReplayEvent — 要重放的事件。

返回
Boolean — 如果重放成功,则为 true
resolveID()方法 
public function resolveID(rid:AutomationID, currentParent:IAutomationObject = null):Array

解析针对多个自动化对象的某个 ID。

参数

rid:AutomationID — 自动化对象的自动化 ID。
 
currentParent:IAutomationObject (default = null) — 自动化对象的当前父项。

返回
Array — 包含与 rid 匹配的所有对象的 Array。
resolveIDPart()方法 
public function resolveIDPart(parent:IAutomationObject, part:AutomationIDPart):Array

将 ID 部分解析为自动化对象的 Array。

参数

parent:IAutomationObject — 自动化对象的父项。
 
part:AutomationIDPart — 自动化对象的 ID 部分。

返回
Array — 与 part 匹配的自动化对象的数组。
resolveIDPartToSingleObject()方法 
public function resolveIDPartToSingleObject(parent:IAutomationObject, part:AutomationIDPart):IAutomationObject

将 ID 部分解析为父项中的自动化对象。

参数

parent:IAutomationObject — 自动化对象的父项。
 
part:AutomationIDPart — 自动化对象的 ID 部分。

返回
IAutomationObject — 与 part 匹配的 IAutomationObject。如果找不到对象或找到多个对象,则会引发异常。
resolveIDToSingleObject()方法 
public function resolveIDToSingleObject(rid:AutomationID, currentParent:IAutomationObject = null):IAutomationObject

解析某个自动化对象的 ID。

参数

rid:AutomationID — 自动化对象的自动化 ID。
 
currentParent:IAutomationObject (default = null) — 自动化对象的当前父项。

返回
IAutomationObject — 与 rid 匹配的 IAutomationObject。如果找不到对象或找到多个对象,则会引发异常。
showInHierarchy()方法 
public function showInHierarchy(obj:IAutomationObject):Boolean

指示自动化对象是否应在层次中可见。

参数

obj:IAutomationObject — 自动化对象。

返回
Boolean — 如果该对象应显示在自动化层次中,则为 true