Flex - Effet

introduction

La classe Effect est une classe de base abstraite qui définit les fonctionnalités de base de tous les effets Flex. La classe Effect définit la classe d'usine de base pour tous les effets. La classe EffectInstance définit la classe de base pour toutes les sous-classes d'instance d'effet.

Déclaration de classe

Voici la déclaration pour mx.effects.Effect classe -

public class Effect
   extends EventDispatcher
      implements IEffect

Propriétés publiques

Sr.Non Propriété et description
1

className : String

[lecture seule] Le nom de la classe d'effets, par exemple "Fade".

2

customFilter : mx.effects:EffectTargetFilter

Spécifie un objet de filtre personnalisé, de type EffectTargetFilter, utilisé par l'effet pour déterminer les cibles sur lesquelles jouer l'effet.

3

duration : Number

Durée de l'effet en millisecondes.

4

effectTargetHost : mx.effects:IEffectTargetHost

Propriété qui vous permet d'accéder au contrôle basé sur la liste cible d'un effet de données.

5

filter : String

Spécifie un algorithme pour filtrer les cibles pour un effet.

6

hideFocusRing : Boolean

Détermine si l’effet doit masquer la bague de mise au point lors du démarrage de l’effet.

sept

instanceClass : Class

Un objet de type Class qui spécifie la classe de classe d'instance d'effet pour cette classe d'effet.

8

isPlaying : Boolean

[lecture seule] Un indicateur en lecture seule qui est vrai si des instances de l'effet sont en cours de lecture, et faux si aucune ne l'est.

9

perElementOffset : Number

Délai supplémentaire, en millisecondes, pour les cibles d'effet après la première cible de l'effet.

dix

playheadTime : Number

Position temporelle actuelle de l'effet.

11

relevantProperties : Array

Un tableau de noms de propriétés à utiliser lors du filtrage.

12

relevantStyles : Array

Un tableau de noms de style à utiliser lors du filtrage.

13

repeatCount : int = 1

Nombre de répétitions de l'effet.

14

repeatDelay : int = 0

Durée, en millisecondes, à attendre avant de répéter l'effet.

15

startDelay : int = 0

Durée, en millisecondes, à attendre avant de démarrer l'effet.

16

suspendBackgroundProcessing : Boolean = false

Si vrai, bloque tout le traitement en arrière-plan pendant la lecture de l'effet.

17

target : Object

Objet auquel cet effet est appliqué.

18

targets : Array

Un tableau d'objets qui sont les cibles de l'effet.

19

triggerEvent : Event

L'objet Event transmis à cet effet par EffectManager lorsqu'un effet est déclenché, ou nul si l'effet n'est pas joué par EffectManager.

Propriétés protégées

Sr.Non Propriété et description
1

applyTransitionEndProperties : Boolean

Cet indicateur contrôle si l'effet, lorsqu'il est exécuté dans une transition, applique automatiquement les valeurs de propriété en fonction de l'état final, plutôt que de laisser les valeurs définies par l'effet lui-même.

2

endValuesCaptured : Boolean = false

Un indicateur contenant true si les valeurs finales 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 d'effet lors de l'exécution de l'effet.

Méthodes publiques

Sr.Non Méthode et description
1

Effect(target:Object = null)

Constructeur.

2

captureEndValues():void

Capture les valeurs actuelles des propriétés pertinentes sur les cibles de l'effet et les enregistre en tant que valeurs finales.

3

captureMoreStartValues(targets:Array):void

Capture les valeurs actuelles des propriétés pertinentes d'un ensemble supplémentaire de cibles Flex utilise cette fonction lorsqu'un effet de modification de données est exécuté.

4

captureStartValues():void

Capture les valeurs actuelles des propriétés pertinentes sur les cibles de l'effet.

5

createInstance(target:Object = null):IEffectInstance

Crée une seule instance d'effet et l'initialise.

6

createInstances(targets:Array = null):Array

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

sept

deleteInstance(instance:IEffectInstance):void

Supprime les écouteurs d'événements d'une instance et les supprime de la liste des instances.

8

end(effectInstance:IEffectInstance = null):void

Interrompt un effet en cours de lecture et passe immédiatement à la fin de l'effet.

9

getAffectedProperties():Array

Renvoie un tableau de chaînes, où chaque chaîne est le nom d'une propriété modifiée par cet effet.

dix

pause():void

Suspend l'effet jusqu'à ce que vous appeliez la méthode resume ().

11

play(targets:Array = null, playReversedFromEnd:Boolean = false):Array

Commence à jouer l'effet.

12

resume():void

Reprend l'effet après avoir été mis en pause par un appel à la méthode pause ().

13

reverse():void

Lit l'effet à l'envers, si l'effet est en cours de lecture, à partir de la position actuelle de l'effet.

14

stop():void

Arrête l'effet, laissant les cibles d'effet dans leur état actuel.

Méthodes protégées

Sr.Non Méthode et description
1

applyValueToTarget(target:Object, property:String, value:*, props:Object):void

Utilisé en interne par l'infrastructure Effect.

2

effectEndHandler(event:EffectEvent):void

Appelé lorsqu'une instance d'effet a fini de jouer.

3

effectStartHandler(event:EffectEvent):void

Cette méthode est appelée lorsque l'instance d'effet commence à jouer.

4

effectStopHandler(event:EffectEvent):void

Appelé lorsqu'une instance d'effet s'est arrêtée par un appel à la méthode stop ().

5

filterInstance(propChanges:Array, target:Object):Boolean

Détermine la logique de filtrage d'une instance d'effet.

6

getValueFromTarget(target:Object, property:String):*

Appelé par la méthode captureStartValues ​​() pour obtenir la valeur d'une propriété de la cible.

sept

initInstance(instance:IEffectInstance):void

Copie les propriétés de l'effet dans l'instance d'effet.

Événements

Sr.Non Description de l'évenement
1

effectEnd

Distribué à la fin de la lecture de l'une des instances de l'effet, soit à la fin de la lecture de l'instance, soit lorsque l'effet est interrompu par un appel à la méthode end ().

2

effectStart

Distribué lorsque l'effet commence à jouer.

3

effectStop

Distribué lorsque l'effet a été arrêté, ce qui se produit uniquement lorsque l'effet est interrompu par un appel à la méthode stop ().

Méthodes héritées

Cette classe hérite des méthodes des classes suivantes -

  • flash.events.EventDispatcher
  • Object