TweenEffect

Package	mx.effects
Classe	public class TweenEffect
Héritage	TweenEffect Effect EventDispatcher Object
Sous-classes	AnimateProperty, Blur, Dissolve, Fade, Glow, Move, Pause, Resize, Rotate, SeriesEffect, Zoom

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

A partir de Flex 4.0, Adobe vous recommande d’utiliser la classe spark.effects.Animate comme alternative à cette classe.

TweenEffect est la super-classe de tous les effets animés dans Flex 3. A partir de Flex 4, les effets Spark étendent la classe spark.effects.Animate au lieu de TweenEffect.

La classe TweenEffect est la super-classe de tous les effets basés sur l’objet Tween. Cette classe encapsule les méthodes et les propriétés communes entre tous les effets Tween, pour éviter la duplication du code ailleurs.

Vous créez une sous-classe de la classe TweenEffect pour définir un effet exécutant une animation pendant une période de temps. Par exemple, l’effet Resize modifie la taille de sa cible sur une durée spécifiée.

Syntaxe MXML expanded

Masquer la syntaxe MXML

The <mx:TweenEffect> tag inherits all of the tag attributes of its superclass, and adds the following tag attributes:

  <mx:TagName
    Properties
    easingFunction="easing function name; no default"
     
    Events
    tweenEnd="No default"
  />

Consulter les exemples

Eléments de l’API associés

mx.effects.Tween
mx.effects.effectClasses.TweenEffectInstance

Propriétés publiques

Masquer les propriétés publiques héritées

Afficher les propriétés publiques héritées

	Propriété		Défini par
		className : String [lecture seule] Le nom de la classe d’effet, tel que « Fade ».	Effect
		constructor : Object Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.	Object
		customFilter : mx.effects:EffectTargetFilter Spécifie un objet filtre personnalisé, de type EffectTargetFilter, utilisé par l’effet pour déterminer les cibles sur lequel lire l’effet.	Effect
		duration : Number Durée de l’effet en millisecondes.	Effect
		easingFunction : Function = null Fonction d’accélération pour l’animation.	TweenEffect
		effectTargetHost : mx.effects:IEffectTargetHost Propriété qui permet d’accéder au contrôle à base de liste de la cible d’un effet data.	Effect
		filter : String Spécifie un algorithme de filtrage des cibles d’un effet.	Effect
		hideFocusRing : Boolean Détermine si l’effet doit masquer l’anneau de focus lors du démarrage.	Effect
		instanceClass : Class Objet de type Class qui spécifie la classe de l’instance d’effet de cette classe d’effets.	Effect
		isPlaying : Boolean [lecture seule] 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.	Effect
		perElementOffset : Number Autre délai, en millisecondes, pour les cibles d’effet suivant la première cible de l’effet.	Effect
		playheadTime : Number Temps de position actuelle de l’effet.	Effect
		relevantProperties : Array Tableau de noms de propriété à utiliser pour effectuer le filtrage.	Effect
		relevantStyles : Array Tableau des noms de style à utiliser pour effectuer le filtrage.	Effect
		repeatCount : int = 1 Nombre de fois que l’effet doit être répété.	Effect
		repeatDelay : int = 0 Intervalle (en millisecondes), qui s’écoule avant de répéter l’effet.	Effect
		startDelay : int = 0 Intervalle (en millisecondes), qui s’écoule avant de commencer l’effet.	Effect
		suspendBackgroundProcessing : Boolean = false Si la valeur est true, elle bloque tout le traitement en arrière-plan pendant l’exécution de l’effet.	Effect
		target : Object Objet auquel s’applique cet effet.	Effect
		targets : Array Tableau d’objets représentant des cibles de l’effet.	Effect
		triggerEvent : Event Objet Evénement transmis à cet Effet par le gestionnaire EffectManager lorsqu’un effet est déclenché, ou nul si l’effet n’est pas exécuté par le gestionnaire EffectManager.	Effect

Propriétés protégées

Masquer les propriétés protégées héritées

Afficher les propriétés protégées héritées

	Propriété		Défini par
		applyTransitionEndProperties : Boolean Cet indicateur contrôle si l’effet, lorsqu’il est exécuté dans une transition, applique automatiquement les valeurs de propriété conformément à l’état d’arrivée, au lieu de conserver ces valeurs comme l’a défini l’effet lui-même.	Effect
		endValuesCaptured : Boolean = false Drapeau contenant la valeur true si les valeurs d’arrivée d’un effet ont déjà été déterminées, ou false si elles doivent être acquises à partir des propriétés actuelles des cibles de l’effet lorsque l’effet s’exécute.	Effect

