| <!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="IEffectInstance,mx.effects.IEffectInstance,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.IEffectInstance</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 = 'IEffectInstance - 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/IEffectInstance.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">IEffectInstance</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("IEffectInstance"); 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">Interface</td><td class="classSignature">public interface IEffectInstance</td></tr><tr><td class="classHeaderTableLabel">Implementors</td><td> <a href="../../mx/effects/EffectInstance.html">EffectInstance</a></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><p></p> |
| The IEffectInstance interface represents an instance of an effect |
| playing on a target. |
| Each target has a separate effect instance associated with it. |
| An effect instance's lifetime is transitory. |
| An instance is created when the effect is played on a target |
| and is destroyed when the effect has finished playing. |
| If there are multiple effects playing on a target at the same time |
| (for example, a Parallel effect), there is a separate effect instance |
| for each effect. |
| |
| <p>Effect developers must create an instance class |
| for their custom effects.</p> |
| <p></p><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso"><a href="Effect.html" target="">mx.effects.Effect</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="#className" class="signatureLink">className</a> : String<div class="summaryTableDescription">[read-only] |
| The name of the effect class, such as "FadeInstance".</div></td><td class="summaryTableOwnerCol">IEffectInstance</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#duration" class="signatureLink">duration</a> : Number<div class="summaryTableDescription"> |
| The duration of the effect, in milliseconds.</div></td><td class="summaryTableOwnerCol">IEffectInstance</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#effect" class="signatureLink">effect</a> : <a href="../../mx/effects/IEffect.html">IEffect</a><div class="summaryTableDescription"> |
| The IEffect object that created this IEffectInstance object.</div></td><td class="summaryTableOwnerCol">IEffectInstance</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#effectTargetHost" class="signatureLink">effectTargetHost</a> : <a href="../../mx/effects/IEffectTargetHost.html">IEffectTargetHost</a><div class="summaryTableDescription"> |
| A property that lets you access the target |
| list-based control of a data effect.</div></td><td class="summaryTableOwnerCol">IEffectInstance</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#hideFocusRing" class="signatureLink">hideFocusRing</a> : Boolean<div class="summaryTableDescription"> |
| Determines whether the effect should hide |
| the focus ring when starting the effect.</div></td><td class="summaryTableOwnerCol">IEffectInstance</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#playheadTime" class="signatureLink">playheadTime</a> : Number<div class="summaryTableDescription"> |
| Current time position of the effect.</div></td><td class="summaryTableOwnerCol">IEffectInstance</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#propertyChanges" class="signatureLink">propertyChanges</a> : <a href="../../mx/effects/effectClasses/PropertyChanges.html">PropertyChanges</a><div class="summaryTableDescription"> |
| Specifies the PropertyChanges object containing |
| the start and end values for the set of properties |
| relevant to the effect's targets.</div></td><td class="summaryTableOwnerCol">IEffectInstance</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#repeatCount" class="signatureLink">repeatCount</a> : int<div class="summaryTableDescription"> |
| Number of times to repeat the effect.</div></td><td class="summaryTableOwnerCol">IEffectInstance</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#repeatDelay" class="signatureLink">repeatDelay</a> : int<div class="summaryTableDescription"> |
| Amount of time, in milliseconds, |
| to wait before repeating the effect.</div></td><td class="summaryTableOwnerCol">IEffectInstance</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#startDelay" class="signatureLink">startDelay</a> : int<div class="summaryTableDescription"> |
| Amount of time, in milliseconds, |
| to wait before starting the effect.</div></td><td class="summaryTableOwnerCol">IEffectInstance</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#suspendBackgroundProcessing" class="signatureLink">suspendBackgroundProcessing</a> : Boolean<div class="summaryTableDescription"> |
| If true, blocks all background processing |
| while the effect is playing.</div></td><td class="summaryTableOwnerCol">IEffectInstance</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#target" class="signatureLink">target</a> : Object<div class="summaryTableDescription"> |
| The UIComponent object to which this effect is applied.</div></td><td class="summaryTableOwnerCol">IEffectInstance</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#triggerEvent" class="signatureLink">triggerEvent</a> : Event<div class="summaryTableDescription"> |
| The event, if any, which triggered the playing of the effect.</div></td><td class="summaryTableOwnerCol">IEffectInstance</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="#end()" class="signatureLink">end</a>():void</div><div class="summaryTableDescription"> |
| Interrupts an effect instance that is currently playing, |
| and jumps immediately to the end of the effect.</div></td><td class="summaryTableOwnerCol">IEffectInstance</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#finishEffect()" class="signatureLink">finishEffect</a>():void</div><div class="summaryTableDescription"> |
| Called by the end() method when the effect |
| finishes playing.</div></td><td class="summaryTableOwnerCol">IEffectInstance</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#finishRepeat()" class="signatureLink">finishRepeat</a>():void</div><div class="summaryTableDescription"> |
| Called after each iteration of a repeated effect finishes playing.</div></td><td class="summaryTableOwnerCol">IEffectInstance</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#initEffect()" class="signatureLink">initEffect</a>(event:Event):void</div><div class="summaryTableDescription"> |
| This method is called if the effect was triggered by the EffectManager.</div></td><td class="summaryTableOwnerCol">IEffectInstance</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">IEffectInstance</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#play()" class="signatureLink">play</a>():void</div><div class="summaryTableDescription"> |
| Plays the effect instance on the target.</div></td><td class="summaryTableOwnerCol">IEffectInstance</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">IEffectInstance</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">IEffectInstance</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#startEffect()" class="signatureLink">startEffect</a>():void</div><div class="summaryTableDescription"> |
| Plays the effect instance on the target after the |
| startDelay period has elapsed.</div></td><td class="summaryTableOwnerCol">IEffectInstance</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 effect, leaving the target in its current state.</div></td><td class="summaryTableOwnerCol">IEffectInstance</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="className"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">className</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>className:String</code> [read-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> |
| The name of the effect class, such as <code>"FadeInstance"</code>. |
| <p>This is a short or "unqualified" class name |
| that does not include the package name. |
| If you need the qualified name, use the |
| <code>getQualifiedClassName()</code> method |
| in the flash.utils package.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get className():String</code><br/></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><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>duration:Number</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> |
| The duration of the effect, in milliseconds. |
| </p><p> The default value is <code>500</code>.</p><br/><span class="label"> Implementation </span><br/><code> public function get duration():Number</code><br/><code> public function set duration(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="effect"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">effect</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>effect:<a href="../../mx/effects/IEffect.html">IEffect</a></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> |
| The IEffect object that created this IEffectInstance object. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get effect():<a href="../../mx/effects/IEffect.html">IEffect</a></code><br/><code> public function set effect(value:<a href="../../mx/effects/IEffect.html">IEffect</a>):void</code><br/></div><a name="propertyDetail"></a><a name="effectTargetHost"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">effectTargetHost</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>effectTargetHost:<a href="../../mx/effects/IEffectTargetHost.html">IEffectTargetHost</a></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> |
| 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. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get effectTargetHost():<a href="../../mx/effects/IEffectTargetHost.html">IEffectTargetHost</a></code><br/><code> public function set effectTargetHost(value:<a href="../../mx/effects/IEffectTargetHost.html">IEffectTargetHost</a>):void</code><br/></div><a name="propertyDetail"></a><a name="hideFocusRing"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">hideFocusRing</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>hideFocusRing:Boolean</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> |
| 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. |
| <p>Set this property to <code>true</code> |
| to hide the focus ring during the effect.</p> |
| |
| <p>For subclasses of Effect, the default value is <code>false</code>. |
| For subclasses of MaskEffect, the default value is <code>true</code>. |
| </p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get hideFocusRing():Boolean</code><br/><code> public function set hideFocusRing(value:Boolean):void</code><br/></div><a name="propertyDetail"></a><a name="playheadTime"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">playheadTime</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>playheadTime:Number</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> |
| Current time position of the effect. |
| This property has a value between 0 and the total duration, |
| which includes the Effect's <code>startDelay</code>, |
| <code>repeatCount</code>, and <code>repeatDelay</code>. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get playheadTime():Number</code><br/><code> public function set playheadTime(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="propertyChanges"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">propertyChanges</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>propertyChanges:<a href="../../mx/effects/effectClasses/PropertyChanges.html">PropertyChanges</a></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> |
| 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 |
| <code>captureStartValues()</code> method was called |
| on the effect that created this effect instance. |
| |
| <p>You often use the <code>propertyChanges</code> property |
| to create an effect that is used as part of a transition. |
| Flex automatically calls the <code>captureStartValues()</code> |
| method when it starts a transition. |
| Within your override of the <code>Effectinstance.play()</code> |
| method, you can examine the information within the |
| <code>propertyChanges()</code> method to initialize |
| the start and end values of the effect.</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get propertyChanges():<a href="../../mx/effects/effectClasses/PropertyChanges.html">PropertyChanges</a></code><br/><code> public function set propertyChanges(value:<a href="../../mx/effects/effectClasses/PropertyChanges.html">PropertyChanges</a>):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../mx/effects/effectClasses/PropertyChanges.html" target="">mx.effects.effectClasses.PropertyChanges</a></div></div><a name="propertyDetail"></a><a name="repeatCount"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">repeatCount</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>repeatCount:int</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> |
| Number of times to repeat the effect. |
| Possible values are any integer greater than or equal to 0. |
| |
| </p><p> The default value is <code>1</code>.</p><br/><span class="label"> Implementation </span><br/><code> public function get repeatCount():int</code><br/><code> public function set repeatCount(value:int):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="Effect.html#repeatCount" target="">mx.effects.Effect.repeatCount</a></div></div><a name="propertyDetail"></a><a name="repeatDelay"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">repeatDelay</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>repeatDelay:int</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> |
| Amount of time, in milliseconds, |
| to wait before repeating the effect. |
| |
| </p><p> The default value is <code>0</code>.</p><br/><span class="label"> Implementation </span><br/><code> public function get repeatDelay():int</code><br/><code> public function set repeatDelay(value:int):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="Effect.html#repeatDelay" target="">mx.effects.Effect.repeatDelay</a></div></div><a name="propertyDetail"></a><a name="startDelay"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">startDelay</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>startDelay:int</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> |
| 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 <code>repeatCount</code> |
| property, the <code>startDelay</code> property is applied |
| only the first time the effect is played. |
| </p><p> The default value is <code>0</code>.</p><br/><span class="label"> Implementation </span><br/><code> public function get startDelay():int</code><br/><code> public function set startDelay(value:int):void</code><br/></div><a name="propertyDetail"></a><a name="suspendBackgroundProcessing"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">suspendBackgroundProcessing</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>suspendBackgroundProcessing:Boolean</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> |
| If <code>true</code>, blocks all background processing |
| while the effect is playing. |
| Background processing includes measurement, layout, |
| and processing responses that have arrived from the server. |
| |
| </p><p> The default value is <code>false</code>.</p><br/><span class="label"> Implementation </span><br/><code> public function get suspendBackgroundProcessing():Boolean</code><br/><code> public function set suspendBackgroundProcessing(value:Boolean):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="Effect.html#suspendBackgroundProcessing" target="">mx.effects.Effect.suspendBackgroundProcessing</a></div></div><a name="propertyDetail"></a><a name="target"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">target</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>target: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> |
| The UIComponent object to which this effect is applied. |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get target():Object</code><br/><code> public function set target(value:Object):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="Effect.html#target" target="">mx.effects.Effect.target</a></div></div><a name="propertyDetail"></a><a name="triggerEvent"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">triggerEvent</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>triggerEvent:Event</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> |
| The event, if any, which triggered the playing of the effect. |
| This property is useful when an effect is assigned to |
| multiple triggering events. |
| |
| <p>If the effect was played programmatically by a call to the |
| <code>play()</code> method, rather than being triggered by an event, |
| this property is <code>null</code>.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get triggerEvent():Event</code><br/><code> public function set triggerEvent(value:Event):void</code><br/></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="end()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">end</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function end():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> |
| 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 <code>Effect.end()</code> method. |
| As part of its implementation, it calls |
| the <code>finishEffect()</code> method. |
| <p>The effect instance dispatches an <code>effectEnd</code> event |
| when you call this method as part of ending the effect.</p> |
| <p>In a subclass of EffectInstance, |
| you can optionally override this method |
| As part of your override, you should call |
| the <code>super.end()</code> method |
| from the end of your override, after your logic.</p> |
| </p><p><span class="label">See also</span></p><div class="seeAlso"><a href="Effect.html#end()" target="">mx.effects.Effect.end()</a></div></div><a name="finishEffect()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">finishEffect</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function finishEffect():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> |
| Called by the <code>end()</code> method when the effect |
| finishes playing. |
| This function dispatches an <code>endEffect</code> event |
| for the effect target. |
| <p>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.</p> |
| </p><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../mx/events/EffectEvent.html" target="">mx.events.EffectEvent</a></div></div><a name="finishRepeat()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">finishRepeat</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function finishRepeat():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> |
| Called after each iteration of a repeated effect finishes playing. |
| <p>You do not have to override this method in a subclass. |
| You do not need to call this method when using effects.</p> |
| |
| </p></div><a name="initEffect()"></a><a name="initEffect(flash.events.Event)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">initEffect</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function initEffect(event:Event):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> |
| 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 <code>triggerEvent</code> property. |
| Each subclass should override this method. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:Event</code> — 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. |
| |
| </td></tr></table></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="play()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">play</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function play():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 instance on the target. |
| Call the <code>startEffect()</code> method instead |
| to make an effect start playing on an EffectInstance. |
| |
| <p>In a subclass of EffectInstance, you must override this method. |
| The override must call the <code>super.play()</code> method |
| so that an <code>effectStart</code> event is dispatched |
| from the target.</p> |
| |
| </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="startEffect()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">startEffect</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function startEffect():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 instance on the target after the |
| <code>startDelay</code> period has elapsed. |
| Called by the Effect class. |
| Use this function instead of the <code>play()</code> method |
| when starting an EffectInstance. |
| |
| </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 effect, leaving the target in its current state. |
| This method is invoked by a call |
| to the <code>Effect.stop()</code> method. |
| As part of its implementation, it calls |
| the <code>finishEffect()</code> method. |
| <p>The effect instance dispatches an <code>effectEnd</code> event |
| when you call this method as part of ending the effect.</p> |
| |
| </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 --> |
