Guide de référence ActionScript® 3.0 pour la plate-forme Adobe® Flash®
Accueil  |  Masquer la liste des packages et des classes |  Packages  |  Classes  |  Nouveautés  |  Index  |  Annexes  |  Pourquoi existe-t-il du contenu en anglais ?
Filtres : AIR 30.0 et versions antérieures, Flash Player 30.0 et versions antérieures, Flash Lite 4
Flex 4.6 et versions antérieures, Flash Pro CS6 et versions antérieures
Masquer les filtres
mx.effects 

MaskEffect  - AS3 Flex

Packagesx

Niveau supérieur
adobe.utils
air.desktop
air.net
air.update
air.update.events
coldfusion.air
coldfusion.air.errors
coldfusion.air.events
coldfusion.service
coldfusion.service.events
coldfusion.service.mxml
com.adobe.acm.solutions.authoring.domain.extensions
com.adobe.acm.solutions.ccr.domain.extensions
com.adobe.consulting.pst.vo
com.adobe.dct.component
com.adobe.dct.component.datadictionary
com.adobe.dct.component.datadictionaryElement
com.adobe.dct.component.dataElementsPanel
com.adobe.dct.component.toolbars
com.adobe.dct.event
com.adobe.dct.exp
com.adobe.dct.model
com.adobe.dct.service
com.adobe.dct.service.provider
com.adobe.dct.transfer
com.adobe.dct.util
com.adobe.dct.view
com.adobe.ep.taskmanagement.domain
com.adobe.ep.taskmanagement.event
com.adobe.ep.taskmanagement.filter
com.adobe.ep.taskmanagement.services
com.adobe.ep.taskmanagement.util
com.adobe.ep.ux.attachmentlist.component
com.adobe.ep.ux.attachmentlist.domain
com.adobe.ep.ux.attachmentlist.domain.events
com.adobe.ep.ux.attachmentlist.domain.renderers
com.adobe.ep.ux.attachmentlist.skin
com.adobe.ep.ux.attachmentlist.skin.renderers
com.adobe.ep.ux.content.event
com.adobe.ep.ux.content.factory
com.adobe.ep.ux.content.handlers
com.adobe.ep.ux.content.managers
com.adobe.ep.ux.content.model.asset
com.adobe.ep.ux.content.model.preview
com.adobe.ep.ux.content.model.relation
com.adobe.ep.ux.content.model.search
com.adobe.ep.ux.content.model.toolbar
com.adobe.ep.ux.content.search
com.adobe.ep.ux.content.services
com.adobe.ep.ux.content.services.load
com.adobe.ep.ux.content.services.permissions
com.adobe.ep.ux.content.services.preview
com.adobe.ep.ux.content.services.providers
com.adobe.ep.ux.content.services.query
com.adobe.ep.ux.content.services.relationships
com.adobe.ep.ux.content.services.search.lccontent
com.adobe.ep.ux.content.services.version
com.adobe.ep.ux.content.view
com.adobe.ep.ux.content.view.components.activate
com.adobe.ep.ux.content.view.components.grid
com.adobe.ep.ux.content.view.components.grid.hover
com.adobe.ep.ux.content.view.components.grid.hover.component
com.adobe.ep.ux.content.view.components.grid.renderers
com.adobe.ep.ux.content.view.components.relationships
com.adobe.ep.ux.content.view.components.review
com.adobe.ep.ux.content.view.components.search.renderers
com.adobe.ep.ux.content.view.components.searchpod
com.adobe.ep.ux.content.view.components.toolbar
com.adobe.ep.ux.content.view.components.toolbar.controlRenderers
com.adobe.ep.ux.content.view.components.version
com.adobe.ep.ux.documentsubmit.component
com.adobe.ep.ux.documentsubmit.domain
com.adobe.ep.ux.documentsubmit.skin
com.adobe.ep.ux.taskaction.component
com.adobe.ep.ux.taskaction.domain
com.adobe.ep.ux.taskaction.domain.events
com.adobe.ep.ux.taskaction.skin
com.adobe.ep.ux.taskdetails.component
com.adobe.ep.ux.taskdetails.domain
com.adobe.ep.ux.taskdetails.skin
com.adobe.ep.ux.tasklist.component
com.adobe.ep.ux.tasklist.domain
com.adobe.ep.ux.tasklist.skin
com.adobe.ep.ux.webdocumentviewer.domain
com.adobe.exm.expression
com.adobe.exm.expression.error
com.adobe.exm.expression.event
com.adobe.exm.expression.impl
com.adobe.fiber.runtime.lib
com.adobe.fiber.services
com.adobe.fiber.services.wrapper
com.adobe.fiber.styles
com.adobe.fiber.util
com.adobe.fiber.valueobjects
com.adobe.gravity.binding
com.adobe.gravity.context
com.adobe.gravity.flex.bundleloader
com.adobe.gravity.flex.progress
com.adobe.gravity.flex.serviceloader
com.adobe.gravity.framework
com.adobe.gravity.init
com.adobe.gravity.service.bundleloader
com.adobe.gravity.service.logging
com.adobe.gravity.service.manifest
com.adobe.gravity.service.progress
com.adobe.gravity.tracker
com.adobe.gravity.ui
com.adobe.gravity.utility
com.adobe.gravity.utility.async
com.adobe.gravity.utility.error
com.adobe.gravity.utility.events
com.adobe.gravity.utility.factory
com.adobe.gravity.utility.flex.async
com.adobe.gravity.utility.logging
com.adobe.gravity.utility.message
com.adobe.gravity.utility.sequence
com.adobe.gravity.utility.url
com.adobe.guides.control
com.adobe.guides.domain
com.adobe.guides.i18n
com.adobe.guides.spark.components.skins
com.adobe.guides.spark.components.skins.mx
com.adobe.guides.spark.headers.components
com.adobe.guides.spark.headers.skins
com.adobe.guides.spark.layouts.components
com.adobe.guides.spark.layouts.skins
com.adobe.guides.spark.navigators.components
com.adobe.guides.spark.navigators.renderers
com.adobe.guides.spark.navigators.skins
com.adobe.guides.spark.util
com.adobe.guides.spark.wrappers.components
com.adobe.guides.spark.wrappers.skins
com.adobe.guides.submit
com.adobe.icc.dc.domain
com.adobe.icc.dc.domain.factory
com.adobe.icc.editors.events
com.adobe.icc.editors.handlers
com.adobe.icc.editors.managers
com.adobe.icc.editors.model
com.adobe.icc.editors.model.config
com.adobe.icc.editors.model.el
com.adobe.icc.editors.model.el.operands
com.adobe.icc.editors.model.el.operators
com.adobe.icc.enum
com.adobe.icc.external.dc
com.adobe.icc.obj
com.adobe.icc.services
com.adobe.icc.services.category
com.adobe.icc.services.config
com.adobe.icc.services.download
com.adobe.icc.services.export
com.adobe.icc.services.external
com.adobe.icc.services.formbridge
com.adobe.icc.services.fragmentlayout
com.adobe.icc.services.layout
com.adobe.icc.services.letter
com.adobe.icc.services.locator
com.adobe.icc.services.module
com.adobe.icc.services.render
com.adobe.icc.services.submit
com.adobe.icc.services.user
com.adobe.icc.token
com.adobe.icc.vo
com.adobe.icc.vo.render
com.adobe.icomm.assetplacement.controller
com.adobe.icomm.assetplacement.controller.utils
com.adobe.icomm.assetplacement.data
com.adobe.icomm.assetplacement.model
com.adobe.livecycle.assetmanager.client
com.adobe.livecycle.assetmanager.client.event
com.adobe.livecycle.assetmanager.client.handler
com.adobe.livecycle.assetmanager.client.managers
com.adobe.livecycle.assetmanager.client.model
com.adobe.livecycle.assetmanager.client.model.cms
com.adobe.livecycle.assetmanager.client.service
com.adobe.livecycle.assetmanager.client.service.search
com.adobe.livecycle.assetmanager.client.service.search.cms
com.adobe.livecycle.assetmanager.client.utils
com.adobe.livecycle.content
com.adobe.livecycle.rca.model
com.adobe.livecycle.rca.model.constant
com.adobe.livecycle.rca.model.document
com.adobe.livecycle.rca.model.participant
com.adobe.livecycle.rca.model.reminder
com.adobe.livecycle.rca.model.stage
com.adobe.livecycle.rca.service
com.adobe.livecycle.rca.service.core
com.adobe.livecycle.rca.service.core.delegate
com.adobe.livecycle.rca.service.process
com.adobe.livecycle.rca.service.process.delegate
com.adobe.livecycle.rca.token
com.adobe.livecycle.ria.security.api
com.adobe.livecycle.ria.security.service
com.adobe.mosaic.layouts
com.adobe.mosaic.layouts.dragAndDrop
com.adobe.mosaic.layouts.interfaces
com.adobe.mosaic.mxml
com.adobe.mosaic.om.constants
com.adobe.mosaic.om.events
com.adobe.mosaic.om.impl
com.adobe.mosaic.om.interfaces
com.adobe.mosaic.skinning
com.adobe.mosaic.sparklib.editors
com.adobe.mosaic.sparklib.optionMenu
com.adobe.mosaic.sparklib.scrollableMenu
com.adobe.mosaic.sparklib.scrollableMenu.skins
com.adobe.mosaic.sparklib.tabLayout
com.adobe.mosaic.sparklib.tabLayout.events
com.adobe.mosaic.sparklib.tabLayout.layouts
com.adobe.mosaic.sparklib.tabLayout.skins
com.adobe.mosaic.sparklib.text
com.adobe.mosaic.sparklib.util
com.adobe.solutions.acm.authoring.presentation
com.adobe.solutions.acm.authoring.presentation.actionbar
com.adobe.solutions.acm.authoring.presentation.common
com.adobe.solutions.acm.authoring.presentation.events
com.adobe.solutions.acm.authoring.presentation.fragment
com.adobe.solutions.acm.authoring.presentation.letter
com.adobe.solutions.acm.authoring.presentation.letter.data
com.adobe.solutions.acm.authoring.presentation.preview
com.adobe.solutions.acm.authoring.presentation.rte
com.adobe.solutions.acm.ccr.presentation
com.adobe.solutions.acm.ccr.presentation.contentcapture
com.adobe.solutions.acm.ccr.presentation.contentcapture.events
com.adobe.solutions.acm.ccr.presentation.contentcapture.preview
com.adobe.solutions.acm.ccr.presentation.datacapture
com.adobe.solutions.acm.ccr.presentation.datacapture.renderers
com.adobe.solutions.acm.ccr.presentation.pdf
com.adobe.solutions.exm
com.adobe.solutions.exm.authoring
com.adobe.solutions.exm.authoring.components.controls
com.adobe.solutions.exm.authoring.components.toolbars
com.adobe.solutions.exm.authoring.domain
com.adobe.solutions.exm.authoring.domain.expression
com.adobe.solutions.exm.authoring.domain.impl
com.adobe.solutions.exm.authoring.domain.method
com.adobe.solutions.exm.authoring.domain.variable
com.adobe.solutions.exm.authoring.enum
com.adobe.solutions.exm.authoring.events
com.adobe.solutions.exm.authoring.model
com.adobe.solutions.exm.authoring.renderer
com.adobe.solutions.exm.authoring.view
com.adobe.solutions.exm.expression
com.adobe.solutions.exm.impl
com.adobe.solutions.exm.impl.method
com.adobe.solutions.exm.method
com.adobe.solutions.exm.mock
com.adobe.solutions.exm.mock.method
com.adobe.solutions.exm.runtime
com.adobe.solutions.exm.runtime.impl
com.adobe.solutions.exm.variable
com.adobe.solutions.prm.constant
com.adobe.solutions.prm.domain
com.adobe.solutions.prm.domain.factory
com.adobe.solutions.prm.domain.impl
com.adobe.solutions.prm.domain.manager
com.adobe.solutions.prm.presentation.asset
com.adobe.solutions.prm.presentation.constant
com.adobe.solutions.prm.presentation.document
com.adobe.solutions.prm.presentation.event
com.adobe.solutions.prm.presentation.file
com.adobe.solutions.prm.presentation.project
com.adobe.solutions.prm.presentation.team
com.adobe.solutions.prm.presentation.util
com.adobe.solutions.prm.service
com.adobe.solutions.prm.services.impl
com.adobe.solutions.prm.vo
com.adobe.solutions.rca.constant
com.adobe.solutions.rca.domain
com.adobe.solutions.rca.domain.common
com.adobe.solutions.rca.domain.factory
com.adobe.solutions.rca.domain.impl
com.adobe.solutions.rca.domain.impl.manager
com.adobe.solutions.rca.domain.manager
com.adobe.solutions.rca.presentation
com.adobe.solutions.rca.presentation.comment
com.adobe.solutions.rca.presentation.constant
com.adobe.solutions.rca.presentation.event
com.adobe.solutions.rca.presentation.gantt
com.adobe.solutions.rca.presentation.gantt.ruler
com.adobe.solutions.rca.presentation.template
com.adobe.solutions.rca.presentation.template.audit
com.adobe.solutions.rca.presentation.template.definition
com.adobe.solutions.rca.presentation.template.documents
com.adobe.solutions.rca.presentation.template.stages
com.adobe.solutions.rca.presentation.util
com.adobe.solutions.rca.service
com.adobe.solutions.rca.services.impl
com.adobe.solutions.rca.vo
com.adobe.solutions.rca.vo.um
com.adobe.viewsource
fl.accessibility
fl.containers
fl.controls
fl.controls.dataGridClasses
fl.controls.listClasses
fl.controls.progressBarClasses
fl.core
fl.data
fl.display
fl.events
fl.ik
fl.lang
fl.livepreview
fl.managers
fl.motion
fl.motion.easing
fl.rsl
fl.text
fl.transitions
fl.transitions.easing
fl.video
flash.accessibility
flash.concurrent
flash.crypto
flash.data
flash.desktop
flash.display
flash.display3D
flash.display3D.textures
flash.errors
flash.events
flash.external
flash.filesystem
flash.filters
flash.geom
flash.globalization
flash.html
flash.media
flash.net
flash.net.dns
flash.net.drm
flash.notifications
flash.permissions
flash.printing
flash.profiler
flash.sampler
flash.security
flash.sensors
flash.system
flash.text
flash.text.engine
flash.text.ime
flash.ui
flash.utils
flash.xml
flashx.textLayout
flashx.textLayout.compose
flashx.textLayout.container
flashx.textLayout.conversion
flashx.textLayout.edit
flashx.textLayout.elements
flashx.textLayout.events
flashx.textLayout.factory
flashx.textLayout.formats
flashx.textLayout.operations
flashx.textLayout.utils
flashx.undo
ga.controls
ga.layouts
ga.model
ga.uiComponents
ga.util
ga.views
ga.wrappers
lc.foundation
lc.foundation.domain
lc.foundation.events
lc.foundation.ui
lc.foundation.util
lc.preloader
lc.procmgmt
lc.procmgmt.commands
lc.procmgmt.domain
lc.procmgmt.events
lc.procmgmt.formbridge
lc.procmgmt.impl
lc.procmgmt.ui.attachments
lc.procmgmt.ui.controls
lc.procmgmt.ui.controls.card
lc.procmgmt.ui.controls.renderer
lc.procmgmt.ui.help
lc.procmgmt.ui.layout
lc.procmgmt.ui.presentationmodel
lc.procmgmt.ui.process
lc.procmgmt.ui.search
lc.procmgmt.ui.startpoint
lc.procmgmt.ui.task
lc.procmgmt.ui.task.form
lc.procmgmt.ui.task.form.commands
lc.procmgmt.ui.tracking
mx.accessibility
mx.automation
mx.automation.air
mx.automation.delegates
mx.automation.delegates.advancedDataGrid
mx.automation.delegates.charts
mx.automation.delegates.containers
mx.automation.delegates.controls
mx.automation.delegates.controls.dataGridClasses
mx.automation.delegates.controls.fileSystemClasses
mx.automation.delegates.core
mx.automation.delegates.flashflexkit
mx.automation.events
mx.binding
mx.binding.utils
mx.charts
mx.charts.chartClasses
mx.charts.effects
mx.charts.effects.effectClasses
mx.charts.events
mx.charts.renderers
mx.charts.series
mx.charts.series.items
mx.charts.series.renderData
mx.charts.styles
mx.collections
mx.collections.errors
mx.containers
mx.containers.accordionClasses
mx.containers.dividedBoxClasses
mx.containers.errors
mx.containers.utilityClasses
mx.controls
mx.controls.advancedDataGridClasses
mx.controls.dataGridClasses
mx.controls.listClasses
mx.controls.menuClasses
mx.controls.olapDataGridClasses
mx.controls.scrollClasses
mx.controls.sliderClasses
mx.controls.textClasses
mx.controls.treeClasses
mx.controls.videoClasses
mx.core
mx.core.windowClasses
mx.data
mx.data.crypto
mx.data.errors
mx.data.events
mx.data.messages
mx.data.mxml
mx.data.offline.errors
mx.data.utils
mx.effects
mx.effects.easing
mx.effects.effectClasses
mx.events
mx.filters
mx.flash
mx.formatters
mx.geom
mx.graphics
mx.graphics.codec
mx.graphics.shaderClasses
mx.logging
mx.logging.errors
mx.logging.targets
mx.managers
mx.messaging
mx.messaging.channels
mx.messaging.config
mx.messaging.errors
mx.messaging.events
mx.messaging.management
mx.messaging.messages
mx.modules
mx.netmon
mx.olap
mx.olap.aggregators
mx.preloaders
mx.printing
mx.resources
mx.rpc
mx.rpc.events
mx.rpc.http
mx.rpc.http.mxml
mx.rpc.livecycle
mx.rpc.mxml
mx.rpc.remoting
mx.rpc.remoting.mxml
mx.rpc.soap
mx.rpc.soap.mxml
mx.rpc.wsdl
mx.rpc.xml
mx.skins
mx.skins.halo
mx.skins.spark
mx.skins.wireframe
mx.skins.wireframe.windowChrome
mx.states
mx.styles
mx.utils
mx.validators
org.osmf.containers
org.osmf.display
org.osmf.elements
org.osmf.events
org.osmf.layout
org.osmf.logging
org.osmf.media
org.osmf.metadata
org.osmf.net
org.osmf.net.dvr
org.osmf.net.httpstreaming
org.osmf.net.metrics
org.osmf.net.qos
org.osmf.net.rtmpstreaming
org.osmf.net.rules
org.osmf.traits
org.osmf.utils
spark.accessibility
spark.automation.delegates
spark.automation.delegates.components
spark.automation.delegates.components.gridClasses
spark.automation.delegates.components.mediaClasses
spark.automation.delegates.components.supportClasses
spark.automation.delegates.skins.spark
spark.automation.events
spark.collections
spark.components
spark.components.calendarClasses
spark.components.gridClasses
spark.components.mediaClasses
spark.components.supportClasses
spark.components.windowClasses
spark.core
spark.effects
spark.effects.animation
spark.effects.easing
spark.effects.interpolation
spark.effects.supportClasses
spark.events
spark.filters
spark.formatters
spark.formatters.supportClasses
spark.globalization
spark.globalization.supportClasses
spark.layouts
spark.layouts.supportClasses
spark.managers
spark.modules
spark.preloaders
spark.primitives
spark.primitives.supportClasses
spark.skins
spark.skins.mobile
spark.skins.mobile.supportClasses
spark.skins.spark
spark.skins.spark.mediaClasses.fullScreen
spark.skins.spark.mediaClasses.normal
spark.skins.spark.windowChrome
spark.skins.wireframe
spark.skins.wireframe.mediaClasses
spark.skins.wireframe.mediaClasses.fullScreen
spark.transitions
spark.utils
spark.validators
spark.validators.supportClasses
xd.core.axm.enterprise.view.components
xd.core.axm.enterprise.view.skins
xd.core.axm.view.components
xd.core.axm.view.components.support

