mx.effects.CompositeEffect (Flex™ 2 リファレンスガイド)

パッケージ	mx.effects
	public class CompositeEffect
継承	CompositeEffect Effect EventDispatcher Object
Subclasses	Parallel, Sequence

CompositeEffect クラスは、Parallel クラスと Sequence クラスの親クラスであり、<mx:Parallel> と <mx:Sequence> の各 MXML タグを定義します。Flex では、エフェクトを組み合わせる方法を 2 つサポートしています。それは、パラレル処理とシーケンス処理です。パラレルに合成されたエフェクトは同時に再生されます。複数のエフェクトをシーケンス処理で組み合わせると、1 つのエフェクトの再生が終了してから、別のエフェクトの再生が始まります。

MXML では次の例のように組み合わせたエフェクトを作成できます。

<mx:Parallel id="WipeRightUp">
<mx:children>
<mx:WipeRight duration="1000"/>
<mx:WipeUp duration="1000"/>
</mx:children>
</mx:Parallel>
  


<mx:VBox id="myBox" hideEffect="WipeRightUp">
<mx:TextArea id="aTextArea" text="hello"/>
</mx:VBox>

<mx:children> タグは必須ではありません。

通常、ActionScript において組み合わせたエフェクトの開始は、次の 5 つの手順で行います。

組み合わせるエフェクトオブジェクトのインスタンスを、次の例のように作成します。
```
myFadeEffect = new mx.effects.Fade(target);
```
duration など、個々のエフェクトオブジェクトのプロパティを設定します。
Parallel エフェクトオブジェクトまたは Sequence エフェクトオブジェクトのインスタンスを、次の例のように作成します。
```
mySequenceEffect = new mx.effects.Sequence();
```
各エフェクトオブジェクトについて、addChild() メソッドを次の例のように呼び出します。
```
mySequenceEffect.addChild(myFadeEffect);
```
組み合わせたエフェクトの play() メソッドを次の例のように呼び出します。
```
mySequenceEffect.play();
```

MXML シンタックス expanded

MXML シンタックスの非表示

CompositeEffect クラスは次のタグ属性を追加し、CompositeEffect クラスのすべてのサブクラスはこのタグ属性を継承します。

 <mx:タグ名> <mx:children> <!-- 子エフェクトタグを指定 --> </mx:children> </mx:タグ名>

デフォルトの MXML プロパティchildren

パブリックプロパティ

継承されるパブリックプロパティの非表示

