| パッケージ | mx.effects |
| インターフェイス | public interface IEffect extends IAbstractEffect , IEventDispatcher |
| 実装者 | Effect |
| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
関連する API エレメント
| プロパティ | 定義元 | ||
|---|---|---|---|
| className : String [読み取り専用]
このエフェクトクラスの名前です。たとえば、"Fade" などがあります。 | IEffect | ||
| customFilter : mx.effects:EffectTargetFilter
エフェクトを再生するターゲットを特定するために、エフェクトによって使用されるタイプ EffectTargetFilter のカスタムフィルターオブジェクトを指定します。 | IEffect | ||
| duration : Number
エフェクトの継続時間を表します（ミリ秒単位）。 | IEffect | ||
| effectTargetHost : mx.effects:IEffectTargetHost
データエフェクトのターゲットリストコントロールにアクセスできるプロパティです。 | IEffect | ||
| filter : String
エフェクトのターゲットをフィルタリングするアルゴリズムを指定します。 | IEffect | ||
| hideFocusRing : Boolean
エフェクトの開始時にエフェクトがフォーカス枠を非表示にするかどうかを指定します。 | IEffect | ||
| isPlaying : Boolean [読み取り専用]
エフェクトのインスタンスのいずれかが現在再生中の場合に true、そうでない場合に false となる読み取り専用フラグです。 | IEffect | ||
| perElementOffset : Number
エフェクトの最初のターゲットの後に発生する、エフェクトターゲットの追加遅延（ミリ秒）です。 | IEffect | ||
| playheadTime : Number
エフェクトの現在の時間位置です。 | IEffect | ||
| relevantProperties : Array
フィルタリング実行時に使用するプロパティ名の配列を表します。 | IEffect | ||
| relevantStyles : Array
フィルタリング実行時に使用するスタイル名の配列を表します。 | IEffect | ||
| target : Object
このエフェクトが適用されるオブジェクトを表します。 | IEffect | ||
| targets : Array
エフェクトのターゲットであるオブジェクトの配列を表します。 | IEffect | ||
| triggerEvent : Event
エフェクトがトリガーされたときに EffectManager によってこの Effect に渡される Event オブジェクトです。EffectManager によってエフェクトが再生されていない場合は null です。 | IEffect | ||
継承されるパブリックメソッドを隠す
継承されるパブリックメソッドを表示| メソッド | 定義元 | ||
|---|---|---|---|
 | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。 | IEventDispatcher | |