Eléments du langage

Constantes globales
Fonctions globales
Opérateurs
Instructions, mots clés et directives
Types spéciaux

Annexes

Nouveautés
Erreurs de compilation
Avertissements du compilateur
Erreurs d’exécution
Migration vers ActionScript 3
Jeux de caractères pris en charge
Balises MXML uniquement
Eléments XML de mouvement
Balises Timed Text
Liste des éléments déconseillés
Constantes d’implémentation d’accessibilité
Utilisation des exemples de code ActionScript
Informations juridiques
Packagemx.effects
Classepublic class MaskEffect
HéritageMaskEffect Inheritance Effect Inheritance EventDispatcher Inheritance 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

La classe MaskEffect est une classe de base abstraite de tous les effets qui animent un masque, telles que les effets wipe et l’effet Iris. Cette classe encapsule les méthodes et les propriétés communes à tous les effets basés sur un masque.

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).

Syntaxe MXMLexpandedMasquer la syntaxe MXML

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és publiques
 PropriétéDéfini par
 InheritedclassName : String
[lecture seule] Le nom de la classe d’effet, tel que « Fade ».
Effect
 Inheritedconstructor : 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
 InheritedcustomFilter : 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
 Inheritedduration : Number
Durée de l’effet en millisecondes.
Effect
 InheritedeffectTargetHost : mx.effects:IEffectTargetHost