Méthodes publiques

Masquer les méthodes publiques héritées

Afficher les méthodes publiques héritées

	Méthode		Défini par
		TweenEffect(target:Object = null) Constructeur.	TweenEffect
		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
		captureEndValues():void 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.	Effect
		captureMoreStartValues(targets:Array):void 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é.	Effect
		captureStartValues():void Capture les valeurs actuelles des propriétés correspondantes sur les cibles de l’effet.	Effect
		createInstance(target:Object = null):IEffectInstance Crée une seule instance d’effet et l’initialise.	Effect
		createInstances(targets:Array = null):Array Prend un tableau d’objets cible et invoque la méthode createInstance() sur chaque cible.	Effect
		deleteInstance(instance:IEffectInstance):void Supprime les écouteurs d’événement d’une instance et les retire de la liste d’instances.	Effect
		dispatchEvent(event:Event):Boolean Distribue un événement dans le flux d’événements.	EventDispatcher
		end(effectInstance:IEffectInstance = null):void Interrompt un effet en cours de lecture et passe immédiatement à la fin de l’effet.	Effect
		getAffectedProperties():Array Renvoie un tableau de chaînes, où chaque chaîne correspond au nom d’une propriété modifiée par cet effet.	Effect
		hasEventListener(type:String):Boolean Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indique si la propriété spécifiée d’un objet est définie.	Object
		isPrototypeOf(theClass:Object):Boolean 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
		pause():void Interrompt momentanément l’effet jusqu’à un appel de la méthode resume().	Effect
		play(targets:Array = null, playReversedFromEnd:Boolean = false):Array Commence la lecture de l’effet.	Effect
		propertyIsEnumerable(name:String):Boolean Indique si la propriété spécifiée existe et est énumérable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Supprime un écouteur de l’objet EventDispatcher.	EventDispatcher
		resume():void Reprend l’effet après une interruption demandée par un appel de la méthode pause().	Effect
		reverse():void Exécute l’effet en sens inverse, si l’effet est en cours de lecture, à partir de sa position actuelle.	Effect
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.	Object
		stop():void Arrête l’effet, en laissant les cibles de l’effet dans leur état actuel.	Effect
		toLocaleString():String Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur.	Object
		toString():String Renvoie la représentation sous forme de chaîne de l’objet spécifié.	Object
		valueOf():Object Renvoie la valeur primitive de l’objet spécifié.	Object
		willTrigger(type:String):Boolean 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

Méthodes protégées

Masquer les méthodes protégées héritées

Afficher les méthodes protégées héritées

	Méthode		Défini par
		applyValueToTarget(target:Object, property:String, value:*, props:Object):void Utilisée en interne par l’infrastructure Effect.	Effect
		effectEndHandler(event:EffectEvent):void Appelée à la fin de la lecture d’une instance d’effet.	Effect
		effectStartHandler(event:EffectEvent):void Cette méthode est appelée lorsque l’instance d’effet commence.	Effect
		effectStopHandler(event:EffectEvent):void Appelée lorsqu’une instance d’effet a été interrompue par un appel de la méthode stop().	Effect
		filterInstance(propChanges:Array, target:Object):Boolean Détermine la logique de filtrage d’une instance d’effet.	Effect
		getValueFromTarget(target:Object, property:String):* Appelée par la méthode captureStartValues() pour obtenir la valeur d’une propriété à partir de la cible.	Effect
		initInstance(instance:IEffectInstance):void Copie les propriétés de l’effet vers l’instance d’effet.	Effect
		tweenEventHandler(event:mx.events:TweenEvent):void Appelée lorsque l’objet TweenEffect distribue l’objet TweenEvent.	TweenEffect

Evénements

Cliquez pour plus d’informations sur les événements

Masquer les événements hérités

Afficher les événements hérités

	Synthèse	Défini par
