| Pacote | mx.effects |
| Classe | public class Effect |
| Herança | Effect  EventDispatcher Object |
| Implementa | IEffect |
| Subclasses | AddChildAction, AddItemAction, CompositeEffect, MaskEffect, RemoveChildAction, RemoveItemAction, SetPropertyAction, SetStyleAction, SoundEffect, TweenEffect, UnconstrainItemAction |
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 em MXML
Hide MXML Syntax
The Effect class defines the following properties, which all of its subclasses inherit:
Show MXML Syntax
<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"
Eventos
effectEnd="No default"
efectStart="No default"
/>
Veja também
| Propriedade | Definido por | ||
|---|---|---|---|
| className : String
[read-only]
The name of the effect class, such as "Fade".
| Effect | ||
 | constructor : Object
A reference to the class object or constructor function for a given object instance.
| Object | |
| customFilter : 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 : 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 : Classe
An object of type Classe that specifies the effect
instance class class for this effect class.
| Effect | ||
| isPlaying : Boolean
[read-only]
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 | ||
| prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
| 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
Number of times to repeat the effect.
| Effect | ||
| repeatDelay : int
Amount of time, in milliseconds, to wait before repeating the effect.
| Effect | ||
| startDelay : int
Amount of time, in milliseconds, to wait before starting the effect.
| Effect | ||
| suspendBackgroundProcessing : Boolean
If true, blocks all background processing
while the effect is playing.
| Effect | ||
| target : Object
The UIComponent object to which this effect is applied.
| Effect | ||
| targets : Array
An Array of UIComponent 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 | ||
|---|---|---|---|
| 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
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event.
| 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
This function is used by Flex 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 | ||
|
Dispatches an event into the event flow.
| 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 that is changed by this effect.
| Effect | ||
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event.
| EventDispatcher | |
|
Indicates whether an object has a specified property defined.
| Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter.
| Object | |
|
Pauses the effect until you call the resume() method.
| Effect | ||
|
Begins playing the effect.
| Effect | ||
|
Indicates whether the specified property exists and is enumerable.
| Object | |
|
Removes a listener from the EventDispatcher object.
| 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 | ||
|
Sets the availability of a dynamic property for loop operations.
| Object | |
|
Stops the effect, leaving the effect targets in their current state.
| Effect | ||
|
Returns the string representation of the specified object.
| Object | |
|
Returns the primitive value of the specified object.
| Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type.
| 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 | ||
|
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 | Descrição | Definido por | ||
|---|---|---|---|---|
| Dispatched when Flash Player or the and AIR application gains operating system focus and becomes active. | EventDispatcher | ||
| Dispatched when Flash Player loses operating system focus and is becoming inactive. | EventDispatcher | ||
| Dispatched when the effect finishes playing, either when the effect finishes playing or when the effect has been interrupted by a call to the end() method. | Effect | |||
| Dispatched when the effect starts playing. | Effect | |||
| className | propriedade |
className:String [read-only]
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.
public function get className():String
| customFilter | propriedade |
customFilter:EffectTargetFilter [read-write] 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.
public function get customFilter():EffectTargetFilter
public function set customFilter(value:EffectTargetFilter):void
| duration | propriedade |
duration:Number [read-write] Duration of the effect in milliseconds.
In a Parallel or Sequence effect, the duration
property sets the duration of each effect.
For exemplo, 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.
public function get duration():Number
public function set duration(value:Number):void
| effectTargetHost | propriedade |
effectTargetHost:IEffectTargetHost [read-write] 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.
public function get effectTargetHost():IEffectTargetHost
public function set effectTargetHost(value:IEffectTargetHost):void
| endValuesCaptured | propriedade |
protected var 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.
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.
The default value is false.
| filter | propriedade |
filter:String [read-write]
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:
"add" plays the effect on any targets
that are added as a child to a container."addItem" plays the effect
on the item renderer for any list items added to a List
or TileList control."hide" plays the effect on any targets
whose visible property changed from true to
false."move" plays the effect on any targets
that changed their x or y
properties."remove" plays the effect on any targets
that are removed as a child of a container."removeItem" plays the effect
on the item renderer for any list items removed from a List
or TileList control."replacedItem" plays the effect
on the item renderer for any list items replaced in a List
or TileList control by a new item."replacementItem" plays the effect
on the item renderer for any list items added to a List
or TileList control that replaces an existing item."resize" plays the effect
on any targets that changed their width
or height properties."show" plays the effect
on any targets whose visible property changed
from false to true."" specifies no filtering.
public function get filter():String
public function set filter(value:String):void
| hideFocusRing | propriedade |
hideFocusRing:Boolean [read-write] 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, you must 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.
public function get hideFocusRing():Boolean
public function set hideFocusRing(value:Boolean):void
| instanceClass | propriedade |
instanceClass:Classe [read-write] An object of type Classe that specifies the effect instance class class for this effect class.
All subclasses of the Effect class must set this property in their constructor.
public function get instanceClass():Classe
public function set instanceClass(value:Classe):void
| isPlaying | propriedade |
isPlaying:Boolean [read-only] A read-only flag which is true if any instances of the effect are currently playing, and false if none are.
public function get isPlaying():Boolean
| perElementOffset | propriedade |
perElementOffset:Number [read-write]
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.
public function get perElementOffset():Number
public function set perElementOffset(value:Number):void
| relevantProperties | propriedade |
relevantProperties:Array [read-write] 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.
public function get relevantProperties():Array
public function set relevantProperties(value:Array):void
| relevantStyles | propriedade |
relevantStyles:Array [read-write] 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.
public function get relevantStyles():Array
public function set relevantStyles(value:Array):void
| repeatCount | propriedade |
repeatCount:int [read-write]
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.
public function get repeatCount():int
public function set repeatCount(value:int):void
| repeatDelay | propriedade |
repeatDelay:int [read-write] Amount of time, in milliseconds, to wait before repeating the effect. Possible values are any integer greater than or equal to 0.
public function get repeatDelay():int
public function set repeatDelay(value:int):void
| startDelay | propriedade |
startDelay:int [read-write]
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.
public function get startDelay():int
public function set startDelay(value:int):void
| suspendBackgroundProcessing | propriedade |
suspendBackgroundProcessing:Boolean [read-write]
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:
public function get suspendBackgroundProcessing():Boolean
public function set suspendBackgroundProcessing(value:Boolean):void
| target | propriedade |
target:Object [read-write]
The UIComponent 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.
public function get target():Object
public function set target(value:Object):void
| targets | propriedade |
targets:Array [read-write]
An Array of UIComponent 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.
public function get targets():Array
public function set targets(value:Array):void
| triggerEvent | propriedade |
triggerEvent:Event [read-write]
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.
public function get triggerEvent():Event
public function set triggerEvent(value:Event):void
| Effect | () | Construtor |
public function Effect(target:Object = null)
Constructor.
Starting an effect is usually a three-step process:
new operator.duration.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
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 exemplo:
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
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
Captures the current values of the relevant properties of an additional set of targets
This function is used by Flex when a data change effect is run.
Parâmetros
targets:Array — Array of targets for which values will be captured
|
| captureStartValues | () | método |
public function captureStartValues():void
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:
captureStartValues() method.
The effect captures the starting effect values.play() method.
The effect captures the end values.
This function populates the
EffectInstance.propertyChanges property
for each effect instance created by this effect.
Effect developers can use the propertyChanges property
to retrieve the start and end values for their effect.
| createInstance | () | método |
public function createInstance(target:Object = null):IEffectInstance
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.
You must 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
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
Removes event listeners from an instance and removes it from the list of instances.
Parâmetros
instance:IEffectInstance |
| effectEndHandler | () | método |
protected function effectEndHandler(event:EffectEvent):void
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
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.
|
| end | () | método |
public function end(effectInstance:IEffectInstance = null):void
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
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
Returns an Array of Strings, where each String is the name
of a property that is changed by this effect.
For exemplo, the Move effect returns an Array that contains
"x" and "y".
Every subclass of Effect must implement this method. The method is used by the EffectManager to ensure that no two effects are trying to animate the same property of the same object at the same time.
Retorna
Array — An Array of Strings specifying the names of the
properties modified by this effect.
|
| getValueFromTarget | () | método |
protected function getValueFromTarget(target:Object, property:String):*
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
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, you must call super.initInstance().
Parâmetros
instance:IEffectInstance — The effect instance to initialize.
|
| pause | () | método |
| play | () | método |
public function play(targets:Array = null, playReversedFromEnd:Boolean = false):Array
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
Resumes the effect after it has been paused
by a call to the pause() method.
| reverse | () | método |
public function reverse():void
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
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 may produce unexpected results.
| effectEnd | Evento |
mx.events.EffectEvent
mx.events.EffectEvent.EFFECT_END
Dispatched when the effect finishes playing,
either when the effect finishes playing or when the effect has
been 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:
| Propriedade | Valor |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For exemplo, 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.EffectEvent
mx.events.EffectEvent.EFFECT_START
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:
| Propriedade | Valor |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For exemplo, 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 exemplo to demonstrate the Effect class. -->
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">
<mx: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;
}
]]>
</mx:Script>
<mx:Resize id="expand" target="{img}" widthTo="100" heightTo="200"
duration="10000" effectEnd="endEffectHandler();"/>
<mx:Panel title="Resize Effect Example" width="100%" height="100%"
paddingTop="10" paddingLeft="10" paddingRight="10" paddingBottom="10">
<mx:Text 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')"/>
<mx:ControlBar>
<mx:Button id="button1" label="Start" click="expand.play(); button1.enabled=false;"/>
<mx:Button label="Pause" click="expand.pause();"/>
<mx:Button label="Resume" click="expand.resume();"/>
<mx:Button label="Reverse" click="expand.reverse();"/>
<mx:Button label="End" click="expand.end();"/>
<mx:Button label="Reset" click="resetHandler();"/>
</mx:ControlBar>
</mx:Panel>
</mx:Application>