Propriété qui permet d’accéder au contrôle à base de liste de la cible d’un effet data.
Effect
 Inheritedfilter : String
Spécifie un algorithme de filtrage des cibles d’un effet.
Effect
 InheritedhideFocusRing : Boolean
Détermine si l’effet doit masquer l’anneau de focus lors du démarrage.
Effect
 InheritedinstanceClass : Class
Objet de type Class qui spécifie la classe de l’instance d’effet de cette classe d’effets.
Effect
 InheritedisPlaying : 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
 InheritedperElementOffset : Number
Autre délai, en millisecondes, pour les cibles d’effet suivant la première cible de l’effet.
Effect
 InheritedplayheadTime : Number
Temps de position actuelle de l’effet.
Effect
 InheritedrelevantProperties : Array
Tableau de noms de propriété à utiliser pour effectuer le filtrage.
Effect
 InheritedrelevantStyles : Array
Tableau des noms de style à utiliser pour effectuer le filtrage.
Effect
 InheritedrepeatCount : int = 1
Nombre de fois que l’effet doit être répété.
Effect
 InheritedrepeatDelay : 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
 InheritedstartDelay : int = 0
Intervalle (en millisecondes), qui s’écoule avant de commencer l’effet.
Effect
 InheritedsuspendBackgroundProcessing : Boolean = false
