| パッケージ | mx.effects |
| クラス | public class EffectTargetFilter |
| 継承 | EffectTargetFilter Object |
| サブクラス | AddRemoveEffectTargetFilter, HideShowEffectTargetFilter |
| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
EffectTargetFilter クラスでは、defaultFilterFunction() メソッド(filterProperties および defaultFilterFunction() プロパティを使用する)を定義することによって、各エフェクトターゲット上でエフェクトを再生するかどうかを決定します。
また、カスタムフィルター関数を定義して、独自のフィルタリングロジックを実装することもできます。 この処理を行うには、カスタムフィルター関数を定義し、filterFunction プロパティを使用して EffectTargetFilter オブジェクトにその関数を指定します。
エフェクトにカスタムフィルターを使用するような設定を行うには、EffectTargetFilter オブジェクトをエフェクトの Effect.customFilter プロパティに渡します。
さらに例を参照
| プロパティ | 定義元 | ||
|---|---|---|---|
![]() | constructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。 | Object | |
| filterFunction : Function
カスタムフィルター処理を定義する関数を表します。 | EffectTargetFilter | ||
| filterProperties : Array
コンポーネントプロパティを指定するストリングの配列です。 | EffectTargetFilter | ||
| filterStyles : Array
スタイルプロパティを指定するストリングの配列です。 | EffectTargetFilter | ||
| requiredSemantics : Object = null
再生されるエフェクトのターゲットに関連付ける必要がある、プロパティと関連する値のコレクションです。 | EffectTargetFilter | ||
| メソッド | 定義元 | ||
|---|---|---|---|
コンストラクターです。 | EffectTargetFilter | ||
filterInstance(propChanges:Array, semanticsProvider:mx.effects:IEffectTargetHost, target:Object):Boolean
ターゲットをフィルター処理するかどうかを指定します。ターゲットをエフェクトに含める必要がある場合は、true を返します。 | EffectTargetFilter | ||
![]() |
オブジェクトに指定されたプロパティが定義されているかどうかを示します。 | Object | |
![]() |
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。 | Object | |
![]() |
指定されたプロパティが存在し、列挙できるかどうかを示します。 | Object | |
![]() |
ループ処理に対するダイナミックプロパティの可用性を設定します。 | Object | |
![]() |
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。 | Object | |
![]() |
指定されたオブジェクトのストリング表現を返します。 | Object | |
![]() |
指定されたオブジェクトのプリミティブな値を返します。 | Object | |
| メソッド | 定義元 | ||
|---|---|---|---|
EffectTargetFilter クラスのデフォルトのフィルター関数を表します。 | EffectTargetFilter | ||
filterFunction | プロパティ |
public var filterFunction:Function| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
カスタムフィルター処理を定義する関数を表します。 このメソッドは、エフェクトのすべてのターゲットで呼び出されます。 この関数によって 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 - フィルター処理を実行するエフェクト特有のターゲットコンポーネント。 カスタムフィルター関数内では、propChanges 配列で instanceTarget 引数と一致する PropertyChanges オブジェクトを最初に検索します(instanceTarget 引数を propChanges.target プロパティと比較して検索します)。
関連する API エレメント
filterProperties | プロパティ |
public var filterProperties:Array| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
コンポーネントプロパティを指定するストリングの配列です。 この配列内のいずれかのプロパティがターゲットコンポーネントで変更された場合、ターゲットでエフェクトを再生します。
カスタムフィルター関数を定義する場合、関数内から filterProperties プロパティを調べることができます。
filterStyles | プロパティ |
public var filterStyles:Array| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
スタイルプロパティを指定するストリングの配列です。 配列内のいずれかのスタイルプロパティがターゲットコンポーネントで変更された場合、ターゲットでエフェクトを再生します。
カスタムフィルター関数を定義する場合、関数内から filterStyles プロパティを調べることができます。
requiredSemantics | プロパティ |
public var requiredSemantics:Object = null| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
再生されるエフェクトのターゲットに関連付ける必要がある、プロパティと関連する値のコレクションです。
データエフェクトを操作するときに、このプロパティを使用してエフェクトをフィルター処理できます。 リストコントロールの、エフェクトによって追加されていないすべてのターゲット(つまりその他の方法で削除、置換、移動されたり影響を受けたりするターゲット)でデータエフェクトを再生する場合、次のようにエフェクト定義を作成できます。
<mx:Blur>
<mx:customFilter>
<mx:EffectTargetFilter requiredSemantics="{{'added':false}}"/>
</mx:customFilter>
</mx:Blur>
エフェクトによって追加または削除されていないすべてのターゲットでデータエフェクトを再生する場合、次のようにエフェクト定義を作成できます。
<mx:Blur>
<mx:customFilter>
<mx:EffectTargetFilter requiredSemantics="{{'added':false}, {'removed':false}}"/>
</mx:customFilter>
</mx:Blur>
指定できるプロパティのリストには、added、removed、replaced および replacement が含まれます。 プロパティに設定できる値は、true と false です。
EffectTargetFilter | () | コンストラクター |
public function EffectTargetFilter()| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
コンストラクターです。
defaultFilterFunction | () | メソッド |
protected function defaultFilterFunction(propChanges:Array, instanceTarget:Object):Boolean| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
EffectTargetFilter クラスのデフォルトのフィルター関数を表します。 instanceTarget の開始値や終了値が、filterProperties プロパティまたは filterStyles プロパティで指定されたいずれかの値に対して異なる場合は、ターゲットでエフェクトを再生します。
パラメーター
propChanges:Array — PropertyChanges オブジェクトの配列を表します。 各 PropertyChanges オブジェクトの target プロパティは、エフェクトのターゲットと等しくなります。 ターゲットのプロパティがトランジションによって変更されない場合、対応する PropertyChanges オブジェクトはこの配列に含まれません。
| |
instanceTarget:Object — この関数を呼び出す EffectInstance のターゲットを表します。 エフェクトに複数のターゲットが含まれる場合、関数はターゲットごとに 1 度だけ呼び出されます。
|
Boolean — true を返して、エフェクトインスタンスの再生を可能にします。
|
関連する API エレメント
filterInstance | () | メソッド |
public function filterInstance(propChanges:Array, semanticsProvider:mx.effects:IEffectTargetHost, target:Object):Boolean| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
ターゲットをフィルター処理するかどうかを指定します。ターゲットをエフェクトに含める必要がある場合は、true を返します。 この指定は filterFunction と semanticFilterFunction の呼び出しによって行われ、両方の関数が true を返す場合のみ true を返します。 デフォルト値を持つデフォルト関数は常に true を返します。 通常、EffectTargetFilter は一方のフィルターのみを使用し、両方は使用しません。
パラメーター
propChanges:Array — PropertyChanges オブジェクトの配列を表します。 各 PropertyChanges オブジェクトの target プロパティは、エフェクトのターゲットと等しくなります。ターゲットのプロパティがトランジションによって変更されない場合、対応する PropertyChanges オブジェクトはこの配列に含まれません。
| |
semanticsProvider:mx.effects:IEffectTargetHost — ターゲットの requiredSemantics で指定されたプロパティの評価に使用される IEffectTargetHost。通常、エフェクトの effectTargetHost です。アイテム変更エフェクトの場合、エフェクトのターゲットがアイテムレンダラーのときは、アイテムレンダラーを含む List または TileList になります。
| |
target:Object — この関数を呼び出す EffectInstance のターゲットを表します。 エフェクトに複数のターゲットが含まれる場合、関数はターゲットごとに 1 度だけ呼び出されます。
|
Boolean — ターゲットをエフェクトに含める必要がある場合は true、それ以外の場合は false を返します。
|
Tue Jun 12 2018, 10:34 AM Z
継承されるパブリックプロパティを隠す
継承されるパブリックプロパティを表示