継承されるパブリックプロパティの表示

	プロパティ		定義
		children : Array この CompositeEffect の子エフェクトが含まれる配列です。	CompositeEffect
		className : String `"Fade"` など、エフェクトクラスの名前です。	Effect
		constructor : Object 特定のオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。	Object
		customFilter : EffectTargetFilter エフェクトを再生するターゲットを特定するために、エフェクトによって使用されるタイプ EffectTargetFilter のカスタムフィルタオブジェクトを指定します。	Effect
		duration : Number エフェクトの継続時間を表します (ミリ秒単位)。	Effect
		filter : String エフェクトのターゲットをフィルタリングするアルゴリズムを指定します。	Effect
		instanceClass : Class このエフェクトクラスのエフェクトインスタンスクラスを指定する Class 型のオブジェクトを表します。	Effect
		isPlaying : Boolean エフェクトのインスタンスのいずれかが現在再生中の場合に true、そうでない場合に false となる読み取り専用フラグです。	Effect
		prototype : Object [static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。	Object
		relevantProperties : Array フィルタリング実行時に使用するプロパティ名の配列を表します。	Effect
		relevantStyles : Array フィルタリング実行時に使用するスタイル名の配列を表します。	Effect
		repeatCount : int = 1 エフェクトを繰り返す回数を表します。	Effect
		repeatDelay : int = 0 エフェクトを繰り返す前の待機時間を表します (ミリ秒単位)。	Effect
		startDelay : int = 0 エフェクトを開始する前の待機時間を表します (ミリ秒単位)。	Effect
		suspendBackgroundProcessing : Boolean = false `true` の場合、エフェクトの再生中にすべてのバックグラウンド処理をブロックします。	Effect
		target : Object このエフェクトが適用される UIComponent オブジェクトを表します。	Effect
		targets : Array エフェクトのターゲットである UIComponent オブジェクトの配列を表します。	Effect

パブリックメソッド

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

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

	メソッド		定義
		CompositeEffect(target:Object = null) コンストラクタ。	CompositeEffect
		addChild(childEffect:Effect):void 新しい子エフェクトを、この組み合わせたエフェクトに追加します。	CompositeEffect
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。	EventDispatcher
		captureStartValues():void エフェクトのターゲットにおいて関連するプロパティの現在値をキャプチャします。	Effect
		createInstance(target:Object = null):EffectInstance 1 つのエフェクトインスタンスを作成し、それを初期化します。	Effect
		createInstances(targets:Array = null):Array ターゲットオブジェクトの配列を取得し、各ターゲットで `createInstance()` メソッドを呼び出します。	Effect
		dispatchEvent(event:Event):Boolean イベントをイベントフローに送出します。	EventDispatcher
		end(effectInstance:EffectInstance = null):void 現在再生中のエフェクトをすべて中断し、直ちにエフェクトの終わりにジャンプします。	Effect
		getAffectedProperties():Array ストリングの配列を返します。各ストリングは、このエフェクトによって変更されるプロパティの名前です。	Effect
		hasEventListener(type:String):Boolean EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。	EventDispatcher
		hasOwnProperty(name:String):Boolean オブジェクトに指定されたプロパティが定義されているかどうかを示します。	Object
		isPrototypeOf(theClass:Object):Boolean Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。	Object
		pause():void `resume()` メソッドを呼び出すまで、エフェクトを一時停止します。	Effect
		play(targets:Array = null, playReversedFromEnd:Boolean = false):Array エフェクトの再生を開始します。	Effect
		propertyIsEnumerable(name:String):Boolean 指定されたプロパティが存在し、列挙可能かどうかを示します。	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void EventDispatcher オブジェクトからリスナーを削除します。	EventDispatcher
		resume():void `pause()` メソッドを呼び出し、エフェクトを一時停止した後、再開させます。	Effect
		reverse():void エフェクトが現在再生中の場合に、エフェクトの現在位置から開始して、逆順でエフェクトを再生します。	Effect
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void ループ処理に対するダイナミックプロパティの可用性を設定します。	Object
		toString():String 指定されたオブジェクトのストリング表現を返します。	Object
		valueOf():Object 指定されたオブジェクトのプリミティブ値を返します。	Object
		willTrigger(type:String):Boolean 指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。	EventDispatcher

Protectedメソッド

継承される Protected メソッドの表示

	メソッド		定義
		applyValueToTarget(target:Object, property:String, value:*, props:Object):void エフェクトインフラストラクチャによって内部的に使用されます。	Effect
		effectEndHandler(event:EffectEvent):void エフェクトインスタンスの再生終了時に呼び出されます。	Effect
		effectStartHandler(event:EffectEvent):void このメソッドは、エフェクトインスタンスの再生開始時に呼び出されます。	Effect
		filterInstance(propChanges:Array, targ:Object):Boolean エフェクトインスタンスのフィルタリングに必要なロジックを決定します。	Effect
		getValueFromTarget(target:Object, property:String):* ターゲットからプロパティの値を取得するために `captureStartValues()` によって呼び出されます。	Effect
		initInstance(instance:EffectInstance):void エフェクトインスタンスにエフェクトのプロパティをコピーします。	Effect

	イベント	一覧	定義
		effectEnd	エフェクトの再生停止時 (エフェクトの再生完了時、またはエフェクトが `end()` メソッドの呼び出しにより中断されたとき) に送出されます。	Effect
		effectStart	エフェクトの再生開始時に送出されます。	Effect

プロパティの詳細

children

プロパティ

public var children:Array

この CompositeEffect の子エフェクトが含まれる配列です。

コンストラクタの詳細

CompositeEffect

()

コンストラクタ

public 関数 CompositeEffect(target:Object = null)

コンストラクタ。

パラメータ

target:Object (default = null) — 組み合わせたエフェクトの場合、この引数は無視されます。このパラメータは、他の種類のエフェクトとの一貫性を維持する目的で用意されています。

メソッドの詳細

addChild

()

メソッド

public function addChild(childEffect:Effect):void

新しい子エフェクトを、この組み合わせたエフェクトに追加します。Sequence エフェクトでは、それぞれの子エフェクトが、追加された順序で一度に 1 つずつ再生されます。Parallel エフェクトでは、すべての子エフェクトが、追加された順序に関係なく同時に再生されます。

パラメータ

childEffect:Effect — 組み合わせたエフェクトに追加する子エフェクトを表します。

Adobe^® Flex™ 2 リファレンスガイド		すべてのパッケージ \| すべてのクラス \| 言語エレメント \| 索引 \| 付録 \| 規則 \| フレーム内に表示フレームなしバージョン
Class CompositeEffect	プロパティ \| メソッド \| イベント