IAutomationManager - Adobe ActionScript® 3（AS3 Flex）API リファレンス

パッケージ	mx.automation
インターフェイス	public interface IAutomationManager extends IEventDispatcher

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

IAutomationManager インターフェイスは、オートメーションモジュールが AutomationManager オブジェクトから返すインターフェイスを定義します。

さらに例を参照

Understanding the automation framework

パブリックプロパティ

	プロパティ		定義元
		automationEnvironment : Object この Automation Manager のオートメーション環境です。	IAutomationManager
		recording : Boolean [読み取り専用] 記録を行うかどうかを指定します。	IAutomationManager
		replaying : Boolean [読み取り専用] 再生を行うかどうかを指定します。	IAutomationManager

パブリックメソッド

継承されるパブリックメソッドを隠す

継承されるパブリックメソッドを表示

	メソッド		定義元
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。	IEventDispatcher
		beginRecording():void Automation Manager を記録モードに設定します。	IAutomationManager
		createID(obj:IAutomationObject, relativeToParent:IAutomationObject = null):AutomationID resolveID() メソッドで使用できる、指定されたオブジェクトの ID を返します。	IAutomationManager
		createIDPart(obj:IAutomationObject, parent:IAutomationObject = null):AutomationIDPart resolveIDPart() メソッドで使用できる、指定されたオブジェクトの ID パートを返します。	IAutomationManager
		decrementCacheCounter(clearNow:Boolean = false):int キャッシュカウンターをデクリメントします。	IAutomationManager
		dispatchEvent(event:Event):Boolean イベントをイベントフローに送出します。	IEventDispatcher
		endRecording():void Automation Manager の記録モードを解除します。	IAutomationManager
		getAutomationClassName(obj:IAutomationObject):String オブジェクト型として表示されるテキストを返します。	IAutomationManager
		getAutomationName(obj:IAutomationObject):String オブジェクトの説明として表示されるテキストを返します。	IAutomationManager
		getChildren(obj:IAutomationObject, ignoreShowInHierarchy:Boolean = false):Array このオブジェクトの子のうち、テスト階層に表示されているすべての子を返します。	IAutomationManager
		getChildrenFromIDPart(obj:IAutomationObject, part:AutomationIDPart = null, ignoreShowInHierarchy:Boolean = false):Array このオブジェクトの子のうち、テスト階層に表示されており、オートメーションパートの条件を満たすすべての子を返します。	IAutomationManager
		getElementFromPoint(x:int, y:int):IAutomationObject 指定された座標のオートメーションオブジェクトを返します。	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
		getRectangle(obj:DisplayObject):Array DisplayObject を囲む矩形を表示します。	IAutomationManager
		getTabularData(obj:IAutomationObject):mx.automation:IAutomationTabularData IAutomationTabularData インターフェイスを実装するオブジェクトを返します。このインターフェイスによって表形式のデータを取得できます。	IAutomationManager
		hasEventListener(type:String):Boolean EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。	IEventDispatcher
		incrementCacheCounter():int キャッシュカウンターをインクリメントします。	IAutomationManager
		isSynchronized(target:IAutomationObject):Boolean 指定されたターゲットが前の処理が完了するのを待つ必要があるかどうかをテストします。	IAutomationManager
		isVisible(obj:DisplayObject):Boolean オブジェクトとその親がすべて表示されている場合は、true を返します。	IAutomationManager
		recordAutomatableEvent(recorder:IAutomationObject, event:Event, cacheable:Boolean = false):void イベントを記録します。	IAutomationManager
		recordCustomAutomationEvent(customEvent:AutomationRecordEvent):Boolean カスタムイベントを記録します。	IAutomationManager
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void EventDispatcher オブジェクトからリスナーを削除します。	IEventDispatcher
		replayAutomatableEvent(event:AutomationReplayEvent):Boolean 指定されたイベントを再生します。	IAutomationManager
		resolveID(rid:AutomationID, currentParent:IAutomationObject = null):Array ID を解決してオートメーションオブジェクトにします。	IAutomationManager
		resolveIDPart(parent:IAutomationObject, part:AutomationIDPart):Array ID パートを解決して、オートメーションオブジェクトにします。	IAutomationManager
		resolveIDPartToSingleObject(parent:IAutomationObject, part:AutomationIDPart):IAutomationObject ID パートを解決して、親の中にあるオートメーションオブジェクトにします。	IAutomationManager
		resolveIDToSingleObject(rid:AutomationID, currentParent:IAutomationObject = null):IAutomationObject ID を解決してオートメーションオブジェクトにします。	IAutomationManager
		showInHierarchy(obj:IAutomationObject):Boolean オートメーションオブジェクトを階層に表示するかどうかを示します。	IAutomationManager
		willTrigger(type:String):Boolean 指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。	IEventDispatcher

