IEffect  - AS3 Flex

Le nom de la classe d’effet, tel que "Fade".

Il s’agit d’un nom de classe court, ou incomplet qui ne contient pas le nom du package. Pour obtenir le nom complet, utilisez la méthode getQualifiedClassName() du package flash.utils.

Spécifie un objet filtre personnalisé, de type EffectTargetFilter, utilisé par l’effet pour déterminer les cibles sur lequel lire l’effet.

Le filtrage des cibles est effectué uniquement si vous appelez la méthode captureStartValues() avant d’exécuter l’effet. Flex appelle automatiquement la méthode captureStartValues() lorsque l’effet fait partir d’une transition.

Utilisez la propriété filter pour un filtrage simple. Si la propriété customFilter n’est pas nulle, la propriété filter est ignorée.

La valeur par défaut est null.

Eléments de l’API associés

Durée de l’effet en millisecondes.

Dans un effet Parallel ou Sequence, la propriété duration définit la durée de chaque effet. Par exemple, si la propriété duration d’un effet Sequence est définie sur 3 000, chaque effet dans la séquence prend 3 000 ms pour s’exécuter.

Pour un effet répété, la propriété duration spécifie la durée d’une seule instance de l’effet. Par conséquent, si la propriété duration d’un effet est définie sur 2 000 et la propriété repeatCount est définie sur 3, l’effet prend un total de 6 000 ms (6 secondes) pour s’exécuter.

La valeur par défaut est 500.

Propriété permettant d’accéder au contrôle à base de liste d’un effet data. Cette propriété permet à une instance d’une classe d’effet de communiquer avec le contrôle à base de liste sur lequel l’effet est exécuté.

Spécifie un algorithme de filtrage des cibles d’un effet. Une valeur null spécifie l’absence de filtrage.

Le filtrage des cibles est effectué uniquement si vous appelez la méthode captureStartValues() avant d’exécuter l’effet. Flex appelle automatiquement la méthode captureStartValues() lorsque l’effet fait partir d’une transition, ou d’un effet data d’un contrôle à base de liste.

Utilisez cette propriété pour effectuer un filtrage simple. Utilisez la propriété customFilter pour un filtrage plus complexe. Si la propriété customFilter a une valeur non nulle, elle est ignorée.

Vous pouvez utiliser les valeurs suivantes pour la propriété filter.

• Une valeur "add" exécute l’effet sur les cibles ajoutées en tant qu’enfant dans un conteneur.
• Une valeur "addItem" exécute l’effet sur la fonctionnalité de rendu d’élément pour tous les éléments de liste ajourés à un contrôle List ou TileList.
• Une valeur "hide" exécute l’effet sur des cibles dont la propriété visible a été modifiée de true à false.
• Une valeur "move" exécute l’effet sur une cible qui a modifié ses propriétés x ou y.
• Une valeur "remove" exécute l’effet sur des cibles supprimées en tant qu’enfant d’un conteneur.
• Une valeur "removeItem" exécute l’effet sur la fonctionnalité de rendu d’élément des éléments de liste supprimés d’un contrôle List ou TileList.
• Une valeur "replaceItem" exécute l’effet sur la fonctionnalité de rendu d’élément des éléments de liste remplacés dans un contrôle List ou TileList par un nouvel élément.
• Une valeur "replacementItem" exécute l’effet sur la fonctionnalité de rendu d’élément des éléments de liste ajoutés à un contrôle List ou TileList qui remplace un élément existant.
• Une valeur "resize" exécute l’effet sur des cibles qui ont modifié leur propriétés width ou height.
• Une valeur "show" exécute l’effet sur les cibles dont la propriété visible a été modifiée de false à true.
• Une valeur "" indique l’absence de filtrage.

La valeur par défaut est null.

Détermine si l’effet doit masquer l’anneau de focus lors du démarrage. La cible de l’effet est responsable du masquage de l’anneau de focus. Les sous-classes de la classe UIComponent masquent automatiquement l’anneau de focus. Si l’effet cible n’est pas une sous-classe de la classe UIComponent, ajoutez-y des fonctionnalités pour masquer l’anneau de focus.

Définissez cette propriété sur true pour masquer l’anneau de focus pendant l’effet.

Pour les sous-classes de Effect, la valeur par défaut est false. Pour les sous-classes MaskEffect, la valeur par défaut est true.

Indicateur de lecture seule défini sur true si les instances de l’effet sont en cours de lecture et sur false si aucune instance n’est définie.

Autre délai, en millisecondes, pour les cibles d’effet suivant la première cible de l’effet. Cette valeur est ajoutée à la valeur de la propriété startDelay.

Position temporelle actuelle de l’effet. Cette propriété a une valeur comprise entre 0 et la durée totale, qui inclut les propriétés startDelay, repeatCount et repeatDelay de l’effet.

Tableau de noms de propriété à utiliser pour effectuer le filtrage. Cette propriété est utilisée en interne et ne doit pas être définie par les utilisateurs d’effets.

La valeur par défaut est égale à la valeur du tableau renvoyée par la méthode getAffectedProperties().

Tableau des noms de style à utiliser pour effectuer le filtrage. Cette propriété est utilisée en interne et ne doit pas être définie par les utilisateurs d’effets.