activate	[Evénement de diffusion] Distribué lorsque l’application Flash Player obtient le focus du système d’exploitation et devient active.	EventDispatcher
deactivate	[Evénement de diffusion] Distribué lorsque l’application Flash Player ou AIR perd le focus du système d’exploitation et devient inactive.	EventDispatcher
effectEnd	Distribué lorsque la lecture de l’une des instances de l’effet s’arrête, soit lorsque la lecture de l’instance s’arrête, soit lorsque l’effet est interrompu par un appel de la méthode end().	Effect
effectStart	Diffusé lorsque l’exécution de l’effet commence.	Effect
effectStop	Distribué lorsque l’effet a été interrompu, ce qui se produit uniquement lorsque l’effet est interrompu par un appel de la méthode stop().	Effect
tweenEnd	Envoyé lorsque l’effet Tween s’arrête.	TweenEffect
tweenStart	Envoyé lorsque l’effet tween commence, ce qui correspond au premier appel de la méthode onTweenUpdate().	TweenEffect
tweenUpdate	Envoyé chaque fois que l’effet tween met à jour la cible.	TweenEffect

Détails de la propriété

easingFunction

propriété

public var easingFunction:Function = null

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Fonction d’accélération pour l’animation. La fonction d’accélération est utilisée pour interpoler entre la valeur initiale et la valeur finale. Une fonction d’accélération banale effectue une simple interpolation linéaire, mais des fonctions d’accélération plus sophistiquées créent l’illusion d’accélération et de décélération qui rend l’animation plus naturelle.

Si aucune fonction d’accélération n’est spécifiée, une fonction d’accélération basée sur la méthode Math.sin() est utilisée.

La fonction d’accélération suit la signature de fonction popularisée par Robert Penner. Cette fonction accepte quatre arguments. Le premier argument est l’« heure actuelle », où l’heure de début de l’animation est 0. Le second argument est la valeur de départ au début de l’animation (nombre). Le troisième argument est la valeur d’arrêt moins la valeur initiale. La quatrième argument est la durée de l’animation. La valeur de retour est la valeur interpolée de l’heure actuelle. Il s’agit généralement d’une valeur comprise entre la valeur de départ et la valeur d’arrivée.

La valeur de cette propriété doit être un objet Function.

Flex inclut un jeu de fonctions d’accélération dans le package mx.effects.easing.

Détails du constructeur

()

Constructeur