プロパティの詳細

automationEnvironment

プロパティ

automationEnvironment:Object

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

この Automation Manager のオートメーション環境です。オートメーション環境は、エージェントツールとの通信に必要なテスト可能コンポーネントのオブジェクトとプロパティに関する情報を提供します。

このプロパティの値では、IAutomationEnvironment インターフェイスを実装する必要があります。

実装
public function get automationEnvironment():Object
public function set automationEnvironment(value:Object):void

recording

プロパティ

recording:Boolean [読み取り専用]

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

記録を行うかどうかを指定します。

実装
public function get recording():Boolean

replaying

プロパティ

replaying:Boolean [読み取り専用]

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

再生を行うかどうかを指定します。

実装
public function get replaying():Boolean

メソッドの詳細

beginRecording

()

メソッド

public function beginRecording():void

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

Automation Manager を記録モードに設定します。

createID

()

メソッド

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

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

resolveID() メソッドで使用できる、指定されたオブジェクトの ID を返します。

パラメーター

	`obj:IAutomationObject` — オートメーションオブジェクトです。

	`relativeToParent:IAutomationObject` (default = `null`) — オートメーションオブジェクトの親です。

戻り値

AutomationID — オートメーションオブジェクトを表す AutomationID オブジェクトです。

createIDPart

()

メソッド

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

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

resolveIDPart() メソッドで使用できる、指定されたオブジェクトの ID パートを返します。

パラメーター

	`obj:IAutomationObject` — オートメーションオブジェクトです。

	`parent:IAutomationObject` (default = `null`) — オートメーションオブジェクトの親です。

戻り値

AutomationIDPart — オートメーションオブジェクトを表す AutomationIDPart オブジェクトです。

decrementCacheCounter

()

メソッド

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

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

キャッシュカウンターをデクリメントします。カウントがゼロになると、キャッシュはクリアされます。

パラメーター

clearNow:Boolean (default = false) — true の場合、キャッシュカウンターの値に関係なくキャッシュをクリアします。

戻り値

int — 現在のキャッシュカウンターです。

endRecording

()

メソッド

public function endRecording():void

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

Automation Manager の記録モードを解除します。

getAutomationClassName

()

メソッド

public function getAutomationClassName(obj:IAutomationObject):String

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

オブジェクト型として表示されるテキストを返します。

パラメーター

obj:IAutomationObject — オートメーションオブジェクトです。

戻り値

String — オブジェクト型です。

getAutomationName

()

メソッド

public function getAutomationName(obj:IAutomationObject):String

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

オブジェクトの説明として表示されるテキストを返します。

パラメーター

obj:IAutomationObject — オートメーションオブジェクトです。

戻り値

String — オートメーションオブジェクトのテキストの説明です。

getChildren

()

メソッド

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

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

このオブジェクトの子のうち、テスト階層に表示されているすべての子を返します。階層に子が表示されていない場合、非表示の子の子を返します。

パラメーター

	`obj:IAutomationObject` — 子を取得する対象オブジェクトです。

	`ignoreShowInHierarchy:Boolean` (default = `false`)

戻り値

Array — 子の配列です。

getChildrenFromIDPart

()

メソッド

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

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

このオブジェクトの子のうち、テスト階層に表示されており、オートメーションパートの条件を満たすすべての子を返します。階層に子が表示されていない場合、このメソッドは非表示の子の子を返します。

パラメーター

	`obj:IAutomationObject` — 子を取得する対象オブジェクトです。

	`part:AutomationIDPart` (default = `null`) — 返す子を指定する条件です。

	`ignoreShowInHierarchy:Boolean` (default = `false`) — オブジェクトがオートメーション階層で無視されたかどうか判別するブール値です。デフォルト値は `false` です。

