パッケージmx.effects
クラスpublic class EffectTargetFilter
継承EffectTargetFilter Inheritance Object

EffectTargetFilter クラスでは、各トランジションエフェクトのそれぞれターゲットにおいてそのエフェクトが実行するカスタムフィルタを定義します。

EffectTargetFilter クラスでは、defaultFilterFunction() メソッド(filterProperties および filterStyles プロパティを使用する)を定義することによって、各エフェクトターゲット上でエフェクトを再生するかどうかを決定します。

また、カスタムフィルタ関数を定義して、独自のフィルタリングロジックを実装することもできます。 この処理を行うには、カスタムフィルタ関数を定義し、filterFunction プロパティを使用して EffectTargetFilter オブジェクトにその関数を指定します。

エフェクトにカスタムフィルタを使用するような設定を行うには、EffectTargetFilter オブジェクトをエフェクトの Effect.customFilter プロパティに渡します。

関連項目

Filtering effects


パブリックプロパティ
 プロパティ定義元
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
  filterFunction : Function
カスタムフィルタ処理を定義する関数を表します。
EffectTargetFilter
  filterProperties : Array
コンポーネントプロパティを指定するストリングの配列です。
EffectTargetFilter
  filterStyles : Array
スタイルプロパティを指定するストリングの配列です。
EffectTargetFilter
 Inheritedprototype : Object
[静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
  requiredSemantics : Object = null
再生されるエフェクトのターゲットに関連付ける必要がある、プロパティと関連する値のコレクションです。
EffectTargetFilter
パブリックメソッド
 メソッド定義元
  
コンストラクタです。
EffectTargetFilter
  
filterInstance(propChanges:Array, semanticsProvider:IEffectTargetHost, target:Object):Boolean
ターゲットをフィルタ処理するかどうかを指定します。ターゲットをエフェクトに含める必要がある場合は、true を返します。
EffectTargetFilter
 Inherited
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 Inherited
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 Inherited
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
 Inherited
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 Inherited
指定されたオブジェクトのストリング表現を返します。
Object
 Inherited
指定されたオブジェクトのプリミティブな値を返します。
Object
プロテクトメソッド
 メソッド定義元
  
defaultFilterFunction(propChanges:Array, instanceTarget:Object):Boolean
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 - フィルタ処理を実行するエフェクト特有のターゲットコンポーネント。 カスタムフィルタ関数内では、propChanges 配列で instanceTarget 引数と一致する PropertyChanges オブジェクトを最初に検索します(instanceTarget 引数を propChanges.target プロパティと比較して検索します)。

関連項目

filterPropertiesプロパティ 
public var filterProperties:Array

コンポーネントプロパティを指定するストリングの配列です。 この配列内のいずれかのプロパティがターゲットコンポーネントで変更された場合、ターゲットでエフェクトを再生します。

カスタムフィルタ関数を定義する場合、関数内から filterProperties プロパティを調べることができます。

filterStylesプロパティ 
public var filterStyles:Array

スタイルプロパティを指定するストリングの配列です。 配列内のいずれかのスタイルプロパティがターゲットコンポーネントで変更された場合、ターゲットでエフェクトを再生します。

カスタムフィルタ関数を定義する場合、関数内から filterStyles プロパティを調べることができます。

requiredSemanticsプロパティ 
public var requiredSemantics:Object = null

再生されるエフェクトのターゲットに関連付ける必要がある、プロパティと関連する値のコレクションです。

データエフェクトを操作するときに、このプロパティを使用してエフェクトをフィルタ処理できます。 リストコントロールの、エフェクトによって追加されていないすべてのターゲット(つまりその他の方法で削除、置換、移動されたり影響を受けたりするターゲット)でデータエフェクトを再生する場合、次のようにエフェクト定義を作成できます。

      <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>

指定できるプロパティのリストには、addedremovedreplaced、および replacement が含まれます。プロパティに設定できる値は、truefalse です。

コンストラクタの詳細
EffectTargetFilter()コンストラクタ
public function EffectTargetFilter()

コンストラクタです。

メソッドの詳細
defaultFilterFunction()メソッド
protected function defaultFilterFunction(propChanges:Array, instanceTarget:Object):Boolean

EffectTargetFilter クラスのデフォルトのフィルタ関数を表します。 instanceTarget の開始値や終了値が、filterProperties プロパティまたは filterStyles プロパティで指定されたいずれかの値に対して異なる場合は、ターゲットでエフェクトを再生します。

パラメータ

propChanges:Array — PropertyChanges オブジェクトの配列を表します。各 PropertyChanges オブジェクトの target プロパティは、エフェクトのターゲットと等しくなります。 ターゲットのプロパティがトランジションによって変更されない場合、対応する PropertyChanges オブジェクトはこの配列に含まれません。
 
instanceTarget:Object — この関数を呼び出す EffectInstance のターゲットを表します。 エフェクトに複数のターゲットが含まれる場合、関数はターゲットごとに 1 度だけ呼び出されます。

戻り値
Booleantrue を返して、エフェクトインスタンスの再生を可能にします。

関連項目

filterInstance()メソッド 
public function filterInstance(propChanges:Array, semanticsProvider:IEffectTargetHost, target:Object):Boolean

ターゲットをフィルタ処理するかどうかを指定します。ターゲットをエフェクトに含める必要がある場合は、true を返します。 この指定は filterFunction と semanticFilterFunction の呼び出しによって行われ、両方の関数が true を返す場合のみ true を返します。 デフォルト値を持つデフォルト関数は常に true を返します。 通常、EffectTargetFilter は一方のフィルタのみを使用し、両方は使用しません。

パラメータ

propChanges:Array — PropertyChanges オブジェクトの配列を表します。各 PropertyChanges オブジェクトの target プロパティは、エフェクトのターゲットと等しくなります。ターゲットのプロパティがトランジションによって変更されない場合、対応する PropertyChanges オブジェクトはこの配列に含まれません。
 
semanticsProvider:IEffectTargetHost — ターゲットの requiredSemantics で指定されたプロパティの評価に使用される IEffectTargetHost。通常、エフェクトの effectTargetHost です。アイテム変更エフェクトの場合、エフェクトのターゲットがアイテムレンダラーのときは、アイテムレンダラーを含む List または TileList になります。
 
target:Object — この関数を呼び出す EffectInstance のターゲットを表します。 エフェクトに複数のターゲットが含まれる場合、関数はターゲットごとに 1 度だけ呼び出されます。

戻り値
Boolean — ターゲットをエフェクトに含める必要がある場合は true、それ以外の場合は false を返します。




 

 

このページに新しいコメントが追加された場合に、電子メールでの通知を希望する。 | コメントレポート

現在のページ: http://livedocs.adobe.com/flex/3_jp/langref/mx/effects/EffectTargetFilter.html