WipeRight

Package	mx.effects
Classe	public class WipeRight
Héritage	WipeRight MaskEffect Effect EventDispatcher Object

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.Wipe comme alternative à cette classe.

Les effets Wipe spécifiques à la direction dans Flex 3 ont été remplacés par un effet Wipe plus générique qui prend une direction générique. Pour obtenir un comportement similaire à partir du nouvel effet Wipe, définissez le paramètre de direction de manière appropriée.

La classe WipeRight définit un effet de balayage vers la droite. L’état de départ ou d’arrivée du composant doit être invisible.

Utilisez souvent cet effet avec les déclencheurs showEffect et hideEffect. Le déclencheur showEffect se produit lorsqu’un composant devient visible, en faisant passer sa propriété visible de false à true. Le déclencheur hideEffect se produit lorsqu’un composant devient visible en modifiant sa propriété visible detrue à false.

Cet effet hérite de la propriété MaskEffect.show. Si vous définissez la valeur sur true, le composant apparaît. Si vous définissez la valeur sur false, le composant disparaît. La valeur par défaut est true.

Si vous spécifiez cet effet pour un ou déclencheur showEffect ou hideEffect, Flex définit la propriété show à votre place, soit sur true si le composant devient invisible, ou sur false si le composant devient visible.

Syntaxe MXML expanded

Masquer la syntaxe MXML

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

  <mx:WipeRight
    id="ID"
  />

Consulter les exemples

Eléments de l’API associés

mx.effects.effectClasses.WipeRightInstance

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
		createMaskFunction : Function Fonction appelée lorsque l’effet crée le masque.	MaskEffect
		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
		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
		moveEasingFunction : Function Fonction d’accélération à utiliser pour déplacer le masque.	MaskEffect
		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
		scaleEasingFunction : Function Fonction d’accélération à utiliser pour la mise à l’échelle du masque.	MaskEffect
		scaleXFrom : Number Propriété scaleX initiale du masque.	MaskEffect
		scaleXTo : Number Propriété scaleX d’arrivée du masque.	MaskEffect
		scaleYFrom : Number Propriété scaleY de départ du masque.	MaskEffect
		scaleYTo : Number Propriété scaleY d’arrivée du masque.	MaskEffect
		showTarget : Boolean Spécifie que le composant cible devient visible, true, invisible ou false.	MaskEffect
		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
		xFrom : Number Coordonnée x de la position de départ du masque.	MaskEffect
		xTo : Number Coordonnée x de la position d’arrivée du masque.	MaskEffect
		yFrom : Number Coordonnée y de la position de départ du masque.	MaskEffect
		yTo : Number Coordonnée y de la position d’arrivée du masque.	MaskEffect

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
		WipeRight(target:Object = null) Constructeur.	WipeRight
		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 [override] Renvoie les propriétés du composant modifiées par cet effet.	MaskEffect
		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.	MaskEffect

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	Distribué à la fin de l’effet.	MaskEffect
tweenStart	Distribué au début de l’effet, ce qui correspond au premier appel des méthodes onMoveTweenUpdate() et onScaleTweenUpdate().	MaskEffect
tweenUpdate	Distribué chaque fois que l’effet met à jour la cible.	MaskEffect

Détails du constructeur

()

Constructeur

public function WipeRight(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.

Exemples Comment utiliser cet exemple

WipeRightExample.mxml

<?xml version="1.0"?>
<!-- Simple example to demonstrate the WipeRight effect. -->
<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:Declarations>
        <mx:WipeRight id="wipeOut" duration="1000"/>
        <mx:WipeRight id="wipeIn" duration="1000"/>
    </fx:Declarations>

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

            <s:Label width="100%" color="blue"
                text="Use the WipeRight effect to show or hide the text and image."/>

            <mx:Label text="Nokia 9930"
                fontSize="14"
                visible="{cb1.selected}"
                hideEffect="{wipeOut}" showEffect="{wipeIn}"/>

            <mx:Image source="@Embed(source='assets/Nokia_6630.png')"
                visible="{cb1.selected}"
                hideEffect="{wipeOut}" showEffect="{wipeIn}"/>

            <s:CheckBox id="cb1" label="visible" selected="true"/>
        </s:VGroup>

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

Informations juridiques | Politique de confidentialité en ligne

WipeRight - AS3 Flex

Classes x

WipeRight