| Pakket | mx.effects |
| Klasse | public class TweenEffect |
| Overerving | TweenEffect  Effect EventDispatcher Object |
| Subklassen | AnimateProperty, Blur, Dissolve, Fade, Glow, Move, Pause, Resize, Rotate, SeriesEffect, Zoom |
| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
 | spark.effects.Animate TweenEffect is the superclass for the animated effects in Flex 3. As of Flex 4, the Spark effects extend the spark.effects.Animate class instead of TweenEffect. |
The TweenEffect class is the superclass for all effects that are based on the Tween object. This class encapsulates methods and properties that are common among all Tween-based effects, to avoid duplication of code elsewhere.
You create a subclass of the TweenEffect class to define an effect that plays an animation over a period of time. For example, the Resize effect modifies the size of its target over a specified duration.
MXML-syntaxis
MXML-syntaxis weergeven
MXML-syntaxis verbergenThe <mx:TweenEffect> tag
inherits all of the tag attributes of its superclass,
and adds the following tag attributes:
<mx:TagName
Properties
easingFunction="easing function name; no default"
Events
tweenEnd="No default"
/>
Meer voorbeelden
Verwante API-elementen
| Eigenschap | Gedefinieerd door | ||
|---|---|---|---|
 | className : String [alleen-lezen]