La valeur par défaut est égale à la valeur du tableau renvoyée par la méthode getAffectedProperties().

Objet auquel s’applique cet effet. Lorsque l’effet est déclenché par un déclencheur d’effets, la propriété target est automatiquement définie sur l’objet qui déclenche l’effet.

Tableau d’objets représentant des cibles de l’effet. Lorsque l’effet est en cours de lecture, il effectue l’effet sur chaque cible en parallèle. La définition de la propriété target remplace tous les objets dans ce tableau. Lorsque la propriété targets est définie, la propriété target renvoie le premier élément de ce tableau.

Objet Evénement transmis à cet Effet par le gestionnaire EffectManager lorsqu’un effet est déclenché, ou null si l’effet n’est pas exécuté par le gestionnaire EffectManager.

Capture les valeurs actuelles des propriétés correspondantes sur les cibles de l’effet et les enregistre en tant que valeurs d’arrivée.

Flex appelle automatiquement la méthode captureEndValues() lorsque l’effet fait partir de l’effet de modification de données.

Capture les valeurs actuelles des propriétés correspondantes d’un autre ensemble de cibles.

Flex utilise cette fonction lorsqu’un effet de modifications de données est exécuté.

Paramètres

Capture les valeurs actuelles des propriétés correspondantes sur les cibles de l’effet. Flex appelle automatiquement la méthode captureStartValues() lorsque l’effet fait partir d’une transition.

Utilisez cette fonction lorsque vous souhaitez que l’effet calcule les valeurs de départ et d’arrivée de l’effet. La meilleure façon d’exploiter cette fonction est de l’utiliser selon les étapes suivantes :

1. Appelez la méthode captureStartValues(). L’effet enregistre les valeurs de départ de l’effet.
2. Modifiez les changements apportés aux cibles d’effets, tels que l’ajout/la suppression des enfants, l’altération des propriétés, le changement de l’emplacement ou le changement des dimensions.
3. Appelez la méthode play(). L’effet capture les valeurs d’arrivée. Cette fonction remplit la propriété EffectInstance.propertyChanges pour chaque instance d’effet créée par cet effet. Les développeurs d’effets peuvent utiliser la propriété propertyChanges pour récupérer les valeurs de départ et d’arrivée de leur effet.

Crée une seule instance d’effet et l’initialise. Utilisez cette méthode plutôt que la méthodeplay() pour manipuler les propriétés instance d’effet avant que l’instance d’effet soit exécuté.

L’instance d’effet est créé avec le type spécifié dans la propriété instanceClass. Elle est ensuite initialisée à l’aide de la méthode initInstance(). Si l’instance a été créée par Effectmanager (lorsque l’effet est déclenché par un déclencheur d’effet), l’effet est davantage initialisé par un appel de la méthode EffectInstance.initEffect().

Le fait d’appeler la méthode createInstance() n’exécute pas l’effet. Appelez la méthode startEffect() de l’instance d’effet renvoyée.

Cette fonction est appelée automatiquement par la méthode Effect.play().

Paramètres

Prend un tableau d’objets cible et invoque la méthode createInstance() sur chaque cible.

Paramètres

Supprime les écouteurs d’événement d’une instance et les retire de la liste d’instances.

Paramètres

Interrompt un effet en cours de lecture et passe immédiatement à la fin de l’effet. L’appel de cette méthode invoque la méthode EffectInstance.end().

L’instance d’effet distribue un événement effectEnd lorsque vous appelez cette méthode dans le cadre de l’arrêt de l’effet.

Si vous transmettez une instance d’effet en tant qu’argument, seule cette instance est interrompue. Si aucun argument est transmis, toutes les instances d’effet actuellement générées à partir de l’effet sont interrompues.

Paramètres

Eléments de l’API associés

Renvoie un tableau de chaînes, où chaque chaîne correspond au nom d’une propriété modifiée par cet effet. Par exemple, l’effet Move renvoie un tableau contenant "x" et "y ".

Chaque sous-classe d’Effet doit implémenter cette méthode. La méthode est utilisée par la classe EffectManager pour éviter que deux effets tentent d’animer la même propriété du même objet au même moment.

Interrompt momentanément l’effet jusqu’à un appel de la méthode resume().

Commence la lecture de l’effet. Appelez la méthode end avant d’appeler la méthode play() pour vous assurer que toute instance précédente de l’effet est terminée avant d’en commencer une nouvelle.

Toutes les sous-classes doivent implémenter cette méthode.

Paramètres

Reprend l’effet après une interruption demandée par un appel de la méthode pause().

Exécute l’effet en sens inverse, si l’effet est en cours de lecture, à partir de sa position actuelle.

Arrête l’effet, en laissant les cibles de l’effet dans leur état actuel. Contrairement à un appel de la méthode pause(), vous ne pouvez pas appeler la méthode resume() après avoir appelé la méthode stop(). Vous pouvez cependant appeler la méthode play() pour redémarrer l’effet.

L’instance d’effet distribue un événement effectEnd lorsque vous appelez cette méthode dans le cadre de l’arrêt de l’effet.

Pour les effets de masque, le masque n’est pas supprimé automatiquement lorsque l’effet est arrêté. Exécuter davantage des effets de masque sur la même cible sans supprimer le masque peut produire des résultats inattendus.