A function that defines custom filter logic. Flex calls this method on every target of the effect. If the function returns true, the effect plays on the target; if it returns false, the target is skipped by the effect. A custom filter function gives you greater control over filtering than the Effect.filter property.

The filter function has the following signature:

      filterFunc(propChanges:Array, instanceTarget:Object):Boolean
      {
          // Return true to play the effect on instanceTarget, 
          // or false to not play the effect.
      } 
      

where:

propChanges - An Array of PropertyChanges objects, one object per target component of the effect. If a property of a target is not modified by the transition, it is not included in this Array.

instanceTarget - The specific target component of the effect that you want to filter. Within the custom filter function, you first search the propChanges Array for the PropertyChanges object that matches the instanceTarget argument by comparing the instanceTarget argument to the propChanges.target property.

See also

An Array of Strings specifying component properties. If any of the properties in the Array changed on the target component, play the effect on the target.

If you define a custom filter function, you can examine the filterProperties property from within your function.

An Array of Strings specifying style properties. If any of the style properties in the Array changed on the target component, play the effect on the target.

If you define a custom filter function, you can examine the filterStyles property from within your function.

A collection of properties and associated values which must be associated with a target for the effect to be played.

When working with data effects, you can use this property to filter effects. If you want to play a data effect on all targets of a list control that are not added by the effect, meaning targets that is removed, replaced, moved, or affected in any other way, you can write the effect definition as shown below:

      <mx:Blur>
          <mx:customFilter>
              <mx:EffectTargetFilter requiredSemantics="{{'added':false}}"/>
          </mx:customFilter>
      </mx:Blur> 

To play a data effect on all targets that are not added or not removed by the effect, you can write the effect definition as shown below:

      <mx:Blur>
          <mx:customFilter>
              <mx:EffectTargetFilter requiredSemantics="{{'added':false}, {'removed':false}}"/>
          </mx:customFilter>
      </mx:Blur>

The allowed list of properties that you can specify includes added, removed, replaced, and replacement. The allowed values for the properties are true and false.

Constructor.

The default filter function for the EffectTargetFilter class. If the instanceTarget has different start and end values for any of the values specified by the filterProperties or filterStyles properties, play the effect on the target.

Parameters

See also

Determines whether a target should be filtered, returning true if it should be included in an effect. The determination is made by calling filterFunction and semanticFilterFunction, returning true if and only if both functions return true. The default functions with the default values will always return true. Typically, an EffectTargetFilter will use one type of filter or the other, but not both.

Parameters