| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><!-- saved from url=(0014)about:internet --><html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><link rel="stylesheet" href="../../style.css" type="text/css" media="screen"><link rel="stylesheet" href="../../print.css" type="text/css" media="print"><link rel="stylesheet" href="../../override.css" type="text/css"><meta name="keywords" content="Tween,mx.effects.Tween,alphaFrom,alphaFrom,alphaFrom,alphaTo,alphaTo,alphaTo,angleFrom,angleTo,applyTransitionEndProperties,autoLoad,blurXFrom,blurXFrom,blurXTo,blurXTo,blurYFrom,blurYFrom,blurYTo,blurYTo,bufferTime,captureRollEvents,children,className,className,className,className,color,color,color,color,compositeDuration,compositeDuration,compositeDuration,createMaskFunction,customFilter,customFilter,duration,duration,duration,duration,duration,duration,easingFunction,easingFunction,effect,effect,effectTargetHost,effectTargetHost,effectTargetHost,effectTargetHost,endValuesCaptured,eventName,fadeInDuration,fadeInDuration,fadeOutDuration,fadeOutDuration,filter,filter,filterFunction,filterProperties,filterStyles,fromValue,growDuration,heightBy,heightFrom,heightTo,hideChildrenTargets,hideFocusRing,hideFocusRing,hideFocusRing,hideFocusRing,hideFocusRing,index,inner,instanceClass,isLoading,isPlaying,isPlaying,isStyle,knockout,listener,loops,moveDuration,moveEasingFunction,name,name,originX,originX,originY,originY,panEasingFunction,panFrom,panTo,perElementOffset,perElementOffset,playCount,playheadTime,playheadTime,playheadTime,playheadTime,position,property,propertyChanges,propertyChanges,relativeTo,relevantProperties,relevantProperties,relevantStyles,relevantStyles,relevantStyles,removedElementOffset,repeatCount,repeatCount,repeatCount,repeatDelay,repeatDelay,repeatDelay,requiredSemantics,roundValue,scaleEasingFunction,scaleXFrom,scaleXTo,scaleYFrom,scaleYTo,showTarget,shrinkDuration,sound,source,startDelay,startDelay,startDelay,startTime,strength,suspendBackgroundProcessing,suspendBackgroundProcessing,suspendBackgroundProcessing,target,target,target,target,targetArea,targets,targets,toValue,triggerEvent,triggerEvent,triggerEvent,triggerEvent,useDuration,value,value,volumeEasingFunction,volumeFrom,volumeTo,widthBy,widthFrom,widthTo,xBy,xFrom,xFrom,xTo,xTo,yBy,yFrom,yFrom,yTo,yTo,zoomHeightFrom,zoomHeightTo,zoomWidthFrom,zoomWidthTo,addChild,addDataEffectItem,applyValueToTarget,captureEndValues,captureEndValues,captureMoreStartValues,captureMoreStartValues,captureStartValues,captureStartValues,createInstance,createInstance,createInstances,createInstances,defaultFilterFunction,deleteInstance,deleteInstance,effectEndHandler,effectStartHandler,effectStopHandler,end,end,end,end,endEffectsForTarget,endTween,filterInstance,filterInstance,finishEffect,finishEffect,finishRepeat,finishRepeat,getAffectedProperties,getAffectedProperties,getAffectedProperties,getRendererSemanticValue,getValueFromTarget,initEffect,initEffect,initInstance,load,pause,pause,pause,pause,pause,play,play,play,play,removeDataEffectItem,resume,resume,resume,resume,resume,resumeEventHandling,reverse,reverse,reverse,reverse,reverse,seek,setTweenHandlers,startEffect,startEffect,stop,stop,stop,stop,stop,suspendEventHandling,tweenEventHandler,tweenEventHandler,unconstrainRenderer"><title>mx.effects.Tween</title></head><body><script language="javascript" type="text/javascript" src="../../asdoc.js"></script><script language="javascript" type="text/javascript" src="../../help.js"></script><script language="javascript" type="text/javascript" src="../../cookies.js"></script><script language="javascript" type="text/javascript"><!-- |
| asdocTitle = 'Tween - ApacheFlex API Reference'; |
| var baseRef = '../../'; |
| window.onload = configPage; |
| --></script> |
| <script type="text/javascript"> |
| scrollToNameAnchor(); |
| </script><table class="titleTable" cellpadding="0" cellspacing="0" id="titleTable" style="display:none"><tr><td class="titleTableTitle" align="left">Apache Flex 4.16.1 API Reference </td><td class="titleTableTopNav" align="right"><a href="../../package-summary.html" onclick="loadClassListFrame('../../all-classes.html')">All Packages</a> | <a href="../../class-summary.html" onclick="loadClassListFrame('../../all-classes.html')">All Classes</a> | <a href="../../all-index-A.html" onclick="loadClassListFrame('../../index-list.html')">Index</a> | <a id="framesLink1" href="../../index.html?mx/effects/Tween.html&mx/effects/class-list.html">Frames</a><a id="noFramesLink1" style="display:none" href="" onclick="parent.location=document.location"> No Frames </a></td><td class="titleTableLogo" align="right" rowspan="3"><img src="../../images/logo.jpg" class="logoImage" alt="AdobeLogo" title="AdobeLogo"></td></tr><tr class="titleTableRow2"><td class="titleTableSubTitle" id="subTitle" align="left">Tween</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a> | <a href="#methodSummary">Methods</a></td></tr><tr class="titleTableRow3"><td colspan="3"> </td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve"> |
| <!-- |
| |
| if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Tween"); titleBar_setSubNav(false,true,false,false,false,false,false,false,true,false,false ,false,false,false,false,false);} |
| --> |
| </script><div xmlns:fn="http://www.w3.org/2005/xpath-functions" class="MainContent"><table class="classHeaderTable" cellpadding="0" cellspacing="0"><tr><td class="classHeaderTableLabel">Package</td><td><a href="package-detail.html" onclick="javascript:loadClassListFrame('class-list.html')">mx.effects</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class Tween</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">Tween <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> flash.events.EventDispatcher</td></tr></table><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p></p><br/><table width="100%" class="innertable"><tr><td bgcolor="#FFFFCC"><img src="../../images/P_AlternativeMetadataIndicator_30x28_N.png"></td><td bgcolor="#FFFFCC">Starting with Flex 4.0, Apache recommends that you use the <a href="../../spark/effects/animation.Animation.html">spark.effects.animation.Animation</a> class as an alternative to this class.<br/><p> |
| Tween is the underlying animation class for the effects in Flex 3. As of Flex 4, the Spark |
| effects use the spark.effects.animation.Animation class to provide similar functionality. |
| </p></td></tr></table><br/><p></p> |
| The Tween class defines a tween, a property animation performed |
| on a target object over a period of time. |
| That animation can be a change in position, such as performed by |
| the Move effect; a change in size, as performed by the Resize or |
| Zoom effects; a change in visibility, as performed by the Fade or |
| Dissolve effects; or other types of animations. |
| <p>When defining tween effects, you typically create an instance |
| of the Tween class within your override of the |
| <code>EffectInstance.play()</code> method. |
| A Tween instance accepts the <code>startValue</code>, |
| <code>endValue</code>, and <code>duration</code> properties, |
| and an optional easing function to define the animation.</p> |
| <p>The Tween object invokes the |
| <code>mx.effects.effectClasses.TweenEffectInstance.onTweenUpdate()</code> |
| callback function on a regular interval on the effect instance |
| for the duration of the effect, passing to the |
| <code>onTweenUpdate()</code> method an interpolated value |
| between the <code>startValue</code> and <code>endValue</code>. |
| Typically, the callback function updates some property of the target object, |
| causing that object to animate over the duration of the effect.</p> |
| <p>When the effect ends, the Tween objects invokes the |
| <code>mx.effects.effectClasses.TweenEffectInstance.onTweenEnd()</code> |
| callback function, if you defined one. </p> |
| <p></p><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso"><a href="TweenEffect.html" target="">mx.effects.TweenEffect</a><br/><a href="../../mx/effects/effectClasses/TweenEffectInstance.html" target="">mx.effects.effectClasses.TweenEffectInstance</a></div><br/><hr></div><a name="propertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Properties</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProperty"><tr><th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#duration" class="signatureLink">duration</a> : Number = 3000<div class="summaryTableDescription"> |
| Duration of the animation, in milliseconds.</div></td><td class="summaryTableOwnerCol">Tween</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#easingFunction" class="signatureLink">easingFunction</a> : Function<div class="summaryTableDescription">[write-only] |
| Sets the easing function for the animation.</div></td><td class="summaryTableOwnerCol">Tween</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#listener" class="signatureLink">listener</a> : Object<div class="summaryTableDescription"> |
| Object that is notified at each interval of the animation.</div></td><td class="summaryTableOwnerCol">Tween</td></tr></table></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableMethod"><tr><th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#Tween()" class="signatureLink">Tween</a>(listener:Object, startValue:Object, endValue:Object, duration:Number = -1, minFps:Number = -1, updateFunction:Function = null, endFunction:Function = null)</div><div class="summaryTableDescription"> |
| Constructor.</div></td><td class="summaryTableOwnerCol">Tween</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#endTween()" class="signatureLink">endTween</a>():void</div><div class="summaryTableDescription"> |
| Interrupt the tween, jump immediately to the end of the tween, |
| and invoke the onTweenEnd() callback function.</div></td><td class="summaryTableOwnerCol">Tween</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#pause()" class="signatureLink">pause</a>():void</div><div class="summaryTableDescription"> |
| Pauses the effect until you call the resume() method.</div></td><td class="summaryTableOwnerCol">Tween</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#resume()" class="signatureLink">resume</a>():void</div><div class="summaryTableDescription"> |
| Resumes the effect after it has been paused |
| by a call to the pause() method.</div></td><td class="summaryTableOwnerCol">Tween</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#reverse()" class="signatureLink">reverse</a>():void</div><div class="summaryTableDescription"> |
| Plays the effect in reverse, |
| starting from the current position of the effect.</div></td><td class="summaryTableOwnerCol">Tween</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#seek()" class="signatureLink">seek</a>(playheadTime:Number):void</div><div class="summaryTableDescription"> |
| Advances the tween effect to the specified position.</div></td><td class="summaryTableOwnerCol">Tween</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#setTweenHandlers()" class="signatureLink">setTweenHandlers</a>(updateFunction:Function, endFunction:Function):void</div><div class="summaryTableDescription"> |
| By default, the Tween class invokes the |
| mx.effects.effectClasses.TweenEffectInstance.onTweenUpdate() |
| callback function on a regular interval on the effect instance |
| for the duration of the effect, and the optional |
| mx.effects.effectClasses.TweenEffectInstance.onTweenEnd() |
| callback function at the end of the effect duration.</div></td><td class="summaryTableOwnerCol">Tween</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#stop()" class="signatureLink">stop</a>():void</div><div class="summaryTableDescription"> |
| Stops the tween, ending it without dispatching an event or calling |
| the Tween's endFunction or onTweenEnd().</div></td><td class="summaryTableOwnerCol">Tween</td></tr></table></div><script language="javascript" type="text/javascript"><!-- |
| showHideInherited(); |
| --></script><div class="MainContent"><div class="detailSectionHeader">Property Detail</div><a name="propertyDetail"></a><a name="duration"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">duration</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>public var duration:Number = 3000</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Duration of the animation, in milliseconds. |
| |
| </p></div><a name="propertyDetail"></a><a name="easingFunction"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">easingFunction</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>easingFunction:Function</code> [write-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Sets the easing function for the animation. |
| The easing function is used to interpolate between |
| the <code>startValue</code> value and the <code>endValue</code>. |
| A trivial easing function does linear interpolation, |
| but more sophisticated easing functions create the illusion of |
| acceleration and deceleration, which makes the animation seem |
| more natural. |
| <p>If no easing function is specified, an easing function based |
| on the <code>Math.sin()</code> method is used.</p> |
| <p>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 a 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 |
| (usually a value between the initial value and the ending value).</p> |
| <p>Flex includes a set of easing functions |
| in the mx.effects.easing package.</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function set easingFunction(value:Function):void</code><br/></div><a name="propertyDetail"></a><a name="listener"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">listener</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var listener:Object</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Object that is notified at each interval of the animation. |
| |
| </p></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="Tween()"></a><a name="Tween(Object,Object,Object,Number,Number,Function,Function)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">Tween</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function Tween(listener:Object, startValue:Object, endValue:Object, duration:Number = -1, minFps:Number = -1, updateFunction:Function = null, endFunction:Function = null)</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p> |
| Constructor. |
| <p>When the constructor is called, the animation automatically |
| starts playing.</p> |
| </p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">listener</span>:Object</code> — Object that is notified at each interval |
| of the animation. You typically pass the <code>this</code> |
| keyword as the value. |
| The <code>listener</code> must define the |
| <code>onTweenUpdate()</code> method and optionally the |
| <code>onTweenEnd()</code> method. |
| The former method is invoked for each interval of the animation, |
| and the latter is invoked just after the animation finishes. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">startValue</span>:Object</code> — Initial value(s) of the animation. |
| Either a number or an array of numbers. |
| If a number is passed, the Tween interpolates |
| between this number and the number passed |
| in the <code>endValue</code> parameter. |
| If an array of numbers is passed, |
| each number in the array is interpolated. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">endValue</span>:Object</code> — Final value(s) of the animation. |
| The type of this argument must match the <code>startValue</code> |
| parameter. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">duration</span>:Number</code> (default = <code>-1</code>)<code></code> — Duration of the animation, expressed in milliseconds. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">minFps</span>:Number</code> (default = <code>-1</code>)<code></code> — Minimum number of times that the |
| <code>onTweenUpdate()</code> method should be called every second. |
| The tween code tries to call the <code>onTweenUpdate()</code> |
| method as frequently as possible (up to 100 times per second). |
| However, if the frequency falls below <code>minFps</code>, |
| the duration of the animation automatically increases. |
| As a result, an animation that temporarily freezes |
| (because it is not getting any CPU cycles) begins again |
| where it left off, instead of suddenly jumping ahead. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">updateFunction</span>:Function</code> (default = <code>null</code>)<code></code> — Specifies an alternative update callback |
| function to be used instead of <code>listener.OnTweenUpdate()</code> |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">endFunction</span>:Function</code> (default = <code>null</code>)<code></code> — Specifies an alternative end callback function |
| to be used instead of <code>listener.OnTweenEnd()</code> |
| |
| </td></tr></table></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="endTween()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">endTween</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function endTween():void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Interrupt the tween, jump immediately to the end of the tween, |
| and invoke the <code>onTweenEnd()</code> callback function. |
| |
| </p></div><a name="pause()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">pause</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function pause():void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Pauses the effect until you call the <code>resume()</code> method. |
| |
| </p></div><a name="resume()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">resume</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function resume():void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Resumes the effect after it has been paused |
| by a call to the <code>pause()</code> method. |
| |
| </p></div><a name="reverse()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">reverse</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function reverse():void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Plays the effect in reverse, |
| starting from the current position of the effect. |
| |
| </p></div><a name="seek()"></a><a name="seek(Number)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">seek</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function seek(playheadTime:Number):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Advances the tween effect to the specified position. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">playheadTime</span>:Number</code> — The position, in milliseconds, between 0 |
| and the value of the <code>duration</code> property. |
| |
| </td></tr></table></p></div><a name="setTweenHandlers()"></a><a name="setTweenHandlers(Function,Function)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">setTweenHandlers</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function setTweenHandlers(updateFunction:Function, endFunction:Function):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| By default, the Tween class invokes the |
| <code>mx.effects.effectClasses.TweenEffectInstance.onTweenUpdate()</code> |
| callback function on a regular interval on the effect instance |
| for the duration of the effect, and the optional |
| <code>mx.effects.effectClasses.TweenEffectInstance.onTweenEnd()</code> |
| callback function at the end of the effect duration. |
| <p>This method lets you specify different methods |
| as the update and the end callback functions.</p> |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">updateFunction</span>:Function</code> — Specifies the update callback function. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">endFunction</span>:Function</code> — Specifies the end callback function. |
| |
| </td></tr></table></p></div><a name="stop()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">stop</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function stop():void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Stops the tween, ending it without dispatching an event or calling |
| the Tween's endFunction or <code>onTweenEnd()</code>. |
| |
| </p></div><br/><br/><hr><br/><p></p><center class="copyright"><footer>The Apache Software Foundation</footer><br/>Wed Nov 15 2017, 09:50 AM +01:00 </center></div></body></html><!--The Apache Software Foundation<br/>Wed Nov 15 2017, 09:50 AM +01:00 --> |