The name of the effect class, such as "Fade". | Effect | |
| constructor : Object
Verwijzing naar het klasseobject of de constructorfunctie van een bepaalde objectinstantie. | 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 | |
| easingFunction : Function = null
The easing function for the animation. | TweenEffect | ||
| 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 [alleen-lezen]
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 | |
| Methode | Gedefinieerd door | ||
|---|---|---|---|
TweenEffect(target:Object = null)
Constructor. | TweenEffect | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registreert een gebeurtenislistenerobject bij een object EventDispatcher, zodat de listener een melding van een gebeurtenis ontvangt. | 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 | |
|
Verzendt een gebeurtenis naar de gebeurtenisstroom. | 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 | |
|
Controleert of het object EventDispatcher listeners heeft geregistreerd voor een specifiek type gebeurtenis. | EventDispatcher | |
|
Geeft aan of voor een object een opgegeven eigenschap is gedefinieerd. | Object | |
|
Geeft aan of een instantie van de klasse Object zich in de prototypeketen van het object bevindt dat als parameter is opgegeven. | Object | |
|
Pauses the effect until you call the resume() method. | Effect | |
|
Begins playing the effect. | Effect | |
|
Geeft aan of de opgegeven eigenschap bestaat en kan worden opgesomd. | Object | |
|
Verwijdert een listener uit het object 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 | |
|
Stelt de beschikbaarheid van een dynamische eigenschap voor lusbewerkingen in. | Object | |
|
Stops the effect, leaving the effect targets in their current state. | Effect | |
|
Geeft de tekenreeksweergave van dit object weer, geformatteerd volgens de locatiespecifieke conventies. | Object | |
|
Retourneert een tekenreeksrepresentatie van het opgegeven object. | Object | |
|
Retourneert de primitieve waarde van het opgegeven object. | Object | |
|
Controleert of een gebeurtenislistener is geregistreerd bij dit object EventDispatcher of een van de voorouders voor het opgegeven type gebeurtenis. | EventDispatcher | |
| Methode | Gedefinieerd door | ||
|---|---|---|---|
|
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 | |
Called when the TweenEffect dispatches a TweenEvent. | TweenEffect | ||
| Gebeurtenis | Overzicht | Gedefinieerd door | ||
|---|---|---|---|---|
| [uitgezonden gebeurtenis] Wordt verzonden wanneer Flash Player of de AIR-toepassing de besturingssysteemfocus krijgt en actief wordt. | EventDispatcher | ||
| [uitgezonden gebeurtenis] Wordt verzonden wanneer Flash Player of de AIR-toepassing de systeemfocus verliest en inactief wordt. | 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 | ||
| Dispatched when the tween effect ends. | TweenEffect | |||
| Dispatched when the tween effect starts, which corresponds to the first call to the onTweenUpdate() method. | TweenEffect | |||
| Dispatched every time the tween effect updates the target. | TweenEffect | |||
easingFunction | eigenschap |
public var easingFunction:Function = null| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
The easing function for the animation. The easing function is used to interpolate between the initial value and the final value. A trivial easing function would simply do linear interpolation, but more sophisticated easing functions create the illusion of acceleration and deceleration, which makes the animation seem more natural.
If no easing function is specified, an easing function based
on the Math.sin() method is used.
The easing function follows the function signature popularized by Robert Penner. The function accepts four arguments. The first argument is the "current time", where the animation start time is 0. The second argument is the initial value at the beginning of the animation (a Number). The third argument is the ending value minus the initial value. The fourth argument is the duration of the animation. The return value is the interpolated value for the current time. This is usually a value between the initial value and the ending value.
The value of this property must be a function object.
Flex includes a set of easing functions in the mx.effects.easing package.
TweenEffect | () | Constructor |
tweenEventHandler | () | methode |
protected function tweenEventHandler(event:mx.events:TweenEvent):void| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Called when the TweenEffect dispatches a TweenEvent. If you override this method, ensure that you call the super method.
Parameters
event:mx.events:TweenEvent — An event object of type TweenEvent.
|
tweenEnd | Gebeurtenis |
mx.events.TweenEventeigenschap TweenEvent.type =
mx.events.TweenEvent.TWEEN_END| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Dispatched when the tween effect ends.
This event corresponds to a call to
the TweenEffectInstance.onTweenEnd() method.
When a tween effect plays a single time, this event occurs
at the same time as an effectEnd event.
If you configure the tween effect to repeat,
it occurs at the end of every repetition of the effect,
and the endEffect event occurs
after the effect plays for the final time.
TweenEvent.TWEEN_END constant defines the value of the
event object's type property for a tweenEnd 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. |
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. |
value | The value passed to the
onTweenEnd() method. |
tweenStart | Gebeurtenis |
mx.events.TweenEventeigenschap TweenEvent.type =
mx.events.TweenEvent.TWEEN_START| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Dispatched when the tween effect starts, which corresponds to the
first call to the onTweenUpdate() method.
Flex also dispatches the first tweenUpdate event
for the effect at the same time.
The Effect.effectStart event is dispatched
before the tweenStart event.
TweenEvent.TWEEN_START constant defines the value of the
event object's type property for a tweenStart 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. |
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. |
value | The value passed to the
onTweenUpdate() method. |
tweenUpdate | Gebeurtenis |
mx.events.TweenEventeigenschap TweenEvent.type =
mx.events.TweenEvent.TWEEN_UPDATE| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Dispatched every time the tween effect updates the target.
This event corresponds to a call to
the TweenEffectInstance.onTweenUpdate() method.
TweenEvent.TWEEN_UPDATE constant defines the value of the
event object's type property for a tweenUpdate 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. |
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. |
value | The value passed to the
onTweenUpdate() method. |
<?xml version="1.0"?>
<!-- Simple example to demonstrate the TweenEffect 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.events.TweenEvent;
// Event handler for the tweenUpdate and tweenEnd effects.
private function tweenUpdateHandler(event:TweenEvent):void {
// Access current width of the image.
currentWidth.text="Current width (in pixels): " + String(event.value[0]);
}
// Event handler for the reset button.
private function resetHandler():void {
expand.end();
img.width=30;
currentWidth.text="Current width (in pixels): 30";
img.height=60;
button1.enabled=true;
}
]]>
</fx:Script>
<fx:Declarations>
<mx:Resize id="expand" target="{img}" widthTo="100" heightTo="200"
duration="10000"
tweenUpdate="tweenUpdateHandler(event);"
tweenEnd="tweenUpdateHandler(event);"/>
</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 resize the image."/>
<s:HGroup width="100%">
<mx:Image id="img" width="30" height="60"
source="@Embed(source='assets/Nokia_6630.png')"/>
<s:Label id="currentWidth" height="20" width="100%"/>
</s:HGroup>
<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:42 AM Z