Package | mx.effects |
Classe | public class MaskEffect |
Héritage | MaskEffect Effect EventDispatcher Object |
Sous-classes | Iris, WipeDown, WipeLeft, WipeRight, WipeUp |
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Un effet masque utilise une incrustation, appelée masque, pour effectuer l’effet. Par défaut, le masque est un rectangle de taille égale au composant cible.
L’état de départ ou d’arrivée du composant cible d’un effet mask doit être invisible. Cela signifie qu’un effet mask fait toujours s’afficher un composant cible sur l’écran, ou le fait disparaître de l’écran.
Vous pouvez utiliser les propriétés scaleXFrom
, , scaleYFrom
, scaleXTo
et scaleX
pour spécifier la dimension initiale et définitive du masque, où une valeur 1.0 correspond à dimensionner le masque à la taille du composant cible, 2.0 dimensionne le masque sur le double de taille du composant, 0.5 dimensionne le masque à la moitié de la taille du composant, etc. Pour utiliser l’une de ces propriétés, vous devez spécifier toutes les quatre.
Vous pouvez utiliser les propriétés xFrom
, yFrom
, xTo
et yTo
pour spécifier les coordonnées de la position de départ et de la position d’arrivée du masque relativement au composant cible, sachant que (0, 0) correspond à l’angle supérieur gauche de la cible. Pour utiliser l’une de ces propriétés, vous devez spécifier toutes les quatre.
Les coordonnées de la position de départ et de la position d’arrivée du masque varient selon le type d’effet et si la propriété show
est définie sur true
ou false
. Par exemple, pour l’effet WipeLeft avec une valeur show
définie sur false
, les coordonnées de la position de départ du masque sont (0, 0), ce qui correspond à l’angle supérieur gauche de la cible et les coordonnées de la position d’arrivée correspondent à l’angle supérieur droit de la cible (largeur, 0) où largeur renvoie à la largeur de la cible.
Pour une valeur show
définie sur true
pour l’effet WipeLeft, les coordonnées de la position de départ du masque sont (largeur, 0) et les coordonnées de la position d’arrivée sont (0,0).
The MaskEffect class defines the following properties, which all of its subclasses inherit:
<mx:tagname createMaskFunction="" moveEasingFunction="" scaleEasingFunction="" scaleXFrom="" scaleXTo="" scaleYFrom="" scaleYTo="" show="true|false" xFrom="" xTo="" yFrom="" yTo="" />
Eléments de l’API associés
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 |
Méthode | Défini par | ||
---|---|---|---|
MaskEffect(target:Object = null)
Constructeur. | MaskEffect | ||
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 | ||
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 | ||
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 | ||
Capture les valeurs actuelles des propriétés correspondantes sur les cibles de l’effet. | Effect | ||
Crée une seule instance d’effet et l’initialise. | Effect | ||
Prend un tableau d’objets cible et invoque la méthode createInstance() sur chaque cible. | Effect | ||
Supprime les écouteurs d’événement d’une instance et les retire de la liste d’instances. | Effect | ||
Distribue un événement dans le flux d’événements. | EventDispatcher | ||
Interrompt un effet en cours de lecture et passe immédiatement à la fin de l’effet. | Effect | ||
[override]
Renvoie les propriétés du composant modifiées par cet effet. | MaskEffect | ||
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 | ||
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(). | Effect | ||
Commence la lecture de l’effet. | Effect | ||
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(). | Effect | ||
Exécute l’effet en sens inverse, si l’effet est en cours de lecture, à partir de sa position actuelle. | Effect | ||
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle. | Object | ||
Arrête l’effet, en laissant les cibles de l’effet dans leur état actuel. | Effect | ||
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 |
Méthode | Défini par | ||
---|---|---|---|
Utilisée en interne par l’infrastructure Effect. | Effect | ||
Appelée à la fin de la lecture d’une instance d’effet. | Effect | ||
Cette méthode est appelée lorsque l’instance d’effet commence. | Effect | ||
Appelée lorsqu’une instance d’effet a été interrompue par un appel de la méthode stop(). | Effect | ||
Détermine la logique de filtrage d’une instance d’effet. | Effect | ||
Appelée par la méthode captureStartValues() pour obtenir la valeur d’une propriété à partir de la cible. | Effect | ||
Copie les propriétés de l’effet vers l’instance d’effet. | Effect | ||
Appelée lorsque l’objet TweenEffect distribue l’objet TweenEvent. | MaskEffect |
Evénement | Synthèse | Défini par | ||
---|---|---|---|---|
[Evénement de diffusion] Distribué lorsque l’application Flash Player obtient le focus du système d’exploitation et devient active. | EventDispatcher | |||
[Evénement de diffusion] Distribué lorsque l’application Flash Player ou AIR perd le focus du système d’exploitation et devient inactive. | EventDispatcher | |||
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 | |||
Diffusé lorsque l’exécution de l’effet commence. | Effect | |||
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 | |||
Distribué à la fin de l’effet. | MaskEffect | |||
Distribué au début de l’effet, ce qui correspond au premier appel des méthodes onMoveTweenUpdate() et onScaleTweenUpdate(). | MaskEffect | |||
Distribué chaque fois que l’effet met à jour la cible. | MaskEffect |
createMaskFunction | propriété |
public var createMaskFunction: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 appelée lorsque l’effet crée le masque. La valeur par défaut est une fonction qui renvoie un rectangle ayant les mêmes dimensions que la cible.
La fonction de masque personnalisé présente la signature suivante :
public function createLargeMask(targ:Object, bounds:Rectangle):Shape { var myMask:Shape = new FlexShape(); // Create mask. return myMask; }
Votre fonction de masque personnalisé prend un argument correspondant au composant cible de l’effet et un deuxième argument qui définit les dimensions de la cible de sorte que vous puissiez correctement dimensionner le masque. Vous pouvez utiliser cet argument pour accéder aux propriétés du composant cible, telles que width
et height
, de sorte que vous puissiez créer un masque avec la taille appropriée.
La fonction renvoie un seul objet Shape qui définit le masque.
moveEasingFunction | propriété |
public var moveEasingFunction: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 d’accélération à utiliser pour déplacer le masque.
La valeur par défaut est null.
scaleEasingFunction | propriété |
public var scaleEasingFunction: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 d’accélération à utiliser pour la mise à l’échelle du masque.
La valeur par défaut est null.
scaleXFrom | propriété |
public var scaleXFrom:Number
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é scaleX initiale du masque.
Pour spécifier cette propriété, vous devez spécifier les quatre propriétés suivantes : scaleXFrom
, scaleYFrom
, scaleXTo
et scaleX
.
scaleXTo | propriété |
public var scaleXTo:Number
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é scaleX d’arrivée du masque.
Pour spécifier cette propriété, vous devez spécifier les quatre propriétés suivantes : scaleXFrom
, scaleYFrom
, scaleXTo
et scaleX
.
scaleYFrom | propriété |
public var scaleYFrom:Number
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é scaleY de départ du masque.
Pour spécifier cette propriété, vous devez spécifier les quatre propriétés suivantes : scaleXFrom
, scaleYFrom
, scaleXTo
et scaleX
.
scaleYTo | propriété |
public var scaleYTo:Number
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é scaleY d’arrivée du masque.
Pour spécifier cette propriété, vous devez spécifier les quatre propriétés suivantes : scaleXFrom
, scaleYFrom
, scaleXTo
et scaleX
.
showTarget | propriété |
showTarget:Boolean
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 que le composant cible devient visible, true
, invisible ou false
. Si vous spécifiez cet effet pour un ou déclencheur showEffect
ou hideEffect
, Flex définit la propriété showTarget
pour vous, sur true
si le composant devient visible, ou sur false
s’il devient invisible. Si vous utilisez cet effet avec un autre déclencheur d’effets, vous devez le définir vous-même, le plus souvent au sein de l’écouteur d’événement de l’événement startEffect
.
La valeur par défaut est true.
Implémentation
public function get showTarget():Boolean
public function set showTarget(value:Boolean):void
xFrom | propriété |
public var xFrom:Number
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Coordonnée x de la position de départ du masque.
Pour spécifier cette propriété, vous devez spécifier les quatre propriétés suivantes : xFrom
, yFrom
, xTo
et yTo
.
xTo | propriété |
public var xTo:Number
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Coordonnée x de la position d’arrivée du masque.
Pour spécifier cette propriété, vous devez spécifier les quatre propriétés suivantes : xFrom
, yFrom
, xTo
et yTo
.
yFrom | propriété |
public var yFrom:Number
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Coordonnée y de la position de départ du masque.
Pour spécifier cette propriété, vous devez spécifier les quatre propriétés suivantes : xFrom
, yFrom
, xTo
et yTo
.
yTo | propriété |
public var yTo:Number
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Coordonnée y de la position d’arrivée du masque.
Pour spécifier cette propriété, vous devez spécifier les quatre propriétés suivantes : xFrom
, yFrom
, xTo
et yTo
.
MaskEffect | () | Constructeur |
getAffectedProperties | () | méthode |
override public function getAffectedProperties():Array
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Renvoie les propriétés du composant modifiées par cet effet. Cette méthode renvoie un tableau contenant les propriétés [ « visible », « width », « height » ]
. Etant donné que toutes les sous-classes de l’effet WipeDown, WipeLeft, WipeRight et WipeDown modifient ces mêmes propriétés, ces classes n’implémentent pas cette méthode.
Si vous définissez la classe MaskEffect en sous-classe pour créer un effet personnalisé et qu’elle modifie un autre jeu de propriétés sur la cible, vous devez remplacer cette méthode et renvoyer un tableau contenant une liste des propriétés que votre sous-classe a modifié.
Valeur renvoyéeArray — Tableau de chaînes spécifiant les noms des propriétés modifiées par cet effet.
|
Eléments de l’API associés
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.
|
tweenEnd | Evé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 |
Distribué à la fin de l’effet.
Lorsqu’un effet 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 sur Répéter, 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.
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 |
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 |
Distribué au début de l’effet, ce qui correspond au premier appel des méthodes onMoveTweenUpdate()
et onScaleTweenUpdate()
. 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
.
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 |
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 |
Distribué chaque fois que l’effet met à jour la cible. La distribution de cet événement correspond aux appels des méthodes onMoveTweenUpdate()
et onScaleTweenUpdate()
.
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() . |
Tue Jun 12 2018, 09:30 AM Z