| Pacote | mx.effects |
| Classe | public class Effect |
| Herança | Effect  EventDispatcher Object |
| Implementações | IEffect |
| Subclasses | AddAction, AddChildAction, AddItemAction, Animate, CallAction, CompositeEffect, MaskEffect, RemoveAction, RemoveChildAction, RemoveItemAction, SetAction, SetPropertyAction, SetStyleAction, SoundEffect, TweenEffect, UnconstrainItemAction |
| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
You do not create an instance of the Effect class itself in an application. Instead, you create an instance of one of the subclasses, such as Fade or WipeLeft.
Sintaxe MXML
Mostrar sintaxe MXML
Ocultar sintaxe MXMLThe Effect class defines the following properties, which all of its subclasses inherit:
<mx:tagname
Properties
customFilter=""
duration="500"
filter=""
hideFocusRing="false"
perElementOffset="0"
repeatCount="1"
repeatDelay="0"
startDelay="0"
suspendBackgroundProcessing="false|true"
target="effect target"
targets="array of effect targets"
Events
effectEnd="No default"
efectStart="No default"
/>
Mais exemplos
About applying Spark effects
About applying MX effects
About factory and instance classes
Applying effects
Using the Effect.target and Effect.targets properties
Applying effects by using data binding
Playing an effect backward
Ending an effect
Creating effects in ActionScript
Working with effects
Delaying effect start
Repeating effects
Handling effect events
Creating composite effects
Using embedded fonts with effects
Suspending background processing
Disabling container layout for effects
Handling Spark effect events
Using Spark easing classes
Improving effect performance
About creating a custom effect
Example: Defining a simple effect
Example: Passing parameters to effects
Writing an effect for a transition
Defining a custom effect trigger for MX effects
Elementos da API relacionados
| Propriedade | Definido por | ||
|---|---|---|---|
| className : String [somente leitura]
The name of the effect class, such as "Fade". | Effect | ||
 | constructor : Object