戻り値

Array — 条件と一致する子の配列です。

getElementFromPoint

()

メソッド

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

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

指定された座標のオートメーションオブジェクトを返します。

パラメーター

	`x:int` — X 座標です。

	`y:int` — Y 座標です。

戻り値

IAutomationObject — そのポイントにおけるオートメーションオブジェクトです。

getParent

()

メソッド

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

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

オートメーション階層に表示されている次の親を返します。

パラメーター

	`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

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

プロパティのセットの値を返します。

パラメーター

	`obj:IAutomationObject` — プロパティを取得する対象オブジェクトです。

	`names:Array` (default = `null`) — オブジェクトで評価するプロパティの名前です。

	`forVerification:Boolean` (default = `true`) — `true` の場合、検証プロパティのみを含みます。

	`forDescription:Boolean` (default = `true`) — `true` の場合、説明プロパティのみを含みます。

戻り値

Array — 各プロパティ値と記述子を含むオブジェクトの配列です。

getRectangle

()

メソッド

public function getRectangle(obj:DisplayObject):Array

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

DisplayObject を囲む矩形を表示します。

パラメーター

obj:DisplayObject — 必要な矩形が含まれている DisplayObject です。

戻り値

Array — 4 つの整数（上、左、幅、高さ）の配列です。

getTabularData

()

メソッド

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

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

IAutomationTabularData インターフェイスを実装するオブジェクトを返します。このインターフェイスによって表形式のデータを取得できます。

パラメーター

obj:IAutomationObject — IAutomationObject です。

戻り値

mx.automation:IAutomationTabularData — IAutomationTabularData インターフェイスを実装するオブジェクトです。

incrementCacheCounter

()

メソッド

public function incrementCacheCounter():int

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

キャッシュカウンターをインクリメントします。オートメーションメカニズムは、オブジェクトのプロパティと子をキャシュします。キャッシュは両方のパフォーマンスのために備えてあり、記録前のオブジェクトステートをキャプチャします。 incrementCacheCounter() メソッドを呼び出すたびにカウンターはインクリメントし、decrementCacheCounter() メソッドを呼び出すたびにカウンターはデクリメントします。カウンターがゼロになると、キャッシュはクリアされます。

重要な点ですが、テストツールがキャッシュを使用するのは、Flex アプリケーションが停止状態で、ユーザーが操作できないことが確実な場合のみです。例えば、オートメーションイベントが記録されると、テストツールは、getChildren() メソッドまたは getProperties() メソッドを呼び出してテストスクリプト行を作成する必要があります。このために、テストツールは全呼び出しを開始 / 停止キャッシュ呼び出しにまとめます。

AutomationManager は、オートメーションイベントをトリガーする可能性のあるエンドユーザー操作が行われる前に、内部でキャッシュをクリアします。次に、キャッシュカウンターをインクリメントし、オートメーションイベントが送出された後、カウンターをデクリメントします。テストツールは、カウントがゼロになるのを防止するため、レコードハンドラーで incrementCacheCounter() メソッドを呼び出します。

戻り値

int — 現在のキャッシュカウンターです。

isSynchronized

()

メソッド

public function isSynchronized(target:IAutomationObject):Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

指定されたターゲットが前の処理が完了するのを待つ必要があるかどうかをテストします。

パラメーター

target:IAutomationObject — 同期化をチェックする対象のターゲットです。実行中の処理を同期化する場合は null です。

戻り値

Boolean — 同期化が完了した場合は true、完了しない場合は false です。

isVisible

()

メソッド

public function isVisible(obj:DisplayObject):Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

オブジェクトとその親がすべて表示されている場合は、true を返します。

パラメーター

obj:DisplayObject — DisplayObject.

戻り値

Boolean — オブジェクトとその親がすべて表示されている場合は、true を返します。

recordAutomatableEvent

()

メソッド

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

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

イベントを記録します。

パラメーター

	`recorder:IAutomationObject` — イベントの記録先のオートメーションオブジェクトです。

	`event:Event` — 記録する必要がある実際のイベントです。

	`cacheable:Boolean` (default = `false`) — 記録するイベントのキャッシュを制御します。オートメーションメカニズムは、マウスを押したり離したりする間、全イベントではなく、最も重要または適切なイベントを記録しようとします。例えば、アイテムレンダラーにボタンが含まれている List コントロールがあるとします。ユーザーがボタンをクリックすると、オートメーションメカニズムは、ボタンの `click` イベントのみを記録し、List コントロールから生成された `select` イベントは無視します。

recordCustomAutomationEvent

()

メソッド

public function recordCustomAutomationEvent(customEvent:AutomationRecordEvent):Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

カスタムイベントを記録します。

パラメーター

customEvent:AutomationRecordEvent — - それがカスタムイベントであることを指定する AutomationRecordEvent。タイプは customRecord です。例えば、委譲先を書き込まず、環境ファイルに詳細を指定することなく、カスタムイベントを記録する場合は、このインターフェイスを使用してカスタムイベントを記録できます。ユーザーは、AutomationPlaybackEvent をリッスンし、再生を処理し、AutomationPlaybackEvent のデフォルトを防止する必要があります。

戻り値

Boolean

replayAutomatableEvent

()

メソッド

public function replayAutomatableEvent(event:AutomationReplayEvent):Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

指定されたイベントを再生します。デフォルトの再生動作がスーパークラスで定義されている場合、コンポーネント作成者は、super.replayAutomatableEvent() メソッドを呼び出す必要があります。

パラメーター

event:AutomationReplayEvent — 再生するイベントです。

戻り値

Boolean — 再生が正常に完了した場合は、true です。

resolveID

()

メソッド

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

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

ID を解決してオートメーションオブジェクトにします。

パラメーター

	`rid:AutomationID` — オートメーションオブジェクトのオートメーション ID です。

	`currentParent:IAutomationObject` (default = `null`) — オートメーションオブジェクトの現在の親です。

戻り値

Array — rid と一致するすべてのオブジェクトを含む配列です。

resolveIDPart

()

メソッド

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

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

ID パートを解決して、オートメーションオブジェクトにします。

パラメーター

	`parent:IAutomationObject` — オートメーションオブジェクトの親です。

	`part:AutomationIDPart` — オートメーションオブジェクトの ID パートです。

戻り値

Array — part と一致するオートメーションオブジェクトの配列です。

resolveIDPartToSingleObject

()

メソッド

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

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

ID パートを解決して、親の中にあるオートメーションオブジェクトにします。

パラメーター

	`parent:IAutomationObject` — オートメーションオブジェクトの親です。

	`part:AutomationIDPart` — オートメーションオブジェクトの ID パートです。

戻り値

IAutomationObject — part と一致する IAutomationObject です。オブジェクトが見つからない場合、または複数のオブジェクトが見つかった場合は、例外をスローします。

resolveIDToSingleObject

()

メソッド

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

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

ID を解決してオートメーションオブジェクトにします。

パラメーター

	`rid:AutomationID` — オートメーションオブジェクトのオートメーション ID です。

	`currentParent:IAutomationObject` (default = `null`) — オートメーションオブジェクトの現在の親です。

戻り値

IAutomationObject — rid と一致する IAutomationObject です。オブジェクトが見つからない場合、または複数のオブジェクトが見つかった場合、このメソッドは例外をスローします。

showInHierarchy

()

メソッド

public function showInHierarchy(obj:IAutomationObject):Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

オートメーションオブジェクトを階層に表示するかどうかを示します。

パラメーター

obj:IAutomationObject — オートメーションオブジェクトです。

戻り値

Boolean — オートメーション階層にオブジェクトを表示する場合は、true です。

法律上の注意 | プライバシーポリシー

IAutomationManager - AS3 Flex

パッケージx

言語エレメント

付録

パッケージ mx.automation

automationEnvironment

recording

replaying

beginRecording

createID

createIDPart

decrementCacheCounter

endRecording

getAutomationClassName

getAutomationName

getChildren

getChildrenFromIDPart

getElementFromPoint

getParent

getProperties

getRectangle

getTabularData

incrementCacheCounter

isSynchronized

isVisible

recordAutomatableEvent

recordCustomAutomationEvent

replayAutomatableEvent

resolveID

resolveIDPart

resolveIDPartToSingleObject

resolveIDToSingleObject

showInHierarchy