public function TweenEffect(target: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

Constructeur.

Paramètres

target:Object (default = null) — Objet à animer à l’aide de cet effet.

Détails de la méthode

tweenEventHandler

()

méthode

protected function tweenEventHandler(event:mx.events:TweenEvent):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 lorsque l’objet TweenEffect distribue l’objet TweenEvent. Si vous remplacez cette méthode, prenez soin d’appeler la méthode super.

Paramètres

event:mx.events:TweenEvent — Objet d’événement de type TweenEvent.

Détails de l’événement

tweenEnd

Evénement

Type d’objet d’événement: mx.events.TweenEvent
propriété TweenEvent.type = mx.events.TweenEvent.TWEEN_END

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Envoyé lorsque l’effet Tween s’arrête. Cet événement correspond à un appel de la méthode TweenEffectInstance.onTweenEnd().

Lorsqu’un effet tween s’exécute une seule fois, cet événement se produit au même moment qu’un événement effectEnd. Si vous configurez l’effet tween sur une répétition, il se produit à la fin de chaque répétition de l’effet et l’événement endEffect se produit dès que l’effet est exécuté pour la dernière fois.

La constante TweenEvent.TWEEN_END définit la valeur de la propriété type de l’objet d’événement d’un événement tweenEnd.

Les valeurs des propriétés de l’objet d’événement sont les suivantes :

Propriété	Valeur
`bubbles`	false
`cancelable`	false
`currentTarget`	Objet définissant l’écouteur d’événement qui traite l’événement. Par exemple, si vous utilisez `myButton.addEventListener()` pour enregistrer un écouteur d’événement, myButton est la valeur de `currentTarget`.
`target`	Objet qui a distribué l’événement (il ne s’agit pas toujours de l’objet qui écoute l’événement). Pour accéder systématiquement à l’objet qui écoute l’événement, utilisez la propriété `currentTarget`.
`value`	Valeur transmise à la méthode `onTweenEnd`.

tweenStart

Evénement

Type d’objet d’événement: mx.events.TweenEvent
propriété TweenEvent.type = mx.events.TweenEvent.TWEEN_START

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Envoyé lorsque l’effet tween commence, ce qui correspond au premier appel de la méthode onTweenUpdate(). Flex envoie également le premier événement tweenUpdate de l’effet au même moment.

L’événement Effect.effectStart est envoyé avant l’événement tweenStart.

La constante TweenEvent.TWEEN_START définit la valeur de la propriété type de l’objet d’événement d’un événement tweenStart.

Les valeurs des propriétés de l’objet d’événement sont les suivantes :

Propriété	Valeur
`bubbles`	false
`cancelable`	false
`currentTarget`	Objet définissant l’écouteur d’événement qui traite l’événement. Par exemple, si vous utilisez `myButton.addEventListener()` pour enregistrer un écouteur d’événement, myButton est la valeur de `currentTarget`.
`target`	Objet qui a distribué l’événement (il ne s’agit pas toujours de l’objet qui écoute l’événement). Pour accéder systématiquement à l’objet qui écoute l’événement, utilisez la propriété `currentTarget`.
`value`	Valeur transmise à la méthode `onTweenUpdate()`.

tweenUpdate

Evénement

Type d’objet d’événement: mx.events.TweenEvent
propriété TweenEvent.type = mx.events.TweenEvent.TWEEN_UPDATE

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Envoyé chaque fois que l’effet tween met à jour la cible. Cet événement correspond à un appel de la méthode TweenEffectInstance.onTweenUpdate().

La constante TweenEvent.TWEEN_UPDATE définit la valeur de la propriété type de l’objet d’événement d’un événement tweenUpdate.

Les valeurs des propriétés de l’objet d’événement sont les suivantes :

Propriété	Valeur
`bubbles`	false
`cancelable`	false
`currentTarget`	Objet définissant l’écouteur d’événement qui traite l’événement. Par exemple, si vous utilisez `myButton.addEventListener()` pour enregistrer un écouteur d’événement, myButton est la valeur de `currentTarget`.
`target`	Objet qui a distribué l’événement (il ne s’agit pas toujours de l’objet qui écoute l’événement). Pour accéder systématiquement à l’objet qui écoute l’événement, utilisez la propriété `currentTarget`.
`value`	Valeur transmise à la méthode `onTweenUpdate()`.

Exemples Comment utiliser cet exemple

SimpleTweenEffectExample.mxml

<?xml version="1.0"?>
<!-- Simple example to demonstrate the TweenEffect class. -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
        xmlns:s="library://ns.adobe.com/flex/spark"
        xmlns:mx="library://ns.adobe.com/flex/mx">

    <fx:Script>
        <![CDATA[

            import mx.events.TweenEvent;

            // Event handler for the tweenUpdate and tweenEnd effects.
            private function tweenUpdateHandler(event:TweenEvent):void {
                // Access current width of the image.
                currentWidth.text="Current width (in pixels): " + String(event.value[0]);
            }

            // Event handler for the reset button.
            private function resetHandler():void {
                expand.end();
                img.width=30;
                currentWidth.text="Current width (in pixels): 30";
                img.height=60;
                button1.enabled=true;
            }
        ]]>
    </fx:Script>
    <fx:Declarations>
        <mx:Resize id="expand" target="{img}" widthTo="100" heightTo="200"
            duration="10000"
            tweenUpdate="tweenUpdateHandler(event);"
            tweenEnd="tweenUpdateHandler(event);"/>
    </fx:Declarations>

    <s:Panel title="Resize Effect Example" width="100%" height="100%" >
        <s:VGroup left="20" right="20" top="20" bottom="20">

            <s:Label width="100%" color="blue"
                text="Use the Button controls to resize the image."/>

            <s:HGroup width="100%">
                <mx:Image id="img" width="30" height="60"
                    source="@Embed(source='assets/Nokia_6630.png')"/>
                <s:Label id="currentWidth" height="20" width="100%"/>
            </s:HGroup>

            <s:Button id="button1" label="Start" click="expand.play(); button1.enabled=false;"/>
            <s:Button label="Pause" click="expand.pause();"/>
            <s:Button label="Resume" click="expand.resume();"/>
            <s:Button label="Reverse" click="expand.reverse();"/>
            <s:Button label="End" click="expand.end();"/>
            <s:Button label="Reset" click="resetHandler();"/>
        </s:VGroup>

    </s:Panel>
</s:Application>

Informations juridiques | Politique de confidentialité en ligne

TweenEffect - AS3 Flex

Packagesx

Eléments du langage

Annexes

Package mx.effects

easingFunction

TweenEffect

tweenEventHandler

tweenEnd

tweenStart

tweenUpdate