ASDoc

mx.effects
Effect クラス

直接の既知のサブクラス
mx.effects.CompositeEffect, mx.effects.Pause, mx.effects.TweenEffect

Effect クラス
Object の拡張

Effect クラスは抽象基本クラスです。アプリケーションで Effect 自体のインスタンスを作成することはありません。その代わり、Fade、WipeLeft などの Effect のいずれかのサブクラスのインスタンスを作成します。

MXML シンタックス

Effect クラスは次のプロパティを定義し、そのすべてのサブクラスに継承されます。

 <mx:TagName
   duration="500"
   suspendBackgroundProcessing="false|true"
 />

コンストラクタ
`Effect ( targetObj)`コンストラクタです。

メソッド
	`endEffect( ) : Void` 現在再生中のエフェクトをすべて中断し、直ちにエフェクトの終わりにジャンプします。
	`getAffectedProperties( ) : Array` ストリングの配列を返します。各ストリングは、このエフェクトによって変更されるプロパティの名前です。
	`playEffect( ) : Void` このエフェクトの再生を開始します。

プロパティ
	`duration:Number` エフェクトの継続時間を表します (ミリ秒単位)。
	`listener:Object` このエフェクトの終了時に通知されるオブジェクトを表します。
	`suspendBackgroundProcessing:Boolean` `true` の場合、エフェクトの再生中にすべてのバックグラウンド処理をブロックします。
	`target :Object` このエフェクトが適用される UIObject を表します。

コンストラクタの詳細

Effect

Effect( targetObj)

コンストラクタです。通常、エフェクトの開始は次の 3 つの手順から成るプロセスです。

エフェクトオブジェクトのインスタンスを作成します (コンストラクタが呼び出されます)。
duration など、エフェクトオブジェクトのプロパティを設定します。
playEffect() メソッドを呼び出します。

パラメータ
targetObj - このエフェクトでアニメーション化するオブジェクトを表します。

メソッドの詳細

endEffect

endEffect( )
										
													 :  Void

現在再生中のエフェクトをすべて中断し、直ちにエフェクトの終わりにジャンプします。

getAffectedProperties

getAffectedProperties( )
										
													 :  Array

ストリングの配列を返します。各ストリングは、このエフェクトによって変更されるプロパティの名前です。たとえば、Move エフェクトは x と y から成る配列を返します。

Effect のサブクラスはすべてこのメソッドを実装する必要があります。内部オブジェクトである EffectManager はこのメソッドを使用して、異なるエフェクトが同じオブジェクトの同じプロパティを同時にアニメーション化しないようにします。

戻り値
プロパティ名の配列です。

playEffect

playEffect( )
										
													 :  Void

このエフェクトの再生を開始します。通常、エフェクトの開始は次の 3 つの手順から成るプロセスです。

エフェクトオブジェクトのインスタンスを作成します (コンストラクタが呼び出されます)。
duration など、エフェクトオブジェクトのプロパティを設定します。
playEffect() メソッドを呼び出します。

プロパティの詳細

duration

duration:Number

エフェクトの継続時間を表します (ミリ秒単位)。デフォルト値は 500 ミリ秒です。

listener

listener:Object

このエフェクトの終了時に通知されるオブジェクトを表します。エフェクトが終了すると、リスナーオブジェクトの onEffectEnd() メソッドが呼び出されます。このメソッドには 1 つの引数 (この Effect オブジェクト) が渡されます。

このエフェクトが MXML を使用して宣言されている場合、listener はこのエフェクトの親である EffectManager または CompositeEffect となるように自動的に設定されます。その場合は、listener プロパティの値を変更しないでください。エフェクトの再生終了時に通知を受信する必要がある場合は、effectEnd イベントを使用します。

suspendBackgroundProcessing

suspendBackgroundProcessing:Boolean

true の場合、エフェクトの再生中にすべてのバックグラウンド処理をブロックします。バックグラウンド処理では、測定、レイアウト、および、サーバーから受信した応答の処理が行われます。デフォルト値は false です。

ほとんどの場合、このプロパティを true に設定することをお勧めします。true に設定すると、アプリケーションのパフォーマンスが向上するためです。ただし、次のいずれかが成り立つ場合はプロパティを false に設定してください。

エフェクトの再生中にユーザー入力を受信する可能性があり、エフェクトの再生が完了する前にアプリケーションでユーザー入力に応答する必要がある場合。
エフェクトの再生中にサーバーから応答を受信する可能性があり、エフェクトをまだ再生している間にアプリケーションで応答を処理する必要がある場合。

target

target :Object

このエフェクトが適用される UIObject を表します。エフェクトが MXML を使用して宣言されている場合、target はエフェクトをトリガしたオブジェクトとなるように自動的に設定されます。このオブジェクトは showEffect プロパティを持つオブジェクトです。

mx.effects Effect クラス