Uma referência ao objeto de classe ou à função de construtor de uma determinada ocorrência de objeto. | Object | |
| customFilter : mx.effects:EffectTargetFilter
Specifies a custom filter object, of type EffectTargetFilter,
used by the effect to determine the targets
on which to play the effect. | Effect | ||
| duration : Number
Duration of the effect in milliseconds. | Effect | ||
| effectTargetHost : mx.effects:IEffectTargetHost
A property that lets you access the target list-based control
of a data effect. | Effect | ||
| filter : String
Specifies an algorithm for filtering targets for an effect. | Effect | ||
| hideFocusRing : Boolean
Determines whether the effect should hide the focus ring
when starting the effect. | Effect | ||
| instanceClass : Class
An object of type Class that specifies the effect
instance class class for this effect class. | Effect | ||
| isPlaying : Boolean [somente leitura]
A read-only flag which is true if any instances of the effect
are currently playing, and false if none are. | Effect | ||
| perElementOffset : Number
Additional delay, in milliseconds, for effect targets
after the first target of the effect. | Effect | ||
| playheadTime : Number
Current time position of the effect. | Effect | ||
| relevantProperties : Array
An Array of property names to use when performing filtering. | Effect | ||
| relevantStyles : Array
An Array of style names to use when performing filtering. | Effect | ||
| repeatCount : int = 1
Number of times to repeat the effect. | Effect | ||
| repeatDelay : int = 0
Amount of time, in milliseconds, to wait before repeating the effect. | Effect | ||
| startDelay : int = 0
Amount of time, in milliseconds, to wait before starting the effect. | Effect | ||
| suspendBackgroundProcessing : Boolean = false
If true, blocks all background processing
while the effect is playing. | Effect | ||
| target : Object
The object to which this effect is applied. | Effect | ||
| targets : Array
An Array of objects that are targets for the effect. | Effect | ||
| triggerEvent : Event
The Event object passed to this Effect
by the EffectManager when an effect is triggered,
or null if the effect is not being
played by the EffectManager. | Effect | ||
| Propriedade | Definido por | ||
|---|---|---|---|
| applyTransitionEndProperties : Boolean
This flag controls whether the effect, when run in a transition,
automatically applies the property values according to the end
state, as opposed to leaving values as set by the effect itself. | Effect | ||
| endValuesCaptured : Boolean = false
A flag containing true if the end values
of an effect have already been determined,
or false if they should be acquired from the
current properties of the effect targets when the effect runs. | Effect | ||
| Método | Definido por | ||
|---|---|---|---|
Constructor. | Effect | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registra um objeto de ouvinte de evento em um objeto EventDispatcher, de forma que o ouvinte receba a notificação de um evento. | EventDispatcher | |
Captures the current values of the relevant properties
on the effect's targets and saves them as end values. | Effect | ||
Captures the current values of the relevant properties
of an additional set of targets
Flex uses this function when a data change
effect is run.
| Effect | ||
Captures the current values of the relevant properties
on the effect's targets. | Effect | ||
Creates a single effect instance and initializes it. | Effect | ||
Takes an Array of target objects and invokes the
createInstance() method on each target. | Effect | ||
Removes event listeners from an instance
and removes it from the list of instances. | Effect | ||
|
Envia um evento para o fluxo de eventos. | EventDispatcher | |
Interrupts an effect that is currently playing,
and jumps immediately to the end of the effect. | Effect | ||
Returns an Array of Strings, where each String is the name
of a property changed by this effect. | Effect | ||
|
Verifica se o objeto EventDispatcher tem ouvintes registrados para um tipo específico de evento. | EventDispatcher | |
|
Indica se um objeto tem uma propriedade especificada definida. | Object | |
|
Indica se uma ocorrência da classe Object está na cadeia de protótipos do objeto especificado como o parâmetro. | Object | |
Pauses the effect until you call the resume() method. | Effect | ||
Begins playing the effect. | Effect | ||
|
Indica se a propriedade especificada existe e é enumerável. | Object | |
|
Remove um ouvinte do objeto EventDispatcher. | EventDispatcher | |
Resumes the effect after it has been paused
by a call to the pause() method. | Effect | ||
Plays the effect in reverse, if the effect is currently playing,
starting from the current position of the effect. | Effect | ||
|
Define a disponibilidade de uma propriedade dinâmica para operações de repetição. | Object | |
Stops the effect, leaving the effect targets in their current state. | Effect | ||
|
Retorna a representação da string deste objeto, formatado segundo as convenções específicas para a localidade. | Object | |
|
Retorna a representação de string do objeto especificado. | Object | |
|
Retorna o valor primitivo do objeto especificado. | Object | |
|
Verifica se um ouvinte de evento está registrado nesse objeto EventDispatcher ou em qualquer um de seus ancestrais para o tipo de evento especificado. | EventDispatcher | |
| Método | Definido por | ||
|---|---|---|---|
Used internally by the Effect infrastructure. | Effect | ||
Called when an effect instance has finished playing. | Effect | ||
This method is called when the effect instance starts playing. | Effect | ||
Called when an effect instance has stopped by a call
to the stop() method. | Effect | ||
Determines the logic for filtering out an effect instance. | Effect | ||
Called by the captureStartValues() method to get the value
of a property from the target. | Effect | ||
Copies properties of the effect to the effect instance. | Effect | ||
| Evento | Resumo | Definido por | ||
|---|---|---|---|---|
| [transmissão de evento] Despachado quando o Flash Player ou o aplicativo do AIR ganha o foco do sistema operacional e está se tornando inativo. | EventDispatcher | ||
| [transmissão de evento] Despachado quando o Flash Player ou o aplicativo do AIR perde o foco do sistema operacional e está se tornando inativo. | EventDispatcher | ||
| Dispatched when one of the effect's instances finishes playing, either when the instance finishes playing or when the effect is interrupted by a call to the end() method. | Effect | |||
| Dispatched when the effect starts playing. | Effect | |||
| Dispatched when the effect has been stopped, which only occurs when the effect is interrupted by a call to the stop() method. | Effect | |||
applyTransitionEndProperties | propriedade |
protected var applyTransitionEndProperties:Boolean| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
This flag controls whether the effect, when run in a transition, automatically applies the property values according to the end state, as opposed to leaving values as set by the effect itself.
O valor padrão é true.
className | propriedade |
className:String [somente leitura] | Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
The name of the effect class, such as "Fade".
This is a short, or unqualified, class name
that does not include the package name.
If you need the qualified name, use the
getQualifiedClassName() method
in the flash.utils package.
Implementação
public function get className():StringcustomFilter | propriedade |
customFilter:mx.effects:EffectTargetFilter| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Specifies a custom filter object, of type EffectTargetFilter, used by the effect to determine the targets on which to play the effect.
Target filtering is only performed if you call the
captureStartValues() method before playing the effect.
Flex automatically calls the captureStartValues() method
when the effect is part of a transition.
Use the filter property for simple filtering.
If the customFilter property is non-null,
the filter property is ignored.
Implementação
public function get customFilter():mx.effects:EffectTargetFilter public function set customFilter(value:mx.effects:EffectTargetFilter):voidduration | propriedade |
duration:Number| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Duration of the effect in milliseconds.
In a Parallel or Sequence effect, the duration
property sets the duration of each effect.
For example, if a Sequence effect has its duration
property set to 3000, each effect in the Sequence takes 3000 ms
to play.
For a repeated effect, the duration property
specifies the duration of a single instance of the effect.
Therefore, if an effect has a duration property
set to 2000, and a repeatCount property set to 3,
the effect takes a total of 6000 ms (6 seconds) to play.
Implementação
public function get duration():Number public function set duration(value:Number):voideffectTargetHost | propriedade |
effectTargetHost:mx.effects:IEffectTargetHost| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
A property that lets you access the target list-based control of a data effect. This property enables an instance of an effect class to communicate with the list-based control on which the effect is playing.
Implementação
public function get effectTargetHost():mx.effects:IEffectTargetHost public function set effectTargetHost(value:mx.effects:IEffectTargetHost):voidendValuesCaptured | propriedade |
protected var endValuesCaptured:Boolean = false| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
A flag containing true if the end values
of an effect have already been determined,
or false if they should be acquired from the
current properties of the effect targets when the effect runs.
This property is required by data effects because the sequence
of setting up the data effects, such as DefaultListEffect
and DefaultTileListEffect, is more complicated than for
normal effects.
O valor padrão é false.
filter | propriedade |
filter:String| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Specifies an algorithm for filtering targets for an effect.
A value of null specifies no filtering.
Target filtering is only performed if you call the
captureStartValues() method before playing the effect.
Flex automatically calls the captureStartValues() method
when the effect is part of a transition, or part of a data effect
for a list-based control.
Use this property for simple filtering.
Use the customFilter property for more complex filtering.
If the customFilter property has a non-null value,
this property is ignored.
You can use the following values for the filter
property:
- A value of
"add"plays the effect on any targets that are added as a child to a container. - A value of
"addItem"plays the effect on the item renderer for any list items added to a List or TileList control. - A value of
"hide"plays the effect on any targets whose visible property changed fromtruetofalse. - A value of
"move"plays the effect on any targets that changed theirxoryproperties. - A value of
"remove"plays the effect on any targets that are removed as a child of a container. - A value of
"removeItem"plays the effect on the item renderer for any list items removed from a List or TileList control. - A value of
"replacedItem"plays the effect on the item renderer for any list items replaced in a List or TileList control by a new item. - A value of
"replacementItem"plays the effect on the item renderer for any list items added to a List or TileList control that replaces an existing item. - A value of
"resize"plays the effect on any targets that changed theirwidthorheightproperties. - A value of
"show"plays the effect on any targets whose visible property changed fromfalsetotrue. - A value of
""specifies no filtering.
Implementação
public function get filter():String public function set filter(value:String):voidhideFocusRing | propriedade |
hideFocusRing:Boolean| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Determines whether the effect should hide the focus ring when starting the effect. The effect target is responsible for the hiding the focus ring. Subclasses of the UIComponent class hide the focus ring automatically. If the effect target is not a subclass of the UIComponent class, add functionality to it to hide the focus ring.
Set this property to true
to hide the focus ring during the effect.
For subclasses of Effect, the default value is false.
For subclasses of MaskEffect, the default value is true.
Implementação
public function get hideFocusRing():Boolean public function set hideFocusRing(value:Boolean):voidinstanceClass | propriedade |
public var instanceClass:Class| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
An object of type Class that specifies the effect instance class class for this effect class.
All subclasses of the Effect class must set this property in their constructor.
isPlaying | propriedade |
isPlaying:Boolean [somente leitura] | Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
A read-only flag which is true if any instances of the effect are currently playing, and false if none are.
Implementação
public function get isPlaying():BooleanperElementOffset | propriedade |
perElementOffset:Number| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Additional delay, in milliseconds, for effect targets
after the first target of the effect.
This value is added to the value
of the startDelay property.
Implementação
public function get perElementOffset():Number public function set perElementOffset(value:Number):voidplayheadTime | propriedade |
playheadTime:Number| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Current time position of the effect.
This property has a value between 0 and the total duration,
which includes the Effect's startDelay,
repeatCount, and repeatDelay.
Implementação
public function get playheadTime():Number public function set playheadTime(value:Number):voidrelevantProperties | propriedade |
relevantProperties:Array| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
An Array of property names to use when performing filtering. This property is used internally and should not be set by effect users.
The default value is equal to the Array returned by
the getAffectedProperties() method.
Implementação
public function get relevantProperties():Array public function set relevantProperties(value:Array):voidrelevantStyles | propriedade |
relevantStyles:Array| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
An Array of style names to use when performing filtering. This property is used internally and should not be set by effect users.
The default value is equal to the Array returned by
the getAffectedProperties() method.
Implementação
public function get relevantStyles():Array public function set relevantStyles(value:Array):voidrepeatCount | propriedade |
public var repeatCount:int = 1| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Number of times to repeat the effect.
Possible values are any integer greater than or equal to 0.
A value of 1 means to play the effect once.
A value of 0 means to play the effect indefinitely
until stopped by a call to the end() method.
O valor padrão é 1.
repeatDelay | propriedade |
public var repeatDelay:int = 0| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Amount of time, in milliseconds, to wait before repeating the effect. Possible values are any integer greater than or equal to 0.
O valor padrão é 0.
startDelay | propriedade |
public var startDelay:int = 0| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Amount of time, in milliseconds, to wait before starting the effect.
Possible values are any int greater than or equal to 0.
If the effect is repeated by using the repeatCount
property, the startDelay is only applied
to the first time the effect is played.
O valor padrão é 0.
suspendBackgroundProcessing | propriedade |
public var suspendBackgroundProcessing:Boolean = false| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
If true, blocks all background processing
while the effect is playing.
Background processing includes measurement, layout, and
processing responses that have arrived from the server.
The default value is false.
You are encouraged to set this property to
true in most cases, because it improves
the performance of the application.
However, the property should be set to false
if either of the following is true:
- User input can arrive while the effect is playing, and the application must respond to the user input before the effect finishes playing.
- A response can arrive from the server while the effect is playing, and the application must process the response while the effect is still playing.
O valor padrão é false.
target | propriedade |
target:Object| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
The object to which this effect is applied.
When an effect is triggered by an effect trigger,
the target property is automatically set to be
the object that triggers the effect.
Implementação
public function get target():Object public function set target(value:Object):voidtargets | propriedade |
targets:Array| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
An Array of objects that are targets for the effect.
When the effect is playing, it performs the effect on each target
in parallel.
Setting the target property replaces all objects
in this Array.
When the targets property is set, the target
property returns the first item in this Array.
Implementação
public function get targets():Array public function set targets(value:Array):voidtriggerEvent | propriedade |
triggerEvent:Event| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
The Event object passed to this Effect
by the EffectManager when an effect is triggered,
or null if the effect is not being
played by the EffectManager.
Implementação
public function get triggerEvent():Event public function set triggerEvent(value:Event):voidEffect | () | Construtor |
public function Effect(target:Object = null)| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Constructor.
Starting an effect is usually a three-step process:
- Create an instance of the effect object
with the
newoperator. - Set properties on the effect object,
such as
duration. - Call the
play()method or assign the effect to a trigger.
target:Object (default = null) |
applyValueToTarget | () | método |
protected function applyValueToTarget(target:Object, property:String, value:*, props:Object):void| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Used internally by the Effect infrastructure.
If captureStartValues() has been called,
then when Flex calls the play() method, it uses this function
to set the targets back to the starting state.
The default behavior is to take the value captured
using the getValueFromTarget() method
and set it directly on the target's property. For example:
target[property] = value;
Only override this method if you need to apply
the captured values in a different way.
Note that style properties of a target are set
using a different mechanism.
Use the relevantStyles property to specify
which style properties to capture and apply.
Parâmetros
target:Object — The effect target.
| |
property:String — The target property.
| |
value:* — The value of the property.
| |
props:Object — Array of Objects, where each Array element contains a
start and end Object
for the properties that the effect is monitoring.
|
captureEndValues | () | método |
public function captureEndValues():void| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Captures the current values of the relevant properties on the effect's targets and saves them as end values.
Flex automatically calls the captureEndValues() method
when the effect is part of a data change effect.
captureMoreStartValues | () | método |
public function captureMoreStartValues(targets:Array):void| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Captures the current values of the relevant properties of an additional set of targets
Flex uses this function when a data change effect is run.
Parâmetros
targets:Array — Array of targets for which values are captured
|
captureStartValues | () | método |
public function captureStartValues():void| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Captures the current values of the relevant properties
on the effect's targets.
Flex automatically calls the captureStartValues()
method when the effect is part of a transition.
Use this function when you want the effect to figure out the start and end values of the effect. The proper usage of this function is to use it in the following steps:
- Call the
captureStartValues()method. The effect captures the starting effect values. - Make changes to your effect targets, such as adding/removing children, altering properties, changing location, or changing dimensions.
- Call the
play()method. The effect captures the end values. This function populates theEffectInstance.propertyChangesproperty for each effect instance created by this effect. Effect developers can use thepropertyChangesproperty to retrieve the start and end values for their effect.
createInstance | () | método |
public function createInstance(target:Object = null):IEffectInstance| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Creates a single effect instance and initializes it.
Use this method instead of the play() method
to manipulate the effect instance properties
before the effect instance plays.
The effect instance is created with the type
specified in the instanceClass property.
It is then initialized using the initInstance() method.
If the instance was created by the EffectManager
(when the effect is triggered by an effect trigger),
the effect is further initialized by a call to the
EffectInstance.initEffect() method.
Calling the createInstance() method
does not play the effect.
Call the startEffect() method
on the returned effect instance.
This function is automatically called by the
Effect.play() method.
Parâmetros
target:Object (default = null) |
IEffectInstance — The effect instance object for the effect.
|
createInstances | () | método |
public function createInstances(targets:Array = null):Array| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Takes an Array of target objects and invokes the
createInstance() method on each target.
Parâmetros
targets:Array (default = null) |
Array — Array of effect instance objects, one per target,
for the effect.
|
deleteInstance | () | método |
public function deleteInstance(instance:IEffectInstance):void| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Removes event listeners from an instance and removes it from the list of instances.
Parâmetros
instance:IEffectInstance — The effect instance.
|
effectEndHandler | () | método |
protected function effectEndHandler(event:EffectEvent):void| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Called when an effect instance has finished playing. If you override this method, ensure that you call the super method.
Parâmetros
event:EffectEvent — An event object of type EffectEvent.
|
effectStartHandler | () | método |
protected function effectStartHandler(event:EffectEvent):void| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
This method is called when the effect instance starts playing. If you override this method, ensure that you call the super method.
Parâmetros
event:EffectEvent — An event object of type EffectEvent.
|
effectStopHandler | () | método |
protected function effectStopHandler(event:EffectEvent):void| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Called when an effect instance has stopped by a call
to the stop() method.
If you override this method, ensure that you call the super method.
Parâmetros
event:EffectEvent — An event object of type EffectEvent.
|
end | () | método |
public function end(effectInstance:IEffectInstance = null):void| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Interrupts an effect that is currently playing,
and jumps immediately to the end of the effect.
Calling this method invokes the EffectInstance.end()
method.
The effect instance dispatches an effectEnd event
when you call this method as part of ending the effect.
If you pass an effect instance as an argument, just that instance is interrupted. If no argument is passed in, all effect instances currently spawned from the effect are interrupted.
Parâmetros
effectInstance:IEffectInstance (default = null) |
filterInstance | () | método |
protected function filterInstance(propChanges:Array, target:Object):Boolean| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Determines the logic for filtering out an effect instance. The CompositeEffect class overrides this method.
Parâmetros
propChanges:Array — The properties modified by the effect.
| |
target:Object — The effect target.
|
Boolean — Returns true if the effect instance should play.
|
getAffectedProperties | () | método |
public function getAffectedProperties():Array| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Returns an Array of Strings, where each String is the name
of a property changed by this effect.
For example, the Move effect returns an Array that contains
"x" and "y".
Every subclass of Effect must implement this method. The EffectManager uses this method to ensure that no two effects are trying to animate the same property of the same object at the same time.
RetornaArray — An Array of Strings specifying the names of the
properties modified by this effect.
|
Mais exemplos
getValueFromTarget | () | método |
protected function getValueFromTarget(target:Object, property:String):*| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Called by the captureStartValues() method to get the value
of a property from the target.
This function should only be called internally
by the effects framework.
The default behavior is to simply return target[property].
Effect developers can override this function
if you need a different behavior.
Parâmetros
target:Object — The effect target.
| |
property:String — The target property.
|
* — The value of the target property.
|
initInstance | () | método |
protected function initInstance(instance:IEffectInstance):void| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Copies properties of the effect to the effect instance.
Flex calls this method from the Effect.createInstance()
method; you do not have to call it yourself.
When you create a custom effect, override this method to
copy properties from the Effect class to the effect instance class.
In your override, call super.initInstance().
Parâmetros
instance:IEffectInstance — The effect instance to initialize.
|
Mais exemplos
pause | () | método |
public function pause():void| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Pauses the effect until you call the resume() method.
play | () | método |
public function play(targets:Array = null, playReversedFromEnd:Boolean = false):Array| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Begins playing the effect.
You typically call the end() method
before you call the play() method
to ensure that any previous instance of the effect
has ended before you start a new one.
All subclasses must implement this method.
Parâmetros
targets:Array (default = null)targets
property is not used.
| |
playReversedFromEnd:Boolean (default = false)true,
play the effect backwards.
|
Array — Array of EffectInstance objects, one per target,
for the effect.
|
resume | () | método |
public function resume():void| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Resumes the effect after it has been paused
by a call to the pause() method.
reverse | () | método |
public function reverse():void| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Plays the effect in reverse, if the effect is currently playing, starting from the current position of the effect.
stop | () | método |
public function stop():void| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Stops the effect, leaving the effect targets in their current state.
Unlike a call to the pause() method,
you cannot call the resume() method after calling
the stop() method.
However, you can call the play() method to restart the effect.
The effect instance dispatches an effectEnd event
when you call this method as part of ending the effect.
For mask effects, the mask is not removed automatically when the effect is stopped. Running further mask effects on the same target(s) without first removing the mask can produce unexpected results.
effectEnd | Evento |
mx.events.EffectEventpropriedade EffectEvent.type =
mx.events.EffectEvent.EFFECT_END| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Dispatched when one of the effect's instances finishes playing,
either when the instance finishes playing or when the effect
is interrupted by a call to the end() method.
EffectEvent.EFFECT_END constant defines the value of the
type property of the event object for an
effectEnd event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
effectInstance | The effect instance object for the event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
effectStart | Evento |
mx.events.EffectEventpropriedade EffectEvent.type =
mx.events.EffectEvent.EFFECT_START| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Dispatched when the effect starts playing.
TheEffectEvent.EFFECT_START constant defines the value of the
type property of the event object for an
effectStart event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
effectInstance | The effect instance object for the event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
effectStop | Evento |
mx.events.EffectEventpropriedade EffectEvent.type =
mx.events.EffectEvent.EFFECT_STOP| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Dispatched when the effect has been stopped,
which only occurs when the effect is
interrupted by a call to the stop() method.
The EFFECT_END event is also dispatched to indicate that
the effect has ended. This extra event is sent first, as an
indicator to listeners that the effect did not reach its
end state.
EffectEvent.EFFECT_STOP constant defines the value of the
type property of the event object for an
effectStop event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
effectInstance | The effect instance object for the event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
<?xml version="1.0"?>
<!-- Simple example to demonstrate the Effect 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.controls.Alert;
// Event handler for the effectEnd event.
private function endEffectHandler():void {
Alert.show("Effect Ended!");
}
// Event handler for the reset button.
private function resetHandler():void {
expand.end();
img.width=30;
img.height=60;
button1.enabled=true;
}
]]>
</fx:Script>
<fx:Declarations>
<mx:Resize id="expand" target="{img}" widthTo="100" heightTo="200"
duration="10000" effectEnd="endEffectHandler();"/>
</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 control the Resize effect."/>
<mx:Image id="img" width="30" height="60"
source="@Embed(source='assets/Nokia_6630.png')"/>
<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>
Wed Jun 13 2018, 11:10 AM Z