Package | mx.effects |
Classe | public class EffectInstance |
Héritage | EffectInstance EventDispatcher Object |
Implémente | IEffectInstance |
Sous-classes | ActionEffectInstance, AnimateInstance, CompositeEffectInstance, MaskEffectInstance, SoundEffectInstance, TweenEffectInstance |
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Les développeurs d’effets doivent créer une classe d’instances pour leurs effets personnalisés.
Eléments de l’API associés
Propriété | Défini par | ||
---|---|---|---|
className : String [lecture seule]
Nom de la classe d’effet, tel que « FadeInstance ». | EffectInstance | ||
constructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet. | Object | ||
duration : Number
Durée de l’effet, en millisecondes. | EffectInstance | ||
effect : IEffect
Objet IEffect qui a créé cet objet IEffectInstance. | EffectInstance | ||
effectTargetHost : mx.effects:IEffectTargetHost
Propriété qui permet d’accéder au contrôle à base de liste de la cible d’un effet data. | EffectInstance | ||
hideFocusRing : Boolean
Détermine si l’effet doit masquer l’anneau de focus lors du démarrage. | EffectInstance | ||
playheadTime : Number
Temps de position actuelle de l’effet. | EffectInstance | ||
propertyChanges : PropertyChanges
Spécifie l’objet PropertyChanges contenant les valeurs de départ et d’arrivée de l’ensemble des propriétés correspondant aux cibles de l’effet. | EffectInstance | ||
repeatCount : int
Nombre de fois que l’effet doit être répété. | EffectInstance | ||
repeatDelay : int
Intervalle (en millisecondes), qui s’écoule avant de répéter l’effet. | EffectInstance | ||
startDelay : int
Intervalle (en millisecondes), qui s’écoule avant de commencer l’effet. | EffectInstance | ||
suspendBackgroundProcessing : Boolean
Si la valeur est true, elle bloque tout le traitement en arrière-plan pendant l’exécution de l’effet. | EffectInstance | ||
target : Object
Objet UIComponent sur lequel cet effet est appliqué. | EffectInstance | ||
triggerEvent : Event
L’événement, le cas échéant, qui a déclenché la lecture de l’effet. | EffectInstance |
Propriété | Défini par | ||
---|---|---|---|
playCount : int = 0
Nombre de fois que l’instance a été exécutée. | EffectInstance |
Méthode | Défini par | ||
---|---|---|---|
EffectInstance(target:Object)
Constructeur. | EffectInstance | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Enregistre un objet écouteur d’événement auprès d’un objet EventDispatcher afin que l’écouteur soit averti d’un événement. | EventDispatcher | ||
Distribue un événement dans le flux d’événements. | EventDispatcher | ||
Interrompt une instance d’effet en cours de lecture et passe immédiatement à la fin de l’effet. | EffectInstance | ||
Appelée par la méthode end() à la fin de la lecture de l’effet. | EffectInstance | ||
Appelé à la fin de la lecture de chaque itération d’un effet répété. | EffectInstance | ||
Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement. | EventDispatcher | ||
Indique si la propriété spécifiée d’un objet est définie. | Object | ||
Cette méthode est appelée si l’effet a été déclenché par le gestionnaire EffectManager. | EffectInstance | ||
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 | ||
Interrompt momentanément l’effet jusqu’à un appel de la méthode resume(). | EffectInstance | ||
Exécute l’instance d’effet sur la cible. | EffectInstance | ||
Indique si la propriété spécifiée existe et est énumérable. | Object | ||
Supprime un écouteur de l’objet EventDispatcher. | EventDispatcher | ||
Reprend l’effet après une interruption demandée par un appel de la méthode pause(). | EffectInstance | ||
Exécute l’effet en sens inverse, à partir de sa position actuelle. | EffectInstance | ||
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle. | Object | ||
Exécute l’instance d’effet sur la cible, au terme de la période startDelay. | EffectInstance | ||
Arrête l’effet, en laissant la cible dans son état actuel. | EffectInstance | ||
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 | ||
Vérifie si un écouteur d’événement est enregistré auprès de cet objet EventDispatcher ou de ses ancêtres pour le type d’événement spécifié. | EventDispatcher |
className | propriété |
className:String
[lecture seule] Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Nom de la classe d’effet, tel que "FadeInstance"
.
Il s’agit d’un nom de classe court ou « incomplet » qui n’inclut pas le nom du package. Pour obtenir le nom complet, utilisez la méthode getQualifiedClassName()
du package flash.utils.
Implémentation
public function get className():String
duration | propriété |
effect | propriété |
effectTargetHost | propriété |
effectTargetHost:mx.effects:IEffectTargetHost
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
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é.
Implémentation
public function get effectTargetHost():mx.effects:IEffectTargetHost
public function set effectTargetHost(value:mx.effects:IEffectTargetHost):void
hideFocusRing | propriété |
hideFocusRing: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 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 la cible de l’effet n’est pas une sous-classe de la classe UIComponent, vous devez y ajouter 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
.
Implémentation
public function get hideFocusRing():Boolean
public function set hideFocusRing(value:Boolean):void
playCount | propriété |
protected var playCount:int = 0
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Nombre de fois que l’instance a été exécutée.
playheadTime | propriété |
playheadTime:Number
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
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.
Implémentation
public function get playheadTime():Number
public function set playheadTime(value:Number):void
propertyChanges | propriété |
propertyChanges:PropertyChanges
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Spécifie l’objet PropertyChanges contenant les valeurs de départ et d’arrivée de l’ensemble des propriétés correspondant aux cibles de l’effet. Cette propriété est définie uniquement si la méthode captureStartValues()
a été appelée sur l’effet qui a créé cette instance d’effet.
Utilisez souvent la propriété propertyChanges
pour créer un effet utilisé dans le cadre d’une transition. Flex appelle automatiquement la méthode captureStartValues()
lorsqu’elle commence une transition. Dans le cadre du remplacement de la méthode EffectInstance.play()
, vous pouvez examiner les informations de la méthode propertyChanges()
pour initialiser les valeurs de départ et d’arrivée de l’effet.
Implémentation
public function get propertyChanges():PropertyChanges
public function set propertyChanges(value:PropertyChanges):void
repeatCount | propriété |
repeatCount:int
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Nombre de fois que l’effet doit être répété. Les valeurs possibles sont tout entier supérieur ou égal à 0.
Implémentation
public function get repeatCount():int
public function set repeatCount(value:int):void
repeatDelay | propriété |
repeatDelay:int
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Intervalle (en millisecondes), qui s’écoule avant de répéter l’effet.
Implémentation
public function get repeatDelay():int
public function set repeatDelay(value:int):void
startDelay | propriété |
startDelay:int
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Intervalle (en millisecondes), qui s’écoule avant de commencer l’effet. Les valeurs possibles sont tout entier supérieur ou égal à 0. Si l’effet est répété à l’aide de la propriété repeatCount
, la propriété startDelay
est appliquée uniquement la première fois que l’effet est exécuté.
Implémentation
public function get startDelay():int
public function set startDelay(value:int):void
suspendBackgroundProcessing | propriété |
suspendBackgroundProcessing:Boolean
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Si la valeur est true
, elle bloque l’ensemble du traitement en arrière-plan pendant que l’effet est exécuté. Le traitement en arrière-plan inclut le mesurage, la mise en forme et le traitement des réponses arrivées en provenance du serveur.
Implémentation
public function get suspendBackgroundProcessing():Boolean
public function set suspendBackgroundProcessing(value:Boolean):void
target | propriété |
triggerEvent | propriété |
triggerEvent:Event
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
L’événement, le cas échéant, qui a déclenché la lecture de l’effet. Cette propriété est utile lorsqu’un effet est attribué à plusieurs événements de déclenchement.
Si l’effet a été exécuté par programmation en appelant la méthode play()
, au lieu d’être déclenché par un événement, cette propriété est nulle
.
Implémentation
public function get triggerEvent():Event
public function set triggerEvent(value:Event):void
EffectInstance | () | Constructeur |
end | () | méthode |
public function end():void
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Interrompt une instance d’effet en cours de lecture et passe immédiatement à la fin de l’effet. Cette méthode est invoquée par le biais d’un appel de la méthode Effect.end()
. Dans le cadre de l’implémentation, elle appelle la méthode finishEffect()
.
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.
Dans une sous-classe EffectInstance, vous pouvez éventuellement annuler cette méthode. Dans le cadre du remplacement, il est conseillé d’appeler la méthode super.end()
à partir de la fin de votre remplacement, à la suite de votre logique.
finishEffect | () | méthode |
public function finishEffect():void
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Appelée par la méthode end()
à la fin de la lecture de l’effet. Cette fonction distribue un événement endEffect
pour la cible de l’effet.
Il n’est pas nécessaire de remplacer cette méthode dans une sous-classe. Il est inutile d’appeler cette méthode lors de l’utilisation d’effets, mais il se pourrait que vous l’appelez si vous créez une sous-classe d’effets.
finishRepeat | () | méthode |
public function finishRepeat():void
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Appelé à la fin de la lecture de chaque itération d’un effet répété.
Il n’est pas nécessaire de remplacer cette méthode dans une sous-classe. Il est inutile d’appeler cette méthode lors de l’utilisation d’effets.
initEffect | () | méthode |
public function initEffect(event:Event):void
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Cette méthode est appelée si l’effet a été déclenché par EffectManager. Cette version de classe de base enregistre l’événement qui a déclenché l’effet dans la propriété triggerEvent.
. Chaque sous-classe doit remplacer cette méthode.
Paramètres
event:Event — Objet événement envoyé pour déclencher l’effet. Par exemple, si le déclencheur était une classe mouseDownEffect, l’événement serait un objet MouseEvent de type égal à MouseEvent.MOUSEDOWN.
|
pause | () | méthode |
public function pause():void
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Interrompt momentanément l’effet jusqu’à un appel de la méthode resume()
.
play | () | méthode |
public function play():void
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Exécute l’instance d’effet sur la cible. Appelez plutôt la méthode startEffect()
pour lancer la lecture d’un effet dans une classe EffectInstance.
Dans une sous-classe EffectInstance, vous devez remplacer cette méthode. Le remplacement doit appeler la méthode super.play()
de façon à ce que l’événement effetStart
est envoyé à partir de la cible.
resume | () | méthode |
public function resume():void
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Reprend l’effet après une interruption demandée par un appel de la méthode pause()
.
reverse | () | méthode |
public function reverse():void
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Exécute l’effet en sens inverse, à partir de sa position actuelle.
startEffect | () | méthode |
public function startEffect():void
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Exécute l’instance d’effet sur la cible, au terme de la période startDelay
. Appelée par la classe d’effet. Utilisez cette fonction au lieu de la méthode play()
lorsque vous commencer une classe EffectInstance.
stop | () | méthode |
public function stop():void
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Arrête l’effet, en laissant la cible dans son état actuel. Cette méthode est invoquée par le biais d’un appel de la méthode Effect.stop()
. Dans le cadre de l’implémentation, elle appelle la méthode finishEffect()
.
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.
Tue Jun 12 2018, 09:30 AM Z