Package | mx.effects |
Classe | public class EffectTargetFilter |
Héritage | EffectTargetFilter Object |
Sous-classes | AddRemoveEffectTargetFilter, HideShowEffectTargetFilter |
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
La classe EffectTargetFilter définit une méthode defaultFilterFunction()
qui utilise les propriétés filterProperties
et filterStyles
pour déterminer s’il faut exécuter l’effet sur chaque cible.
Vous pouvez également définir un filtre personnalisé pour implémenter votre propre logique de filtrage. Pour ce faire, définissez votre fonction de filtre, puis spécifiez cette fonction sur un objet EffectTargetFilter à l’aide de la propriété filterFunction
.
Pour configurer un effet à utiliser un filtre personnalisé, transmettez un objet EffectTargetFilter sur la propriété Effect.customFilter
de l’effet.
Propriété | Défini par | ||
---|---|---|---|
constructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet. | Object | ||
filterFunction : Function
Fonction qui définit une logique de filtrage personnalisée. | EffectTargetFilter | ||
filterProperties : Array
Tableau de chaînes spécifiant les propriétés du composant. | EffectTargetFilter | ||
filterStyles : Array
Tableau de chaînes spécifiant les propriétés de style. | EffectTargetFilter | ||
requiredSemantics : Object = null
Un ensemble de propriétés et de valeurs associées doit être associé à une cible pour que l’effet puisse s’exécuter. | EffectTargetFilter |
Méthode | Défini par | ||
---|---|---|---|
Constructeur. | EffectTargetFilter | ||
filterInstance(propChanges:Array, semanticsProvider:mx.effects:IEffectTargetHost, target:Object):Boolean
Détermine si une cible doit être filtrée, renvoyée avec la valeur true si elle doit être incluse dans un effet. | EffectTargetFilter | ||
Indique si la propriété spécifiée d’un objet est définie. | Object | ||
Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l’objet spécifié en tant que paramètre. | Object | ||
Indique si la propriété spécifiée existe et est énumérable. | Object | ||
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle. | Object | ||
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur. | Object | ||
Renvoie la représentation sous forme de chaîne de l’objet spécifié. | Object | ||
Renvoie la valeur primitive de l’objet spécifié. | Object |
Méthode | Défini par | ||
---|---|---|---|
Fonction de filtre par défaut de la classe EffectTargetFilter. | EffectTargetFilter |
filterFunction | propriété |
public var filterFunction:Function
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Fonction qui définit une logique de filtrage personnalisée. Flex appelle cette méthode sur chaque cible de l’effet. Si la fonction renvoie true
, l’effet est lue sur la cible ; si elle renvoie false
, la cible est ignorée par l’effet. Une fonction de filtre personnalisée assure un meilleur contrôle en terme de filtrage que la propriété Effect.filter
.
La fonction de filtre présente la signature suivante :
filterFunc(propChanges:Array, instanceTarget:Object):Boolean { // Return true to play the effect on instanceTarget, // or false to not play the effect. }
où :
propChanges
: tableau d’objets PropertyChanges, un objet par composant cible de l’effet. Si la propriété d’une cible n’est pas modifiée par la transition, elle n’est pas incluse dans ce tableau.
InstanceTarget
: composant cible spécifique de l’effet que vous souhaitez filtrer. Dans la fonction de filtre personnalisée, vous recherchez d’abord le tableau propChanges
de l’objet PropertyChanges qui correspond à l’argument instanceTarget
, en comparant l’argument instanceTarget
avec la propriété propChanges.target
.
Eléments de l’API associés
filterProperties | propriété |
public var filterProperties:Array
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Tableau de chaînes spécifiant les propriétés du composant. Si l’une des propriétés du tableau est modifiée sur le composant cible exécutez l’effet sur la cible.
Si vous définissez une fonction de filtre personnalisée, vous pouvez examiner la propriété filterProperties
à partir de votre fonction.
filterStyles | propriété |
public var filterStyles:Array
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Tableau de chaînes spécifiant les propriétés de style. Si l’une des propriétés du tableau est modifiée sur le composant cible exécutez l’effet sur la cible.
Si vous définissez une fonction de filtre personnalisée, vous pouvez examiner la propriété filterStyles
à partir de votre fonction.
requiredSemantics | propriété |
public var requiredSemantics:Object = null
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Un ensemble de propriétés et de valeurs associées doit être associé à une cible pour que l’effet puisse s’exécuter.
Lorsque vous utilisez des effets de données, vous pouvez utiliser cette propriété pour filtrer les effets. Pour exécuter un effet de données sur toutes les cibles d’un contrôle list qui ne sont pas ajoutées par l’effet, autrement dit les cibles supprimées, remplacées, déplacées ou attribuées de toute autre manière, vous pouvez écrire la définition de l’effet tel qu’indiqué ci-contre :
<mx:Blur> <mx:customFilter> <mx:EffectTargetFilter requiredSemantics="{{'added':false}}"/> </mx:customFilter> </mx:Blur>
Pour lire un effet de données sur toutes les cibles qui ne sont pas ajoutées ou supprimées par l’effet, vous pouvez écrire la définition de l’effet tel qu’indiqué ci-contre :
<mx:Blur> <mx:customFilter> <mx:EffectTargetFilter requiredSemantics="{{'added':false}, {'removed':false}}"/> </mx:customFilter> </mx:Blur>
La liste des propriétés autorisées que vous pouvez spécifier inclut les propriétés added
, removed
, replaced
et replacement
. Les valeurs autorisées pour les propriétés sont true
et false
.
EffectTargetFilter | () | Constructeur |
public function EffectTargetFilter()
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Constructeur.
defaultFilterFunction | () | méthode |
protected function defaultFilterFunction(propChanges:Array, instanceTarget:Object):Boolean
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Fonction du filtre par défaut de la classe EffectTargetFilter. Si l’objet instanceTarget
dispose des valeurs de départ et d’arrivée pour toutes les valeurs spécifiées par les propriétés filterProperties
ou filterStyles
, exécutez l’effet sur la cible.
Paramètres
propChanges:Array — Tableau d’objets PropertyChanges. La propriété target est égale à la cible de l’effet. Si la propriété d’une cible n’est pas modifiée par une transition, l’objet PropertyChanges correspondant n’est pas inclus dans ce tableau.
| |
instanceTarget:Object — Cible de la classe EffectInstance qui appelle cette fonction. Si un effet a plusieurs cibles, cette fonction est appelée une fois par cible.
|
Boolean — Renvoie true pour permettre à l’instance effet d’être exécutée.
|
Eléments de l’API associés
filterInstance | () | méthode |
public function filterInstance(propChanges:Array, semanticsProvider:mx.effects:IEffectTargetHost, target:Object):Boolean
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Détermine si une cible doit être filtrée, renvoyée avec la valeur true si elle doit être incluse dans un effet. La détermination est effectuée en appelant les classes filterFunction et semanticFilterFunction et en renvoyant la valeur true si et uniquement si les deux fonctions renvoient true. Les fonctions par défaut associées aux valeurs par défaut renvoient toujours true. En règle générale, une classe EffectTargetFilter utilise un type de filtre ou un autre type, pas les deux.
Paramètres
propChanges:Array — Tableau d’objets PropertyChanges. La propriété cible de chaque objet PropertyChanges est égale à la cible de l’effet. Si la propriété d’une cible n’est pas modifiée par une transition, l’objet PropertyChanges correspondant n’est pas inclus dans ce tableau.
| |
semanticsProvider:mx.effects:IEffectTargetHost — Classe IEffectTargetHost utilisée pour évaluer les propriétés spécifiées dans l’objet requiredSemantics de la cible, qui est normalement la classe effectTargetHost de l’effet. Pour les effets de modification d’éléments, lorsque les cibles de l’effet sont des rendus d’éléments, il s’agira de la propriété List ou TileList contenant les rendus d’éléments.
| |
target:Object — Cible de la classe EffectInstance qui appelle cette fonction. Si un effet a plusieurs cibles, cette fonction est appelée une fois par cible.
|
Boolean — true si la cible doit être incluse dans l’effet ; false le cas contraire.
|
Tue Jun 12 2018, 09:30 AM Z