| Paket | mx.effects |
| Klass | public class EffectInstance |
| Arv | EffectInstance  EventDispatcher Object |
| Implementerar | IEffectInstance |
| Underklasser | ActionEffectInstance, AnimateInstance, CompositeEffectInstance, MaskEffectInstance, SoundEffectInstance, TweenEffectInstance |
| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Effect developers must create an instance class for their custom effects.
Fler exempel
Relaterade API-element
Dölj ärvda publika egenskaper
Visa ärvda publika egenskaper| Egenskap | Definieras med | ||
|---|---|---|---|
| className : String [skrivskyddad]
The name of the effect class, such as "FadeInstance". | EffectInstance | ||
 | constructor : Object
En referens till klassobjektet eller konstruktorfunktionen för en given objektinstans. | Object | |
| duration : Number
The duration of the effect, in milliseconds. | EffectInstance | ||
| effect : IEffect
The IEffect object that created this IEffectInstance object. | EffectInstance | ||
| effectTargetHost : mx.effects:IEffectTargetHost
A property that lets you access the target
list-based control of a data effect. | EffectInstance | ||
| hideFocusRing : Boolean
Determines whether the effect should hide
the focus ring when starting the effect. | EffectInstance | ||
| playheadTime : Number
Current time position of the effect. | EffectInstance | ||
| propertyChanges : PropertyChanges
Specifies the PropertyChanges object containing
the start and end values for the set of properties
relevant to the effect's targets. | EffectInstance | ||
| repeatCount : int
Number of times to repeat the effect. | EffectInstance | ||
| repeatDelay : int
Amount of time, in milliseconds,
to wait before repeating the effect. | EffectInstance | ||
| startDelay : int
Amount of time, in milliseconds,
to wait before starting the effect. | EffectInstance | ||
| suspendBackgroundProcessing : Boolean
If true, blocks all background processing
while the effect is playing. | EffectInstance | ||
| target : Object
The UIComponent object to which this effect is applied. | EffectInstance | ||
| triggerEvent : Event
The event, if any, which triggered the playing of the effect. | EffectInstance | ||
| Egenskap | Definieras med | ||
|---|---|---|---|
| playCount : int = 0
Number of times that the instance has been played. | EffectInstance | ||
| Metod | Definieras med | ||
|---|---|---|---|
EffectInstance(target:Object)
Constructor. | EffectInstance | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registrerar ett händelseavlyssnarobjekt för ett EventDispatcher-objekt så att avlyssnaren får meddelanden om händelser. | EventDispatcher | |
|
Skickar en händelse till händelseflödet. | EventDispatcher | |
Interrupts an effect instance that is currently playing,
and jumps immediately to the end of the effect. | EffectInstance | ||
Called by the end() method when the effect
finishes playing. | EffectInstance | ||
Called after each iteration of a repeated effect finishes playing. | EffectInstance | ||
|
Kontrollerar om EventDispatcher-objektet har några avlyssnare registrerade för en viss typ av händelse. | EventDispatcher | |
|
Anger om det finns en egenskap angiven för ett objekt. | Object | |
This method is called if the effect was triggered by the EffectManager. | EffectInstance | ||
|
Anger om en instans av klassen Object finns i prototypkedjan för objektet som anges som parameter. | Object | |
Pauses the effect until you call the resume() method. | EffectInstance | ||
Plays the effect instance on the target. | EffectInstance | ||
|
Anger om den angivna egenskapen finns och är uppräkningsbar. | Object | |
|
Tar bort en avlyssnare från EventDispatcher-objektet. | EventDispatcher | |
Resumes the effect after it has been paused
by a call to the pause() method. | EffectInstance | ||
Plays the effect in reverse, starting from
the current position of the effect. | EffectInstance | ||
|
Anger tillgänglighet för en dynamisk egenskap för slingåtgärder. | Object | |
Plays the effect instance on the target after the
startDelay period has elapsed. | EffectInstance | ||
Stops the effect, leaving the target in its current state. | EffectInstance | ||
|
Returnerar det här objektets strängrepresentation, formaterad i enlighet med språkspecifika konventioner. | Object | |
|
Returnerar det angivna objektets strängbeteckning. | Object | |
|
Returnerar det angivna objektets primitiva värde. | Object | |
|
Kontrollerar om en händelseavlyssnare är registrerad för det här EventDispatcher-objektet eller något av dess överordnade objekt för den angivna händelsetypen. | EventDispatcher | |
className | egenskap |
className:String [skrivskyddad] | Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
The name of the effect class, such as "FadeInstance".
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.
Implementering
public function get className():Stringduration | egenskap |
effect | egenskap |
effectTargetHost | egenskap |
effectTargetHost:mx.effects:IEffectTargetHost| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | 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.
Implementering
public function get effectTargetHost():mx.effects:IEffectTargetHost public function set effectTargetHost(value:mx.effects:IEffectTargetHost):voidhideFocusRing | egenskap |
hideFocusRing:Boolean| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | 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, 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.
Implementering
public function get hideFocusRing():Boolean public function set hideFocusRing(value:Boolean):voidplayCount | egenskap |
protected var playCount:int = 0| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Number of times that the instance has been played.
playheadTime | egenskap |
playheadTime:Number| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | 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.
Implementering
public function get playheadTime():Number public function set playheadTime(value:Number):voidpropertyChanges | egenskap |
propertyChanges:PropertyChanges| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Specifies the PropertyChanges object containing
the start and end values for the set of properties
relevant to the effect's targets.
This property is only set if the
captureStartValues() method was called
on the effect that created this effect instance.
You often use the propertyChanges property
to create an effect that is used as part of a transition.
Flex automatically calls the captureStartValues()
method when it starts a transition.
Within your override of the Effectinstance.play()
method, you can examine the information within the
propertyChanges() method to initialize
the start and end values of the effect.
Implementering
public function get propertyChanges():PropertyChanges public function set propertyChanges(value:PropertyChanges):voidFler exempel
repeatCount | egenskap |
repeatCount:int| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Number of times to repeat the effect. Possible values are any integer greater than or equal to 0.
Implementering
public function get repeatCount():int public function set repeatCount(value:int):voidrepeatDelay | egenskap |
startDelay | egenskap |
startDelay:int| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | 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 property is applied
only the first time the effect is played.
Implementering
public function get startDelay():int public function set startDelay(value:int):voidsuspendBackgroundProcessing | egenskap |
suspendBackgroundProcessing:Boolean| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | 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.
Implementering
public function get suspendBackgroundProcessing():Boolean public function set suspendBackgroundProcessing(value:Boolean):voidtarget | egenskap |
triggerEvent | egenskap |
triggerEvent:Event| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
The event, if any, which triggered the playing of the effect. This property is useful when an effect is assigned to multiple triggering events.
If the effect was played programmatically by a call to the
play() method, rather than being triggered by an event,
this property is null.
Implementering
public function get triggerEvent():Event public function set triggerEvent(value:Event):voidEffectInstance | () | Konstruktor |
end | () | metod |
public function end():void| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Interrupts an effect instance that is currently playing,
and jumps immediately to the end of the effect.
This method is invoked by a call
to the Effect.end() method.
As part of its implementation, it calls
the finishEffect() method.
The effect instance dispatches an effectEnd event
when you call this method as part of ending the effect.
In a subclass of EffectInstance,
you can optionally override this method
As part of your override, you should call
the super.end() method
from the end of your override, after your logic.
Fler exempel
finishEffect | () | metod |
public function finishEffect():void| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Called by the end() method when the effect
finishes playing.
This function dispatches an endEffect event
for the effect target.
You do not have to override this method in a subclass. You do not need to call this method when using effects, but you may need to call it if you create an effect subclass.
finishRepeat | () | metod |
public function finishRepeat():void| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Called after each iteration of a repeated effect finishes playing.
You do not have to override this method in a subclass. You do not need to call this method when using effects.
initEffect | () | metod |
public function initEffect(event:Event):void| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
This method is called if the effect was triggered by the EffectManager.
This base class version saves the event that triggered the effect
in the triggerEvent property.
Each subclass should override this method.
Parametrar
event:Event — The Event object that was dispatched
to trigger the effect.
For example, if the trigger was a mouseDownEffect, the event
would be a MouseEvent with type equal to MouseEvent.MOUSEDOWN.
|
pause | () | metod |
public function pause():void| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Pauses the effect until you call the resume() method.
play | () | metod |
public function play():void| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Plays the effect instance on the target.
Call the startEffect() method instead
to make an effect start playing on an EffectInstance.
In a subclass of EffectInstance, you must override this method.
The override must call the super.play() method
so that an effectStart event is dispatched
from the target.
Fler exempel
resume | () | metod |
public function resume():void| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Resumes the effect after it has been paused
by a call to the pause() method.
reverse | () | metod |
public function reverse():void| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Plays the effect in reverse, starting from the current position of the effect.
startEffect | () | metod |
public function startEffect():void| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Plays the effect instance on the target after the
startDelay period has elapsed.
Called by the Effect class.
Use this function instead of the play() method
when starting an EffectInstance.
stop | () | metod |
public function stop():void| Språkversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Stops the effect, leaving the target in its current state.
This method is invoked by a call
to the Effect.stop() method.
As part of its implementation, it calls
the finishEffect() method.
The effect instance dispatches an effectEnd event
when you call this method as part of ending the effect.
Tue Jun 12 2018, 01:40 PM Z