| パッケージ | mx.effects |
| public class EffectTargetFilter | |
| 継承 | EffectTargetFilter  Object |
EffectTargetFilter クラスでは、filterProperties および filterStyles プロパティを使用する defaultFilterFunction() メソッドを定義することによって、各エフェクトターゲット上でエフェクトを再生するかどうかを決定します。
また、カスタムフィルタ関数を定義して、独自のフィルタリングロジックを実装することもできます。この処理を行うには、カスタムフィルタ関数を定義し、filterFunction プロパティを使用して EffectTargetFilter オブジェクトにその関数を指定します。
エフェクトにカスタムフィルタを使用するような設定を行うには、EffectTargetFilter オブジェクトをエフェクトの Effect.customFilter プロパティに渡します。
関連項目
| プロパティ | 定義 | ||
|---|---|---|---|
 | constructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
| Object | |
| filterFunction : Function
カスタムフィルタ処理を定義する関数を表します。
| EffectTargetFilter | ||
| filterProperties : Array
コンポーネントプロパティを指定するストリングの配列です。
| EffectTargetFilter | ||
| filterStyles : Array
スタイルプロパティを指定するストリングの配列です。
| EffectTargetFilter | ||
| prototype : Object
[static]
クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
| Object | |
| メソッド | 定義 | ||
|---|---|---|---|
|
コンストラクタです。
| EffectTargetFilter | ||
|
指定されたプロパティがオブジェクトに定義されているかどうかを示します。
| Object | |
|
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
| Object | |
|
指定されたプロパティが存在し、列挙できるかどうかを示します。
| Object | |
|
ループ処理に対するダイナミックプロパティの可用性を設定します。
| Object | |
|
指定されたオブジェクトのストリング表現を返します。
| Object | |
|
指定されたオブジェクトのプリミティブな値を返します。
| Object | |
| メソッド | 定義 | ||
|---|---|---|---|
|
EffectTargetFilter クラスのデフォルトのフィルタ関数を表します。
| EffectTargetFilter | ||
| filterFunction | プロパティ |
継承されるパブリックプロパティの非表示
継承されるパブリックプロパティの表示public var filterFunction:Function
カスタムフィルタ処理を定義する関数を表します。このメソッドは、エフェクトのすべてのターゲットで呼び出されます。この関数によって true が返される場合、エフェクトはターゲットで再生されます。false が返される場合、ターゲットはエフェクトによりスキップされます。カスタムフィルタ関数によって、Effect.filter プロパティを使用する場合に比べ、フィルタリング処理全般をさらに制御できます。
このフィルタ関数のシグネチャは次のとおりです。
filterFunc(propChanges:Array, instanceTarget:Object):Boolean
{
// Return true to play the effect on instanceTarget,
// or false to not play the effect.
}
次に、各指定項目について説明します。
propChanges - PropertyChanges オブジェクトの配列で、エフェクトのターゲットコンポーネントごとに 1 つのオブジェクトを持ちます。ターゲットのプロパティがトランジションによって変更されない場合、このプロパティはこの配列に含まれません。
instanceTarget - フィルタ処理を実行するエフェクト特有のターゲットコンポーネント。カスタムフィルタ関数内では、instanceTarget 引数と propChanges.target プロパティを比較して、propChanges 配列で instanceTarget 引数と一致する PropertyChanges オブジェクトを最初に検索します。
関連項目
| filterProperties | プロパティ |
public var filterProperties:Arrayコンポーネントプロパティを指定するストリングの配列です。この配列内のいずれかのプロパティがターゲットコンポーネントで変更された場合、ターゲットでエフェクトを再生します。
カスタムフィルタ関数を定義する場合、関数内から filterProperties プロパティを調べることができます。
| filterStyles | プロパティ |
public var filterStyles:Arrayスタイルプロパティを指定するストリングの配列です。配列内のいずれかのスタイルプロパティがターゲットコンポーネントで変更された場合、ターゲットでエフェクトを再生します。
カスタムフィルタ関数を定義する場合、関数内から filterStyles プロパティを調べることができます。
| EffectTargetFilter | () | コンストラクタ |
public 関数 EffectTargetFilter()コンストラクタです。
| defaultFilterFunction | () | メソッド |
protected function defaultFilterFunction(propChanges:Array, instanceTarget:Object):Boolean
EffectTargetFilter クラスのデフォルトのフィルタ関数を表します。filterProperties プロパティまたは filterStyles プロパティで指定されたいずれかの値に対し、instanceTarget の開始値や終了値が異なる場合は、ターゲットでエフェクトを再生します。
propChanges:Array — PropertyChanges オブジェクトの配列を表します。各 PropertyChanges オブジェクトの target プロパティは、エフェクトのターゲットと等しくなります。エフェクトターゲットについて変更されたプロパティが存在しない場合、プロパティはこの配列に含まれません。
|
|
instanceTarget:Object — この関数を呼び出す EffectInstance のターゲットを表します。エフェクトに複数のターゲットが含まれる場合、関数はターゲットごとに 1 度だけ呼び出されます。
|
Boolean —
true を返して、エフェクトインスタンスの再生を可能にします。
|
関連項目