エフェクトのターゲットにおいて関連するプロパティの現在値をキャプチャし、終了値として保存します。 | IEffect | ||
ターゲットの追加セットの関連するプロパティの現在値をキャプチャします。この機能は、データ変更エフェクトを実行したときに Flex によって使用されます。
| IEffect | ||
エフェクトのターゲットにおいて関連するプロパティの現在値をキャプチャします。 | IEffect | ||
1 つのエフェクトインスタンスを作成し、それを初期化します。 | IEffect | ||
ターゲットオブジェクトの配列を取得し、各ターゲットで createInstance() メソッドを呼び出します。 | IEffect | ||
インスタンスからイベントリスナーを削除し、インスタンスのリストからインスタンスを削除します。 | IEffect | ||
|
イベントをイベントフローに送出します。 | IEventDispatcher | |
現在再生中のエフェクトをすべて中断し、直ちにエフェクトの終わりにジャンプします。 | IEffect | ||
ストリングの配列を返します。各ストリングは、このエフェクトによって変更されるプロパティの名前です。 | IEffect | ||
|
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。 | IEventDispatcher | |
resume() メソッドを呼び出すまで、エフェクトを一時停止します。 | IEffect | ||
エフェクトの再生を開始します。 | IEffect | ||
|
EventDispatcher オブジェクトからリスナーを削除します。 | IEventDispatcher | |
pause() メソッドを呼び出し、エフェクトを一時停止した後、再開させます。 | IEffect | ||
エフェクトが現在再生中の場合に、エフェクトの現在位置から開始して、逆順でエフェクトを再生します。 | IEffect | ||
エフェクトターゲットを現在の状態にしたまま、エフェクトを停止します。 | IEffect | ||
|
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。 | IEventDispatcher | |
className | プロパティ |
customFilter | プロパティ |
customFilter:mx.effects:EffectTargetFilter| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
エフェクトを再生するターゲットを特定するために、エフェクトによって使用されるタイプ EffectTargetFilter のカスタムフィルターオブジェクトを指定します。
ターゲットへのフィルタリングは、エフェクトの再生前に captureStartValues() を呼び出した場合にのみ実行されます。 エフェクトがトランジションに含まれる場合に、captureStartValues() メソッドが自動的に Flex から呼び出されます。
単純なフィルタリングには、filter プロパティを使用します。 customFilter プロパティが null 以外の場合、filter プロパティは無視されます。
デフォルト値： null。
実装
public function get customFilter():mx.effects:EffectTargetFilter public function set customFilter(value:mx.effects:EffectTargetFilter):void関連する API エレメント
duration | プロパティ |
duration:Number| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
エフェクトの継続時間を表します（ミリ秒単位）。
Parallel エフェクトまたは Sequence エフェクトでは、duration プロパティによって各エフェクトの継続時間が設定されます。 たとえば、Sequence エフェクトの duration プロパティが 3000 に設定されている場合、Sequence の各エフェクトの再生時間は 3000 ミリ秒となります。
繰り返されるエフェクトの場合、duration プロパティによって、エフェクトの 1 つあたりのインスタンスの継続時間が指定されます。 したがって、エフェクトで duration プロパティが 2000 に設定され、repeatCount プロパティが 3 に設定されている場合、エフェクトの総再生時間は 6000 ミリ秒（6 秒）となります。
デフォルト値： 500。
実装
public function get duration():Number public function set duration(value:Number):voideffectTargetHost | プロパティ |
effectTargetHost:mx.effects:IEffectTargetHost| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
データエフェクトのターゲットリストコントロールにアクセスできるプロパティです。 このプロパティにより、エフェクトクラスのインスタンスは、エフェクトが再生されているリストコントロールと通信できます。
実装
public function get effectTargetHost():mx.effects:IEffectTargetHost public function set effectTargetHost(value:mx.effects:IEffectTargetHost):voidfilter | プロパティ |
filter:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
エフェクトのターゲットをフィルタリングするアルゴリズムを指定します。 値が null の場合、フィルタリングは指定されません。
ターゲットへのフィルタリングは、エフェクトの再生前に captureStartValues() を呼び出した場合にのみ実行されます。 エフェクトがトランジションに含まれる場合、またはリストコントロールのデータエフェクトに含まれる場合に、captureStartValues() メソッドが自動的に Flex から呼び出されます。
単純なフィルタリングには、このプロパティを使用します。 複雑なフィルタリングには、customFilter プロパティを使用します。 customFilter プロパティに null 以外の値が含まれている場合、このプロパティは無視されます。
filter プロパティについては、次の値を使用できます。
- 値が
"add"の場合、子としてコンテナに追加されるターゲットでエフェクトが再生されます。 - 値が
"addItem"の場合、List または TileList コントロールに追加されるリストアイテムのアイテムレンダラーでエフェクトが再生されます。 - 値が
"hide"の場合、visible プロパティがtrueからfalseに変更されたターゲットでエフェクトが再生されます。 - 値が
"move"の場合、xまたはyプロパティが変更されたターゲットでエフェクトが再生されます。 - 値が
"remove"の場合、コンテナの子として削除されるターゲットでエフェクトが再生されます。 - 値が
"removeItem"の場合、List または TileList コントロールから削除されるリストアイテムのアイテムレンダラーでエフェクトが再生されます。 - 値が
"replacedItem"の場合、List または TileList コントロール内で新しいアイテムに置換されるリストアイテムのアイテムレンダラーでエフェクトが再生されます。 - 値が
"replacementItem"の場合、既存のアイテムを置換する List または TileList コントロールに追加されるリストアイテムのアイテムレンダラーでエフェクトが再生されます。 - 値が
"resize"の場合、widthまたはheightプロパティが変更されたターゲットでエフェクトが再生されます。 - 値が
"show"の場合、visible プロパティがfalseからtrueに変更されたターゲットでエフェクトが再生されます。 - 値が
""の場合、フィルタリングは指定されません。
デフォルト値： null。
実装
public function get filter():String public function set filter(value:String):voidhideFocusRing | プロパティ |
hideFocusRing:Boolean| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
エフェクトの開始時にエフェクトがフォーカス枠を非表示にするかどうかを指定します。エフェクトターゲットは、フォーカス枠を非表示にします。UIComponent クラスのサブクラスは、フォーカス枠を自動的に非表示にします。エフェクトターゲットが UIComponent クラスのサブクラスではない場合は、フォーカス枠を非表示にするための機能を追加します。
エフェクトの再生中にフォーカス枠を非表示にするには、このプロパティを true に設定します。
Effect のサブクラスのデフォルト値は false です。 MaskEffect のサブクラスのデフォルト値は true です。
実装
public function get hideFocusRing():Boolean public function set hideFocusRing(value:Boolean):voidisPlaying | プロパティ |
perElementOffset | プロパティ |
playheadTime | プロパティ |
relevantProperties | プロパティ |
relevantProperties:Array| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
フィルタリング実行時に使用するプロパティ名の配列を表します。 このプロパティは内部的に使用され、エフェクトユーザーは設定する必要がありません。
デフォルト値は、getAffectedProperties() メソッドで返される配列と等しくなります。
実装
public function get relevantProperties():Array public function set relevantProperties(value:Array):voidrelevantStyles | プロパティ |
relevantStyles:Array| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
フィルタリング実行時に使用するスタイル名の配列を表します。 このプロパティは内部的に使用され、エフェクトユーザーは設定する必要がありません。
デフォルト値は、getAffectedProperties() メソッドで返される配列と等しくなります。
実装
public function get relevantStyles():Array public function set relevantStyles(value:Array):voidtarget | プロパティ |
targets | プロパティ |
targets:Array| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
エフェクトのターゲットであるオブジェクトの配列を表します。エフェクトの再生時、各ターゲットのエフェクトがパラレル処理で実行されます。 target プロパティを設定すると、この配列中のすべてのオブジェクトが置換されます。 targets プロパティが設定されていると、target プロパティによってこの配列の最初の項目が返されます。
実装
public function get targets():Array public function set targets(value:Array):voidtriggerEvent | プロパティ |
captureEndValues | () | メソッド |
public function captureEndValues():void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
エフェクトのターゲットにおいて関連するプロパティの現在値をキャプチャし、終了値として保存します。
エフェクトがデータ変更エフェクトに含まれる場合に、captureEndValues() メソッドが自動的に Flex から呼び出されます。
captureMoreStartValues | () | メソッド |
captureStartValues | () | メソッド |
public function captureStartValues():void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
エフェクトのターゲットにおいて関連するプロパティの現在値をキャプチャします。 エフェクトがトランジションに含まれる場合に、captureStartValues() メソッドが自動的に Flex から呼び出されます。
エフェクトの開始値および終了値を把握するためにエフェクトが必要とされる場合は、この関数を使用します。 この関数を正しく使用するには、次の手順に従います。
captureStartValues()メソッドを呼び出します。 エフェクトはエフェクトの開始値をキャプチャします。- 子の追加または削除、プロパティの変更、位置の変更、またはサイズの変更など、エフェクトターゲットを変更します。
play()メソッドを呼び出します。 エフェクトは終了値をキャプチャします。 この関数によって、このエフェクトで作成されたエフェクトインスタンスごとのEffectInstance.propertyChangesプロパティが作成されます。 エフェクト開発者は、propertyChangesプロパティを使用して、そのエフェクトの開始値および終了値を取得できます。
createInstance | () | メソッド |
public function createInstance(target:Object = null):IEffectInstance| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
1 つのエフェクトインスタンスを作成し、それを初期化します。 play() メソッドの代わりにこのメソッドを使用して、エフェクトインスタンスの再生前にエフェクトインスタンスのプロパティを操作します。
エフェクトインスタンスは、instanceClass プロパティで指定された型で作成されます。 次に、initInstance() メソッドを使用して初期化されます。 インスタンスが EffectManager によって作成されている場合（エフェクトがエフェクトトリガーによってトリガーされる場合）、エフェクトは EffectInstance.initEffect() メソッドの呼び出しによりさらに初期化されます。
createInstance() メソッドが呼び出されると、エフェクトは再生されません。 返されたエフェクトインスタンスで startEffect() メソッドを呼び出します。
この関数は、Effect.play() メソッドによって自動的に呼び出されます。
パラメーター
target:Object (default = null) |
IEffectInstance — エフェクトのエフェクトインスタンスオブジェクトを表します。
|
createInstances | () | メソッド |
public function createInstances(targets:Array = null):Array| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
ターゲットオブジェクトの配列を取得し、各ターゲットで createInstance() メソッドを呼び出します。
パラメーター
targets:Array (default = null) |
Array — ターゲットごとに 1 つで、かつエフェクト用でもあるエフェクトインスタンスオブジェクトの配列を表します。
|
deleteInstance | () | メソッド |
public function deleteInstance(instance:IEffectInstance):void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
インスタンスからイベントリスナーを削除し、インスタンスのリストからインスタンスを削除します。
パラメーター
instance:IEffectInstance — エフェクトのインスタンスです。
|
end | () | メソッド |
public function end(effectInstance:IEffectInstance = null):void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
現在再生中のエフェクトをすべて中断し、直ちにエフェクトの終わりにジャンプします。 このメソッドが呼び出されると、EffectInstance.end() メソッドも呼び出されます。
エフェクトの終了処理の一環としてこのメソッドが呼び出されると、エフェクトインスタンスにより effectEnd イベントが送出されます。
エフェクトインスタンスを引数として渡すと、そのインスタンスは中断されます。 引数が渡されないと、そのときエフェクトから生成されたすべてのエフェクトインスタンスが中断されます。
パラメーター
effectInstance:IEffectInstance (default = null) |
関連する API エレメント
getAffectedProperties | () | メソッド |
public function getAffectedProperties():Array| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
ストリングの配列を返します。各ストリングは、このエフェクトによって変更されるプロパティの名前です。たとえば、Move エフェクトは "x" と "y" から成る配列を返します。
Effect のサブクラスはすべてこのメソッドを実装する必要があります。 このメソッドは、2 つのエフェクトが同時に同一オブジェクトの同一プロパティをアニメーション化しないように EffectManager で使用されます。
戻り値Array — このエフェクトで変更されたプロパティの名前を指定するストリングの配列を表します。
|
pause | () | メソッド |
public function pause():void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
resume() メソッドを呼び出すまで、エフェクトを一時停止します。
play | () | メソッド |
public function play(targets:Array = null, playReversedFromEnd:Boolean = false):Array| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
エフェクトの再生を開始します。 通常は end() メソッドを play() メソッドの前に呼び出します。これは、エフェクトの以前のインスタンスを確実に終了させてから新しいインスタンスを開始するためです。
すべてのサブクラスではこのメソッドを実装する必要があります。
パラメーター
targets:Array (default = null)targets プロパティは使用されません。
| |
playReversedFromEnd:Boolean (default = false)true の場合、エフェクトを逆順に再生します。
|
Array — ターゲットごとに 1 つで、かつエフェクト用でもある EffectInstance オブジェクトの配列を表します。
|
resume | () | メソッド |
public function resume():void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
pause() メソッドを呼び出してエフェクトを一時停止した後、再開させます。
reverse | () | メソッド |
public function reverse():void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
エフェクトが現在再生中の場合に、エフェクトの現在位置から開始して、逆順でエフェクトを再生します。
stop | () | メソッド |
public function stop():void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
エフェクトターゲットを現在の状態にしたまま、エフェクトを停止します。 pause() メソッドの呼び出しと異なり、resume() メソッドを stop() メソッドの後に呼び出すことはできません。 ただし、play() メソッドを呼び出してエフェクトを再開できます。
エフェクトの終了処理の一環としてこのメソッドが呼び出されると、エフェクトインスタンスにより effectEnd イベントが送出されます。
マスクエフェクトの場合、エフェクトを停止してもマスクは自動的に削除されません。 最初のマスクを削除せずに、同じターゲット上でマスクエフェクトをさらに実行すると、予期しない結果が生じる可能性があります。
Tue Jun 12 2018, 10:34 AM Z