Si la valeur est true, elle bloque tout le traitement en arrière-plan pendant l’exécution de l’effet.
Effect
 Inheritedtarget : Object
Objet auquel s’applique cet effet.
Effect
 Inheritedtargets : Array
Tableau d’objets représentant des cibles de l’effet.
Effect
 InheritedtriggerEvent : 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
 PropriétéDéfini par
 InheritedapplyTransitionEndProperties : 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
 InheritedendValuesCaptured : 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
 MéthodeDéfini par
  
MaskEffect(target:Object = null)
Constructeur.
MaskEffect
 Inherited
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
 Inherited
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
 Inherited
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
 Inherited
Capture les valeurs actuelles des propriétés correspondantes sur les cibles de l’effet.
Effect
 Inherited
Crée une seule instance d’effet et l’initialise.
Effect
 Inherited
createInstances(targets:Array = null):Array
Prend un tableau d’objets cible et invoque la méthode createInstance() sur chaque cible.
Effect
 Inherited
Supprime les écouteurs d’événement d’une instance et les retire de la liste d’instances.
Effect
 Inherited
Distribue un événement dans le flux d’événements.
EventDispatcher
 Inherited
end(effectInstance:IEffectInstance = null):void
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
 Inherited
Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement.
EventDispatcher
 Inherited
