CompositeEffect

パッケージ	mx.effects
クラス	public class CompositeEffect
継承	CompositeEffect Effect EventDispatcher Object
サブクラス	Parallel, Sequence

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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 シンタックスを隠す

The CompositeEffect class adds the following tag attributes, and all the subclasses of the CompositeEffect class inherit these tag attributes:

  <mx:tagname>
    <mx:children>
      <!-- Specify child effect tags --> 
    </mx:children>
  </mx:tagname>

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

パブリックプロパティ

継承されるパブリックプロパティを隠す

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

	プロパティ		定義元
		children : Array この CompositeEffect の子エフェクトが含まれる配列です。	CompositeEffect
		className : String [読み取り専用] このエフェクトクラスの名前です。たとえば、"Fade" などがあります。	Effect
		compositeDuration : Number [読み取り専用] すべての子エフェクトの継続時間によって定義される、このエフェクトの継続時間を返します。	CompositeEffect
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。	Object
		customFilter : mx.effects:EffectTargetFilter エフェクトを再生するターゲットを特定するために、エフェクトによって使用されるタイプ EffectTargetFilter のカスタムフィルターオブジェクトを指定します。	Effect
		duration : Number エフェクトの継続時間を表します（ミリ秒単位）。	Effect
		effectTargetHost : mx.effects:IEffectTargetHost データエフェクトのターゲットリストコントロールにアクセスできるプロパティです。	Effect
		filter : String エフェクトのターゲットをフィルタリングするアルゴリズムを指定します。	Effect
		hideFocusRing : Boolean エフェクトの開始時にエフェクトがフォーカス枠を非表示にするかどうかを指定します。	Effect
		instanceClass : Class このエフェクトクラスのエフェクトインスタンスクラスを指定する Class 型のオブジェクトを表します。	Effect
		isPlaying : Boolean [読み取り専用] エフェクトのインスタンスのいずれかが現在再生中の場合に true、そうでない場合に false となる読み取り専用フラグです。	Effect
		perElementOffset : Number エフェクトの最初のターゲットの後に発生する、エフェクトターゲットの追加遅延（ミリ秒）です。	Effect
		playheadTime : Number エフェクトの現在の時間位置です。	Effect
		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 このエフェクトが適用されるオブジェクトを表します。	Effect
		targets : Array エフェクトのターゲットであるオブジェクトの配列を表します。	Effect
		triggerEvent : Event エフェクトがトリガーされたときに EffectManager によってこの Effect に渡される Event オブジェクトです。EffectManager によってエフェクトが再生されていない場合は null です。	Effect

プロテクトプロパティ

継承されるプロテクトプロパティを隠す

継承されるプロテクトプロパティを表示

	プロパティ		定義元
		applyTransitionEndProperties : Boolean このフラグは、エフェクトがトランジションで実行された場合に、エフェクト自体が設定した値をそのまま使用するのではなく、その終了状態に応じてプロパティ値を自動的に適用するかどうかを制御します。	Effect
		endValuesCaptured : Boolean = false エフェクトの終了値が既に決定されている場合は true を含むフラグ、エフェクトの実行時にエフェクトターゲットの現在のプロパティから終了値を取得する必要がある場合は false を含むフラグです。	Effect

パブリックメソッド

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

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

	メソッド		定義元
		CompositeEffect(target:Object = null) コンストラクターです。	CompositeEffect
		addChild(childEffect:IEffect):void 新しい子エフェクトを、この組み合わせたエフェクトに追加します。	CompositeEffect
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。	EventDispatcher
		captureEndValues():void エフェクトのターゲットにおいて関連するプロパティの現在値をキャプチャし、終了値として保存します。	Effect
		captureMoreStartValues(targets:Array):void ターゲットの追加セットの関連するプロパティの現在値をキャプチャします。この機能は、データ変更エフェクトを実行したときに Flex によって使用されます。	Effect
		captureStartValues():void エフェクトのターゲットにおいて関連するプロパティの現在値をキャプチャします。	Effect
		createInstance(target:Object = null):IEffectInstance 1 つのエフェクトインスタンスを作成し、それを初期化します。	Effect
		createInstances(targets:Array = null):Array ターゲットオブジェクトの配列を取得し、各ターゲットで createInstance() メソッドを呼び出します。	Effect
		deleteInstance(instance:IEffectInstance):void インスタンスからイベントリスナーを削除し、インスタンスのリストからインスタンスを削除します。	Effect
		dispatchEvent(event:Event):Boolean イベントをイベントフローに送出します。	EventDispatcher
		end(effectInstance:IEffectInstance = 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
		stop():void エフェクトターゲットを現在の状態にしたまま、エフェクトを停止します。	Effect
		toLocaleString():String ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。	Object
		toString():String 指定されたオブジェクトのストリング表現を返します。	Object
		valueOf():Object 指定されたオブジェクトのプリミティブな値を返します。	Object
		willTrigger(type:String):Boolean 指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。	EventDispatcher

プロテクトメソッド

継承されるプロテクトメソッドを隠す

継承されるプロテクトメソッドを表示

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

イベント

イベントの詳細についてはここをクリックしてください

継承されるイベントを隠す

継承されるイベントを表示

	概要	定義元
activate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。	EventDispatcher
deactivate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。	EventDispatcher
effectEnd	エフェクトのインスタンスの 1 つが再生を停止したとき（インスタンスの再生完了時、またはエフェクトが end() メソッドの呼び出しにより中断されたとき）に送出されます。	Effect
effectStart	エフェクトの再生開始時に送出されます。	Effect
effectStop	エフェクトが停止されると送出されます。これが発生するのは、stop() メソッドの呼び出しによってエフェクトが中断された場合のみです。	Effect

プロパティの詳細

children

プロパティ

children:Array

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

実装
public function get children():Array
public function set children(value:Array):void

compositeDuration

プロパティ

compositeDuration:Number [読み取り専用]

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

すべての子エフェクトの継続時間によって定義される、このエフェクトの継続時間を返します。すべての子エフェクトの startDelay および繰り返しの情報を継続時間と共に考慮して、適切な結果を返します。

実装
public function get compositeDuration():Number

コンストラクターの詳細

()

コンストラクター

public function CompositeEffect(target:Object = null)

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

コンストラクターです。

パラメーター

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

メソッドの詳細

addChild

()

メソッド

public function addChild(childEffect:IEffect):void

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

パラメーター

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

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

CompositeEffect - AS3 Flex

クラス x

children

compositeDuration

CompositeEffect

addChild