TweenEffect

套件	mx.effects
類別	public class TweenEffect
繼承	TweenEffect Effect EventDispatcher Object
子類別	AnimateProperty, Blur, Dissolve, Fade, Glow, Move, Pause, Resize, Rotate, SeriesEffect, Zoom

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

使用 Flex 4.0 開始，Adobe 建議您使用 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 語法

隱藏 MXML 語法

The <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"
  />

檢視範例

公用屬性

隱藏繼承公用屬性

顯示繼承公用屬性

	屬性		定義自
		className : String [唯讀] The name of the effect class, such as "Fade".	Effect
		constructor : Object 類別物件的參照或是特定物件實體的建構函數。	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 [唯讀] 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

保護屬性

隱藏繼承保護屬性

顯示繼承保護屬性

	屬性		定義自
		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

公用方法

隱藏繼承公用方法

顯示繼承公用方法

	方法		定義自
		TweenEffect(target:Object = null) Constructor.	TweenEffect
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void 會在 EventDispatcher 物件註冊事件偵聽程式，以便讓偵聽程式收到事件的通知。	EventDispatcher
		captureEndValues():void Captures the current values of the relevant properties on the effect's targets and saves them as end values.	Effect
		captureMoreStartValues(targets:Array):void 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
		captureStartValues():void Captures the current values of the relevant properties on the effect's targets.	Effect
		createInstance(target:Object = null):IEffectInstance Creates a single effect instance and initializes it.	Effect
		createInstances(targets:Array = null):Array Takes an Array of target objects and invokes the createInstance() method on each target.	Effect
		deleteInstance(instance:IEffectInstance):void Removes event listeners from an instance and removes it from the list of instances.	Effect
		dispatchEvent(event:Event):Boolean 會將事件傳送到事件流程。	EventDispatcher
		end(effectInstance:IEffectInstance = null):void Interrupts an effect that is currently playing, and jumps immediately to the end of the effect.	Effect
		getAffectedProperties():Array Returns an Array of Strings, where each String is the name of a property changed by this effect.	Effect
		hasEventListener(type:String):Boolean 會檢查 EventDispatcher 物件是否有對特定的事件類型註冊偵聽程式。	EventDispatcher
		hasOwnProperty(name:String):Boolean 指出物件是否有已定義的指定屬性。	Object
		isPrototypeOf(theClass:Object):Boolean 指出 Object 類別的實體是否位於指定為參數的物件原型鏈中。	Object
		pause():void Pauses the effect until you call the resume() method.	Effect
		play(targets:Array = null, playReversedFromEnd:Boolean = false):Array Begins playing the effect.	Effect
		propertyIsEnumerable(name:String):Boolean 指出指定的屬性是否存在，以及是否可列舉。	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 會從 EventDispatcher 物件移除偵聽程式。	EventDispatcher
		resume():void Resumes the effect after it has been paused by a call to the pause() method.	Effect
		reverse():void Plays the effect in reverse, if the effect is currently playing, starting from the current position of the effect.	Effect
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 為迴圈作業設定動態屬性的可用性。	Object
		stop():void Stops the effect, leaving the effect targets in their current state.	Effect
		toLocaleString():String 傳回代表此物件的字串，根據地區特定慣例進行格式化。	Object
		toString():String 會傳回指定之物件的字串形式。	Object
		valueOf():Object 會傳回指定之物件的基本值。	Object
		willTrigger(type:String):Boolean 檢查此 EventDispatcher 物件是否已註冊事件偵聽程式，或者此物件的任何祖系已為特定事件類型註冊事件偵聽程式。	EventDispatcher

保護方法

隱藏繼承保護方法

顯示繼承保護方法

	方法		定義自
		applyValueToTarget(target:Object, property:String, value:*, props:Object):void Used internally by the Effect infrastructure.	Effect
		effectEndHandler(event:EffectEvent):void Called when an effect instance has finished playing.	Effect
		effectStartHandler(event:EffectEvent):void This method is called when the effect instance starts playing.	Effect
		effectStopHandler(event:EffectEvent):void Called when an effect instance has stopped by a call to the stop() method.	Effect
		filterInstance(propChanges:Array, target:Object):Boolean Determines the logic for filtering out an effect instance.	Effect
		getValueFromTarget(target:Object, property:String):* Called by the captureStartValues() method to get the value of a property from the target.	Effect
		initInstance(instance:IEffectInstance):void Copies properties of the effect to the effect instance.	Effect
		tweenEventHandler(event:mx.events:TweenEvent):void Called when the TweenEffect dispatches a TweenEvent.	TweenEffect

事件

按一下以瞭解事件的詳細資訊

隱藏繼承事件

顯示繼承事件

	摘要	定義自
activate	[廣播事件] 當 Flash Player 或 AIR 應用程式取得作業系統焦點並成為作用中時傳送。	EventDispatcher
deactivate	[廣播事件] 當 Flash Player 或 AIR 應用程式失去作業系統焦點並成為非作用中時傳送。	EventDispatcher
effectEnd	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
effectStart	Dispatched when the effect starts playing.	Effect
effectStop	Dispatched when the effect has been stopped, which only occurs when the effect is interrupted by a call to the stop() method.	Effect
tweenEnd	Dispatched when the tween effect ends.	TweenEffect
tweenStart	Dispatched when the tween effect starts, which corresponds to the first call to the onTweenUpdate() method.	TweenEffect
tweenUpdate	Dispatched every time the tween effect updates the target.	TweenEffect

屬性詳細資訊

easingFunction

屬性

public var easingFunction:Function = null

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

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.

建構函式詳細資料

()

建構函式

public function TweenEffect(target:Object = null)

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

Constructor.

參數

target:Object (default = null) — The Object to animate with this effect.

方法詳細資訊

tweenEventHandler

()

方法

protected function tweenEventHandler(event:mx.events:TweenEvent):void

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

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.

參數

event:mx.events:TweenEvent — An event object of type TweenEvent.

事件詳細資訊

tweenEnd

事件

事件物件類型: mx.events.TweenEvent
屬性 TweenEvent.type = mx.events.TweenEvent.TWEEN_END

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

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.

The 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

事件

事件物件類型: mx.events.TweenEvent
屬性 TweenEvent.type = mx.events.TweenEvent.TWEEN_START

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

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.

The 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

事件

事件物件類型: mx.events.TweenEvent
屬性 TweenEvent.type = mx.events.TweenEvent.TWEEN_UPDATE

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

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.

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

範例如何使用本範例

SimpleTweenEffectExample.mxml

<?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>

法律聲明 | 線上隱私權政策

TweenEffect - AS3 Flex

類別 x

easingFunction

TweenEffect

tweenEventHandler

tweenEnd

tweenStart

tweenUpdate