Indique si la propriété spécifiée d’un objet est définie.
Object
 Inherited
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
 Inherited
Interrompt momentanément l’effet jusqu’à un appel de la méthode resume().
Effect
 Inherited
play(targets:Array = null, playReversedFromEnd:Boolean = false):Array
Commence la lecture de l’effet.
Effect
 Inherited
Indique si la propriété spécifiée existe et est énumérable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Supprime un écouteur de l’objet EventDispatcher.
EventDispatcher
 Inherited
Reprend l’effet après une interruption demandée par un appel de la méthode pause().
Effect
 Inherited
Exécute l’effet en sens inverse, si l’effet est en cours de lecture, à partir de sa position actuelle.
Effect
 Inherited
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.
Object
 Inherited
Arrête l’effet, en laissant les cibles de l’effet dans leur état actuel.
Effect
 Inherited
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur.
Object
 Inherited
Renvoie la représentation sous forme de chaîne de l’objet spécifié.
Object
 Inherited
Renvoie la valeur primitive de l’objet spécifié.
Object
 Inherited
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
 MéthodeDéfini par
 Inherited
applyValueToTarget(target:Object, property:String, value:*, props:Object):void
Utilisée en interne par l’infrastructure Effect.
Effect
 Inherited
Appelée à la fin de la lecture d’une instance d’effet.
Effect
 Inherited
