Flex-effect-class

フレックス-効果

前書き

Effectクラスは、すべてのFlexエフェクトの基本機能を定義する抽象基本クラスです。 Effectクラスは、すべてのエフェクトの基本ファクトリクラスを定義します。 EffectInstanceクラスは、すべてのエフェクトインスタンスサブクラスの基本クラスを定義します。

クラス宣言

以下は mx.effects.Effect クラスの宣言です-

public class Effect
   extends EventDispatcher
      implements IEffect

パブリックプロパティ

Sr.No	Property & Description
1	className : String [read-only] The name of the effect class, such as "Fade".
2	customFilter : mx.effects:EffectTargetFilter EffectTargetFilterタイプのカスタムフィルターオブジェクトを指定します。このオブジェクトは、エフェクトが再生するターゲットを決定するためにエフェクトによって使用されます。
3	duration : Number ミリ秒単位の効果の持続時間。
4	effectTargetHost : mx.effects:IEffectTargetHost データ効果のターゲットリストベースのコントロールにアクセスできるようにするプロパティ。
5	filter : String エフェクトのターゲットをフィルタリングするアルゴリズムを指定します。
6	hideFocusRing : Boolean エフェクトを開始するときに、エフェクトがフォーカスリングを非表示にするかどうかを決定します。
7	instanceClass : Class このエフェクトクラスのエフェクトインスタンスクラスクラスを指定するClass型のオブジェクト。
8	isPlaying : Boolean [read-only] A read-only flag which is true if any instances of the effect are currently playing, and false if none are.
9	perElementOffset : Number エフェクトの最初のターゲットの後のエフェクトターゲットの追加の遅延（ミリ秒単位）。
10	playheadTime : Number エフェクトの現在の時間位置。
11	relevantProperties : Array フィルタリングを実行するときに使用するプロパティ名の配列。
12	relevantStyles : Array フィルタリングを実行するときに使用するスタイル名の配列。
13	repeatCount : int = 1 エフェクトを繰り返す回数。
14	repeatDelay : int = 0 エフェクトを繰り返す前に待機する時間（ミリ秒単位）。
15	startDelay : int = 0 エフェクトを開始する前に待機する時間（ミリ秒）。
16	suspendBackgroundProcessing : Boolean = false trueの場合、エフェクトの再生中にすべてのバックグラウンド処理をブロックします。
17	target : Object この効果が適用されるオブジェクト。
18	targets : Array エフェクトのターゲットであるオブジェクトの配列。
19	triggerEvent : Event エフェクトがトリガーされたときにEffectManagerによってこのEffectに渡されるEventオブジェクト、またはEffectManagerによってエフェクトが再生されていない場合はnull。

保護されたプロパティ

Sr.No	Property & Description
1	applyTransitionEndProperties : Boolean このフラグは、効果がトランジションで実行されたときに、効果自体によって設定された値のままにするのではなく、終了状態に従ってプロパティ値を自動的に適用するかどうかを制御します。
2	endValuesCaptured : Boolean = false エフェクトの終了値が既に決定されている場合はtrue、エフェクトの実行時にエフェクトターゲットの現在のプロパティから取得する必要がある場合はfalseを含むフラグ。

パブリックメソッド

Sr.No	Method & Description
1	Effect(target:Object = null) コンストラクタ。
2	captureEndValues():void エフェクトのターゲットの関連プロパティの現在の値をキャプチャし、終了値として保存します。
3	captureMoreStartValues(targets:Array):void データ変更エフェクトの実行時にFlexがこの関数を使用する追加のターゲットセットの関連プロパティの現在値をキャプチャします。
4	captureStartValues():void エフェクトのターゲットの関連プロパティの現在の値をキャプチャします。
5	createInstance(target:Object = null):IEffectInstance 単一のエフェクトインスタンスを作成し、初期化します。
6	createInstances(targets:Array = null):Array ターゲットオブジェクトの配列を取得し、各ターゲットでcreateInstance（）メソッドを呼び出します。
7	deleteInstance(instance:IEffectInstance):void インスタンスからイベントリスナーを削除し、インスタンスのリストからそれを削除します。
8	end(effectInstance:IEffectInstance = null):void 現在再生中のエフェクトを中断し、すぐにエフェクトの最後にジャンプします。
9	getAffectedProperties():Array 文字列の配列を返します。各文字列は、このエフェクトによって変更されたプロパティの名前です。
10	pause():void resume（）メソッドを呼び出すまで、エフェクトを一時停止します。
11	play(targets:Array = null, playReversedFromEnd:Boolean = false):Array エフェクトの再生を開始します。
12	resume():void pause（）メソッドの呼び出しによって一時停止された後、エフェクトを再開します。
13	reverse():void エフェクトが現在再生中の場合、エフェクトの現在位置から開始して、エフェクトを逆方向に再生します。
14	stop():void エフェクトを停止し、エフェクトターゲットを現在の状態のままにします。

保護されたメソッド

Sr.No	Method & Description
1	applyValueToTarget(target:Object, property:String, value:, props:Object):void* Effectインフラストラクチャによって内部的に使用されます。
2	effectEndHandler(event:EffectEvent):void エフェクトインスタンスの再生が終了すると呼び出されます。
3	effectStartHandler(event:EffectEvent):void このメソッドは、エフェクトインスタンスが再生を開始するときに呼び出されます。
4	effectStopHandler(event:EffectEvent):void エフェクトインスタンスがstop（）メソッドの呼び出しによって停止したときに呼び出されます。
5	filterInstance(propChanges:Array, target:Object):Boolean エフェクトインスタンスを除外するためのロジックを決定します。
6	getValueFromTarget(target:Object, property:String):* captureStartValues（）メソッドによって呼び出され、ターゲットからプロパティの値を取得します。
7	initInstance(instance:IEffectInstance):void エフェクトのプロパティをエフェクトインスタンスにコピーします。

イベント

Sr.No	Event & Description
1	effectEnd エフェクトのインスタンスの1つが再生を終了したとき、インスタンスの再生が終了したとき、またはend（）メソッドの呼び出しによってエフェクトが中断されたときに送出されます。
2	effectStart エフェクトの再生開始時に送出されます。
3	effectStop エフェクトが停止したときに送出されます。これは、stop（）メソッドの呼び出しによってエフェクトが中断されたときにのみ発生します。

継承されるメソッド

このクラスは、次のクラスからメソッドを継承します-

• flash.events.EventDispatcher
• 対象