Cette méthode est appelée lorsque l’instance d’effet commence.
Effect
 Inherited
Appelée lorsqu’une instance d’effet a été interrompue par un appel de la méthode stop().
Effect
 Inherited
filterInstance(propChanges:Array, target:Object):Boolean
Détermine la logique de filtrage d’une instance d’effet.
Effect
 Inherited
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
 Inherited
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énements
 Evénement Synthèse Défini par
 Inherited[Evénement de diffusion] Distribué lorsque l’application Flash Player obtient le focus du système d’exploitation et devient active.EventDispatcher
 Inherited[Evénement de diffusion] Distribué lorsque l’application Flash Player ou AIR perd le focus du système d’exploitation et devient inactive.EventDispatcher
 InheritedDistribué 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
 InheritedDiffusé lorsque l’exécution de l’effet commence.Effect
 InheritedDistribué 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
Détails de la propriété

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.

Détails du constructeur

MaskEffect

()Constructeur
public function MaskEffect(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

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ée
Array — 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.

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

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.

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
bubblesfalse
cancelablefalse
currentTargetObjet 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.
targetObjet 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.
valueValeur 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

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.

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
bubblesfalse
cancelablefalse
currentTargetObjet 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.
targetObjet 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.
valueValeur 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

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().

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
bubblesfalse
cancelablefalse
currentTargetObjet 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.
targetObjet 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.
valueValeur transmise à la méthode onTweenUpdate().




[ X ]Pourquoi existe-t-il du contenu en anglais ?
Certaines parties du Guide de référence ActionScript 3.0 sont en anglais

Tout le contenu du Guide de référence ActionScript 3.0 n’a pas été traduit dans toutes les langues. Si un élément de langage n’est pas traduit, il s’affiche en anglais. Par exemple, la classe ga.controls.HelpBox n’est traduite dans aucune langue. Ainsi, dans la version française du guide de référence, la classe ga.controls.HelpBox apparaît en anglais.