| <!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="Effect,mx.effects.Effect,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.Effect</title><script src="../../AC_OETags.js" type="text/javascript"></script></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 = 'Effect - 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/Effect.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">Effect</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a> | <a href="#methodSummary">Methods</a> | <a href="#eventSummary">Events</a> | <a href="#includeExamplesSummary">Examples</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("Effect"); titleBar_setSubNav(false,true,false,false,false,false,true,false,true,true,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 Effect</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">Effect <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> flash.events.EventDispatcher</td></tr><tr><td class="classHeaderTableLabel">Implements</td><td> <a href="../../mx/effects/IEffect.html">IEffect</a></td></tr><tr><td class="classHeaderTableLabel">Subclasses</td><td> <a href="../../spark/effects/AddAction.html">AddAction</a>, <a href="../../mx/effects/AddChildAction.html">AddChildAction</a>, <a href="../../mx/effects/AddItemAction.html">AddItemAction</a>, <a href="../../spark/effects/Animate.html">Animate</a>, <a href="../../spark/effects/CallAction.html">CallAction</a>, <a href="../../mx/effects/CompositeEffect.html">CompositeEffect</a>, <a href="../../mx/effects/MaskEffect.html">MaskEffect</a>, <a href="../../spark/effects/RemoveAction.html">RemoveAction</a>, <a href="../../mx/effects/RemoveChildAction.html">RemoveChildAction</a>, <a href="../../mx/effects/RemoveItemAction.html">RemoveItemAction</a>, <a href="../../spark/effects/SetAction.html">SetAction</a>, <a href="../../mx/effects/SetPropertyAction.html">SetPropertyAction</a>, <a href="../../mx/effects/SetStyleAction.html">SetStyleAction</a>, <a href="../../mx/effects/SoundEffect.html">SoundEffect</a>, <a href="../../mx/effects/TweenEffect.html">TweenEffect</a>, <a href="../../mx/effects/UnconstrainItemAction.html">UnconstrainItemAction</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 Effect class is an abstract base class that defines the basic |
| functionality of all Flex effects. |
| The Effect class defines the base factory class for all effects. |
| The EffectInstance class defines the base class for all effect |
| instance subclasses. |
| <p>You do not create an instance of the Effect class itself |
| in an application. |
| Instead, you create an instance of one of the subclasses, |
| such as Fade or WipeLeft.</p> |
| |
| <p></p><a name="mxmlSyntaxSummary"></a><span class="classHeaderTableLabel">MXML Syntax</span><span id="showMxmlLink" style="display:none"><a href="#mxmlSyntaxSummary" onclick="toggleMXMLOnly();"><img src="../../images/collapsed.gif" title="collapsed" alt="collapsed" class="collapsedImage">Show MXML Syntax</a><br/></span><span id="hideMxmlLink"><a href="#mxmlSyntaxSummary" onclick="toggleMXMLOnly();"><img src="../../images/expanded.gif" title="expanded" alt="expanded" class="expandedImage">Hide MXML Syntax</a></span><div id="mxmlSyntax" class="mxmlSyntax"> <p>The Effect class defines the following properties, |
| which all of its subclasses inherit:</p> |
| |
| <pre> |
| <mx:<i>tagname</i> |
| <b>Properties</b> |
| customFilter="" |
| duration="500" |
| filter="" |
| hideFocusRing="false" |
| perElementOffset="0" |
| repeatCount="1" |
| repeatDelay="0" |
| startDelay="0" |
| suspendBackgroundProcessing="false|true" |
| target="<i>effect target</i>" |
| targets="<i>array of effect targets</i>" |
| |
| <b>Events</b> |
| effectEnd="<i>No default</i>" |
| efectStart="<i>No default</i>" |
| /> |
| </pre> |
| </div><script language="javascript" type="text/javascript"><!-- |
| setMXMLOnly(); |
| --></script><p><a href="#includeExamplesSummary">View the examples</a></p><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso"><a href="EffectInstance.html" target="">mx.effects.EffectInstance</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 "Fade".</div></td><td class="summaryTableOwnerCol">Effect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#customFilter" class="signatureLink">customFilter</a> : <a href="../../mx/effects/EffectTargetFilter.html">EffectTargetFilter</a><div class="summaryTableDescription"> |
| Specifies a custom filter object, of type EffectTargetFilter, |
| used by the effect to determine the targets |
| on which to play the effect.</div></td><td class="summaryTableOwnerCol">Effect</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"> |
| Duration of the effect in milliseconds.</div></td><td class="summaryTableOwnerCol">Effect</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">Effect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#filter" class="signatureLink">filter</a> : String<div class="summaryTableDescription"> |
| Specifies an algorithm for filtering targets for an effect.</div></td><td class="summaryTableOwnerCol">Effect</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">Effect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#instanceClass" class="signatureLink">instanceClass</a> : Class<div class="summaryTableDescription"> |
| An object of type Class that specifies the effect |
| instance class class for this effect class.</div></td><td class="summaryTableOwnerCol">Effect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#isPlaying" class="signatureLink">isPlaying</a> : Boolean<div class="summaryTableDescription">[read-only] |
| A read-only flag which is true if any instances of the effect |
| are currently playing, and false if none are.</div></td><td class="summaryTableOwnerCol">Effect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#perElementOffset" class="signatureLink">perElementOffset</a> : Number<div class="summaryTableDescription"> |
| Additional delay, in milliseconds, for effect targets |
| after the first target of the effect.</div></td><td class="summaryTableOwnerCol">Effect</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">Effect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#relevantProperties" class="signatureLink">relevantProperties</a> : Array<div class="summaryTableDescription"> |
| An Array of property names to use when performing filtering.</div></td><td class="summaryTableOwnerCol">Effect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#relevantStyles" class="signatureLink">relevantStyles</a> : Array<div class="summaryTableDescription"> |
| An Array of style names to use when performing filtering.</div></td><td class="summaryTableOwnerCol">Effect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#repeatCount" class="signatureLink">repeatCount</a> : int = 1<div class="summaryTableDescription"> |
| Number of times to repeat the effect.</div></td><td class="summaryTableOwnerCol">Effect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#repeatDelay" class="signatureLink">repeatDelay</a> : int = 0<div class="summaryTableDescription"> |
| Amount of time, in milliseconds, to wait before repeating the effect.</div></td><td class="summaryTableOwnerCol">Effect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#startDelay" class="signatureLink">startDelay</a> : int = 0<div class="summaryTableDescription"> |
| Amount of time, in milliseconds, to wait before starting the effect.</div></td><td class="summaryTableOwnerCol">Effect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#suspendBackgroundProcessing" class="signatureLink">suspendBackgroundProcessing</a> : Boolean = false<div class="summaryTableDescription"> |
| If true, blocks all background processing |
| while the effect is playing.</div></td><td class="summaryTableOwnerCol">Effect</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 object to which this effect is applied.</div></td><td class="summaryTableOwnerCol">Effect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#targets" class="signatureLink">targets</a> : Array<div class="summaryTableDescription"> |
| An Array of objects that are targets for the effect.</div></td><td class="summaryTableOwnerCol">Effect</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 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.</div></td><td class="summaryTableOwnerCol">Effect</td></tr></table></div><a name="protectedPropertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Protected Properties</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProtectedProperty"><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="#applyTransitionEndProperties" class="signatureLink">applyTransitionEndProperties</a> : Boolean<div class="summaryTableDescription"> |
| 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.</div></td><td class="summaryTableOwnerCol">Effect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#endValuesCaptured" class="signatureLink">endValuesCaptured</a> : Boolean = false<div class="summaryTableDescription"> |
| 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.</div></td><td class="summaryTableOwnerCol">Effect</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="#Effect()" class="signatureLink">Effect</a>(target:Object = null)</div><div class="summaryTableDescription"> |
| Constructor.</div></td><td class="summaryTableOwnerCol">Effect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#captureEndValues()" class="signatureLink">captureEndValues</a>():void</div><div class="summaryTableDescription"> |
| Captures the current values of the relevant properties |
| on the effect's targets and saves them as end values.</div></td><td class="summaryTableOwnerCol">Effect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#captureMoreStartValues()" class="signatureLink">captureMoreStartValues</a>(targets:Array):void</div><div class="summaryTableDescription"> |
| 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. |
| |
| </div></td><td class="summaryTableOwnerCol">Effect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#captureStartValues()" class="signatureLink">captureStartValues</a>():void</div><div class="summaryTableDescription"> |
| Captures the current values of the relevant properties |
| on the effect's targets.</div></td><td class="summaryTableOwnerCol">Effect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#createInstance()" class="signatureLink">createInstance</a>(target:Object = null):<a href="../../mx/effects/IEffectInstance.html">IEffectInstance</a></div><div class="summaryTableDescription"> |
| Creates a single effect instance and initializes it.</div></td><td class="summaryTableOwnerCol">Effect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#createInstances()" class="signatureLink">createInstances</a>(targets:Array = null):Array</div><div class="summaryTableDescription"> |
| Takes an Array of target objects and invokes the |
| createInstance() method on each target.</div></td><td class="summaryTableOwnerCol">Effect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#deleteInstance()" class="signatureLink">deleteInstance</a>(instance:<a href="../../mx/effects/IEffectInstance.html">IEffectInstance</a>):void</div><div class="summaryTableDescription"> |
| Removes event listeners from an instance |
| and removes it from the list of instances.</div></td><td class="summaryTableOwnerCol">Effect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#end()" class="signatureLink">end</a>(effectInstance:<a href="../../mx/effects/IEffectInstance.html">IEffectInstance</a> = null):void</div><div class="summaryTableDescription"> |
| Interrupts an effect that is currently playing, |
| and jumps immediately to the end of the effect.</div></td><td class="summaryTableOwnerCol">Effect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getAffectedProperties()" class="signatureLink">getAffectedProperties</a>():Array</div><div class="summaryTableDescription"> |
| Returns an Array of Strings, where each String is the name |
| of a property changed by this effect.</div></td><td class="summaryTableOwnerCol">Effect</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">Effect</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>(targets:Array = null, playReversedFromEnd:Boolean = false):Array</div><div class="summaryTableDescription"> |
| Begins playing the effect.</div></td><td class="summaryTableOwnerCol">Effect</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">Effect</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, if the effect is currently playing, |
| starting from the current position of the effect.</div></td><td class="summaryTableOwnerCol">Effect</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 effect targets in their current state.</div></td><td class="summaryTableOwnerCol">Effect</td></tr></table></div><a name="protectedMethodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Protected Methods </div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProtectedMethod"><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="#applyValueToTarget()" class="signatureLink">applyValueToTarget</a>(target:Object, property:String, value:*, props:Object):void</div><div class="summaryTableDescription"> |
| Used internally by the Effect infrastructure.</div></td><td class="summaryTableOwnerCol">Effect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#effectEndHandler()" class="signatureLink">effectEndHandler</a>(event:<a href="../../mx/events/EffectEvent.html">EffectEvent</a>):void</div><div class="summaryTableDescription"> |
| Called when an effect instance has finished playing.</div></td><td class="summaryTableOwnerCol">Effect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#effectStartHandler()" class="signatureLink">effectStartHandler</a>(event:<a href="../../mx/events/EffectEvent.html">EffectEvent</a>):void</div><div class="summaryTableDescription"> |
| This method is called when the effect instance starts playing.</div></td><td class="summaryTableOwnerCol">Effect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#effectStopHandler()" class="signatureLink">effectStopHandler</a>(event:<a href="../../mx/events/EffectEvent.html">EffectEvent</a>):void</div><div class="summaryTableDescription"> |
| Called when an effect instance has stopped by a call |
| to the stop() method.</div></td><td class="summaryTableOwnerCol">Effect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#filterInstance()" class="signatureLink">filterInstance</a>(propChanges:Array, target:Object):Boolean</div><div class="summaryTableDescription"> |
| Determines the logic for filtering out an effect instance.</div></td><td class="summaryTableOwnerCol">Effect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getValueFromTarget()" class="signatureLink">getValueFromTarget</a>(target:Object, property:String):*</div><div class="summaryTableDescription"> |
| Called by the captureStartValues() method to get the value |
| of a property from the target.</div></td><td class="summaryTableOwnerCol">Effect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#initInstance()" class="signatureLink">initInstance</a>(instance:<a href="../../mx/effects/IEffectInstance.html">IEffectInstance</a>):void</div><div class="summaryTableDescription"> |
| Copies properties of the effect to the effect instance.</div></td><td class="summaryTableOwnerCol">Effect</td></tr></table></div><a name="eventSummary"></a><div class="summarySection"><div class="summaryTableTitle">Events</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableEvent"><tr><th> </th><th colspan="2">Event</th><th> Summary </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="#event:effectEnd" class="signatureLink">effectEnd</a></div></td><td class="summaryTableDescription summaryTableCol">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.</td><td class="summaryTableOwnerCol">Effect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:effectStart" class="signatureLink">effectStart</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when the effect starts playing.</td><td class="summaryTableOwnerCol">Effect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:effectStop" class="signatureLink">effectStop</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when the effect has been stopped, which only occurs when the effect is interrupted by a call to the stop() method.</td><td class="summaryTableOwnerCol">Effect</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="applyTransitionEndProperties"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">applyTransitionEndProperties</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>protected var applyTransitionEndProperties: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> |
| 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. |
| |
| </p><p> The default value is <code>true</code>.</p></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><td class="detailHeaderRule"> </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>"Fade"</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="customFilter"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">customFilter</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>customFilter:<a href="../../mx/effects/EffectTargetFilter.html">EffectTargetFilter</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 a custom filter object, of type EffectTargetFilter, |
| used by the effect to determine the targets |
| on which to play the effect. |
| |
| <p>Target filtering is only performed if you call the |
| <code>captureStartValues()</code> method before playing the effect. |
| Flex automatically calls the <code>captureStartValues()</code> method |
| when the effect is part of a transition.</p> |
| |
| <p>Use the <code>filter</code> property for simple filtering. |
| If the <code>customFilter</code> property is non-null, |
| the <code>filter</code> property is ignored.</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get customFilter():<a href="../../mx/effects/EffectTargetFilter.html">EffectTargetFilter</a></code><br/><code> public function set customFilter(value:<a href="../../mx/effects/EffectTargetFilter.html">EffectTargetFilter</a>):void</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> |
| Duration of the effect in milliseconds. |
| <p>In a Parallel or Sequence effect, the <code>duration</code> |
| property sets the duration of each effect. |
| For example, if a Sequence effect has its <code>duration</code> |
| property set to 3000, each effect in the Sequence takes 3000 ms |
| to play.</p> |
| <p>For a repeated effect, the <code>duration</code> property |
| specifies the duration of a single instance of the effect. |
| Therefore, if an effect has a <code>duration</code> property |
| set to 2000, and a <code>repeatCount</code> property set to 3, |
| the effect takes a total of 6000 ms (6 seconds) to play.</p> |
| </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="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="endValuesCaptured"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">endValuesCaptured</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>protected var endValuesCaptured:Boolean = false</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 flag containing <code>true</code> if the end values |
| of an effect have already been determined, |
| or <code>false</code> if they should be acquired from the |
| current properties of the effect targets when the effect runs. |
| This property is required by data effects because the sequence |
| of setting up the data effects, such as DefaultListEffect |
| and DefaultTileListEffect, is more complicated than for |
| normal effects. |
| </p><p> The default value is <code>false</code>.</p></div><a name="propertyDetail"></a><a name="filter"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">filter</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>filter:String</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 an algorithm for filtering targets for an effect. |
| A value of <code>null</code> specifies no filtering. |
| |
| <p>Target filtering is only performed if you call the |
| <code>captureStartValues()</code> method before playing the effect. |
| Flex automatically calls the <code>captureStartValues()</code> method |
| when the effect is part of a transition, or part of a data effect |
| for a list-based control.</p> |
| |
| <p>Use this property for simple filtering. |
| Use the <code>customFilter</code> property for more complex filtering. |
| If the <code>customFilter</code> property has a non-null value, |
| this property is ignored.</p> |
| <p>You can use the following values for the <code>filter</code> |
| property:</p> |
| <ul> |
| <li>A value of <code>"add"</code> plays the effect on any targets |
| that are added as a child to a container.</li> |
| <li>A value of <code>"addItem"</code> plays the effect |
| on the item renderer for any list items added to a List |
| or TileList control.</li> |
| <li>A value of <code>"hide"</code> plays the effect on any targets |
| whose visible property changed from <code>true</code> to |
| <code>false</code>.</li> |
| <li>A value of <code>"move"</code> plays the effect on any targets |
| that changed their <code>x</code> or <code>y</code> |
| properties.</li> |
| <li>A value of <code>"remove"</code> plays the effect on any targets |
| that are removed as a child of a container.</li> |
| <li>A value of <code>"removeItem"</code> plays the effect |
| on the item renderer for any list items removed from a List |
| or TileList control.</li> |
| <li>A value of <code>"replacedItem"</code> plays the effect |
| on the item renderer for any list items replaced in a List |
| or TileList control by a new item.</li> |
| <li>A value of <code>"replacementItem"</code> plays the effect |
| on the item renderer for any list items added to a List |
| or TileList control that replaces an existing item.</li> |
| <li>A value of <code>"resize"</code> plays the effect |
| on any targets that changed their <code>width</code> |
| or <code>height</code> properties.</li> |
| <li>A value of <code>"show"</code> plays the effect |
| on any targets whose visible property changed |
| from <code>false</code> to <code>true</code>.</li> |
| <li>A value of <code>""</code> specifies no filtering.</li> |
| </ul> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get filter():String</code><br/><code> public function set filter(value:String):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, |
| 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="instanceClass"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">instanceClass</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var instanceClass:Class</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> |
| An object of type Class that specifies the effect |
| instance class class for this effect class. |
| |
| <p>All subclasses of the Effect class must set this property |
| in their constructor.</p> |
| |
| </p></div><a name="propertyDetail"></a><a name="isPlaying"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">isPlaying</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>isPlaying:Boolean</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> |
| A read-only flag which is true if any instances of the effect |
| are currently playing, and false if none are. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get isPlaying():Boolean</code><br/></div><a name="propertyDetail"></a><a name="perElementOffset"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">perElementOffset</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>perElementOffset: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> |
| Additional delay, in milliseconds, for effect targets |
| after the first target of the effect. |
| This value is added to the value |
| of the <code>startDelay</code> property. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get perElementOffset():Number</code><br/><code> public function set perElementOffset(value:Number):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="relevantProperties"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">relevantProperties</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>relevantProperties:Array</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> |
| An Array of property names to use when performing filtering. |
| This property is used internally and should not be set by |
| effect users. |
| <p>The default value is equal to the Array returned by |
| the <code>getAffectedProperties()</code> method.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get relevantProperties():Array</code><br/><code> public function set relevantProperties(value:Array):void</code><br/></div><a name="propertyDetail"></a><a name="relevantStyles"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">relevantStyles</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>relevantStyles:Array</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> |
| An Array of style names to use when performing filtering. |
| This property is used internally and should not be set by |
| effect users. |
| <p>The default value is equal to the Array returned by |
| the <code>getAffectedProperties()</code> method.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get relevantStyles():Array</code><br/><code> public function set relevantStyles(value:Array):void</code><br/></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>public var repeatCount:int = 1</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. |
| A value of 1 means to play the effect once. |
| A value of 0 means to play the effect indefinitely |
| until stopped by a call to the <code>end()</code> method. |
| </p><p> The default value is <code>1</code>.</p></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>public var repeatDelay:int = 0</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. |
| Possible values are any integer greater than or equal to 0. |
| </p><p> The default value is <code>0</code>.</p></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>public var startDelay:int = 0</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> is only applied |
| to the first time the effect is played. |
| </p><p> The default value is <code>0</code>.</p></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>public var suspendBackgroundProcessing:Boolean = false</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. |
| The default value is <code>false</code>. |
| <p>You are encouraged to set this property to |
| <code>true</code> in most cases, because it improves |
| the performance of the application. |
| However, the property should be set to <code>false</code> |
| if either of the following is true:</p> |
| <ul> |
| <li>User input can arrive while the effect is playing, |
| and the application must respond to the user input |
| before the effect finishes playing.</li> |
| <li>A response can arrive from the server while the effect |
| is playing, and the application must process the response |
| while the effect is still playing.</li> |
| </ul> |
| </p><p> The default value is <code>false</code>.</p></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 object to which this effect is applied. |
| When an effect is triggered by an effect trigger, |
| the <code>target</code> property is automatically set to be |
| the object that triggers the effect. |
| |
| </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/></div><a name="propertyDetail"></a><a name="targets"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">targets</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>targets:Array</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> |
| An Array of objects that are targets for the effect. |
| When the effect is playing, it performs the effect on each target |
| in parallel. |
| Setting the <code>target</code> property replaces all objects |
| in this Array. |
| When the <code>targets</code> property is set, the <code>target</code> |
| property returns the first item in this Array. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get targets():Array</code><br/><code> public function set targets(value:Array):void</code><br/></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 object passed to this Effect |
| by the EffectManager when an effect is triggered, |
| or <code>null</code> if the effect is not being |
| played by the EffectManager. |
| |
| </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="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="Effect()"></a><a name="Effect(Object)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">Effect</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function Effect(target:Object = 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>Starting an effect is usually a three-step process:</p> |
| <ul> |
| <li>Create an instance of the effect object |
| with the <code>new</code> operator.</li> |
| <li>Set properties on the effect object, |
| such as <code>duration</code>.</li> |
| <li>Call the <code>play()</code> method |
| or assign the effect to a trigger.</li> |
| </ul> |
| </p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">target</span>:Object</code> (default = <code>null</code>)<code></code> — The Object to animate with this effect. |
| |
| </td></tr></table></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="applyValueToTarget()"></a><a name="applyValueToTarget(Object,String,any,Object)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">applyValueToTarget</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> protected function applyValueToTarget(target:Object, property:String, value:*, props:Object):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> |
| Used internally by the Effect infrastructure. |
| If <code>captureStartValues()</code> has been called, |
| then when Flex calls the <code>play()</code> method, it uses this function |
| to set the targets back to the starting state. |
| The default behavior is to take the value captured |
| using the <code>getValueFromTarget()</code> method |
| and set it directly on the target's property. For example: <pre> |
| |
| target[property] = value;</pre> |
| <p>Only override this method if you need to apply |
| the captured values in a different way. |
| Note that style properties of a target are set |
| using a different mechanism. |
| Use the <code>relevantStyles</code> property to specify |
| which style properties to capture and apply. </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">target</span>:Object</code> — The effect target. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">property</span>:String</code> — The target property. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">value</span>:*</code> — The value of the property. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">props</span>:Object</code> — Array of Objects, where each Array element contains a |
| <code>start</code> and <code>end</code> Object |
| for the properties that the effect is monitoring. |
| |
| </td></tr></table></p></div><a name="captureEndValues()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">captureEndValues</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function captureEndValues():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> |
| Captures the current values of the relevant properties |
| on the effect's targets and saves them as end values. |
| |
| <p>Flex automatically calls the <code>captureEndValues()</code> method |
| when the effect is part of a data change effect.</p> |
| |
| </p></div><a name="captureMoreStartValues()"></a><a name="captureMoreStartValues(Array)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">captureMoreStartValues</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function captureMoreStartValues(targets:Array):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> |
| Captures the current values of the relevant properties |
| of an additional set of targets |
| |
| <p>Flex uses this function when a data change |
| effect is run.</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">targets</span>:Array</code> — Array of targets for which values are captured |
| |
| </td></tr></table></p></div><a name="captureStartValues()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">captureStartValues</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function captureStartValues():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> |
| Captures the current values of the relevant properties |
| on the effect's targets. |
| Flex automatically calls the <code>captureStartValues()</code> |
| method when the effect is part of a transition. |
| |
| <p>Use this function when you want the effect to figure out the start |
| and end values of the effect. |
| The proper usage of this function is to use it |
| in the following steps:</p> |
| |
| <ol> |
| <li>Call the <code>captureStartValues()</code> method. |
| The effect captures the starting effect values.</li> |
| <li>Make changes to your effect targets, such as |
| adding/removing children, altering properties, |
| changing location, or changing dimensions.</li> |
| <li>Call the <code>play()</code> method. |
| The effect captures the end values. |
| This function populates the |
| <code>EffectInstance.propertyChanges</code> property |
| for each effect instance created by this effect. |
| Effect developers can use the <code>propertyChanges</code> property |
| to retrieve the start and end values for their effect.</li> |
| </ol> |
| |
| </p></div><a name="createInstance()"></a><a name="createInstance(Object)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">createInstance</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function createInstance(target:Object = null):<a href="../../mx/effects/IEffectInstance.html">IEffectInstance</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> |
| Creates a single effect instance and initializes it. |
| Use this method instead of the <code>play()</code> method |
| to manipulate the effect instance properties |
| before the effect instance plays. |
| |
| <p>The effect instance is created with the type |
| specified in the <code>instanceClass</code> property. |
| It is then initialized using the <code>initInstance()</code> method. |
| If the instance was created by the EffectManager |
| (when the effect is triggered by an effect trigger), |
| the effect is further initialized by a call to the |
| <code>EffectInstance.initEffect()</code> method.</p> |
| |
| <p>Calling the <code>createInstance()</code> method |
| does not play the effect. |
| Call the <code>startEffect()</code> method |
| on the returned effect instance. </p> |
| <p>This function is automatically called by the |
| <code>Effect.play()</code> method. </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">target</span>:Object</code> (default = <code>null</code>)<code></code> — Object to animate with this effect. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code><a href="../../mx/effects/IEffectInstance.html">IEffectInstance</a></code> — The effect instance object for the effect. |
| |
| </td></tr></table></div><a name="createInstances()"></a><a name="createInstances(Array)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">createInstances</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function createInstances(targets:Array = null):Array</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> |
| Takes an Array of target objects and invokes the |
| <code>createInstance()</code> method on each target. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">targets</span>:Array</code> (default = <code>null</code>)<code></code> — Array of objects to animate with this effect. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Array</code> — Array of effect instance objects, one per target, |
| for the effect. |
| |
| </td></tr></table></div><a name="deleteInstance()"></a><a name="deleteInstance(mx.effects.IEffectInstance)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">deleteInstance</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function deleteInstance(instance:<a href="../../mx/effects/IEffectInstance.html">IEffectInstance</a>):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> |
| Removes event listeners from an instance |
| and removes it from the list of instances. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">instance</span>:<a href="../../mx/effects/IEffectInstance.html">IEffectInstance</a></code> — The effect instance. |
| |
| </td></tr></table></p></div><a name="effectEndHandler()"></a><a name="effectEndHandler(mx.events.EffectEvent)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">effectEndHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function effectEndHandler(event:<a href="../../mx/events/EffectEvent.html">EffectEvent</a>):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 when an effect instance has finished playing. |
| If you override this method, ensure that you call the super 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>:<a href="../../mx/events/EffectEvent.html">EffectEvent</a></code> — An event object of type EffectEvent. |
| |
| </td></tr></table></p></div><a name="effectStartHandler()"></a><a name="effectStartHandler(mx.events.EffectEvent)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">effectStartHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function effectStartHandler(event:<a href="../../mx/events/EffectEvent.html">EffectEvent</a>):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 when the effect instance starts playing. |
| If you override this method, ensure that you call the super 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>:<a href="../../mx/events/EffectEvent.html">EffectEvent</a></code> — An event object of type EffectEvent. |
| |
| </td></tr></table></p></div><a name="effectStopHandler()"></a><a name="effectStopHandler(mx.events.EffectEvent)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">effectStopHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function effectStopHandler(event:<a href="../../mx/events/EffectEvent.html">EffectEvent</a>):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 when an effect instance has stopped by a call |
| to the <code>stop()</code> method. |
| If you override this method, ensure that you call the super 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>:<a href="../../mx/events/EffectEvent.html">EffectEvent</a></code> — An event object of type EffectEvent. |
| |
| </td></tr></table></p></div><a name="end()"></a><a name="end(mx.effects.IEffectInstance)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">end</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function end(effectInstance:<a href="../../mx/effects/IEffectInstance.html">IEffectInstance</a> = null):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 that is currently playing, |
| and jumps immediately to the end of the effect. |
| Calling this method invokes the <code>EffectInstance.end()</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>If you pass an effect instance as an argument, |
| just that instance is interrupted. |
| If no argument is passed in, all effect instances currently |
| spawned from the effect are interrupted.</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">effectInstance</span>:<a href="../../mx/effects/IEffectInstance.html">IEffectInstance</a></code> (default = <code>null</code>)<code></code> — EffectInstance to terminate. |
| </td></tr></table></p></div><a name="filterInstance()"></a><a name="filterInstance(Array,Object)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">filterInstance</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function filterInstance(propChanges:Array, target:Object):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 the logic for filtering out an effect instance. |
| The CompositeEffect class overrides 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">propChanges</span>:Array</code> — The properties modified by the effect. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">target</span>:Object</code> — The effect target. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Boolean</code> — Returns <code>true</code> if the effect instance should play. |
| |
| </td></tr></table></div><a name="getAffectedProperties()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getAffectedProperties</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getAffectedProperties():Array</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> |
| Returns an Array of Strings, where each String is the name |
| of a property changed by this effect. |
| For example, the Move effect returns an Array that contains |
| <code>"x"</code> and <code>"y"</code>. |
| <p>Every subclass of Effect must implement this method. |
| The EffectManager uses this method |
| to ensure that no two effects are trying to animate |
| the same property of the same object at the same time.</p> |
| </p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Array</code> — An Array of Strings specifying the names of the |
| properties modified by this effect. |
| |
| </td></tr></table></div><a name="getValueFromTarget()"></a><a name="getValueFromTarget(Object,String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getValueFromTarget</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function getValueFromTarget(target:Object, property:String):*</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>captureStartValues()</code> method to get the value |
| of a property from the target. |
| This function should only be called internally |
| by the effects framework. |
| The default behavior is to simply return <code>target[property]</code>. |
| Effect developers can override this function |
| if you need a different behavior. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">target</span>:Object</code> — The effect target. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">property</span>:String</code> — The target property. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>*</code> — The value of the target property. |
| |
| </td></tr></table></div><a name="initInstance()"></a><a name="initInstance(mx.effects.IEffectInstance)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">initInstance</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function initInstance(instance:<a href="../../mx/effects/IEffectInstance.html">IEffectInstance</a>):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> |
| Copies properties of the effect to the effect instance. |
| <p>Flex calls this method from the <code>Effect.createInstance()</code> |
| method; you do not have to call it yourself. </p> |
| <p>When you create a custom effect, override this method to |
| copy properties from the Effect class to the effect instance class. |
| In your override, call <code>super.initInstance()</code>. </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">instance</span>:<a href="../../mx/effects/IEffectInstance.html">IEffectInstance</a></code> — The effect instance to initialize. |
| |
| </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><a name="play(Array,Boolean)"></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(targets:Array = null, playReversedFromEnd:Boolean = false):Array</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> |
| Begins playing the effect. |
| You typically call the <code>end()</code> method |
| before you call the <code>play()</code> method |
| to ensure that any previous instance of the effect |
| has ended before you start a new one. |
| <p>All subclasses must implement this method.</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">targets</span>:Array</code> (default = <code>null</code>)<code></code> — Array of target objects on which to play this effect. |
| If this parameter is specified, then the effect's <code>targets</code> |
| property is not used. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">playReversedFromEnd</span>:Boolean</code> (default = <code>false</code>)<code></code> — If <code>true</code>, |
| play the effect backwards. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Array</code> — Array of EffectInstance objects, one per target, |
| for the effect. |
| |
| </td></tr></table></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, if the effect is currently playing, |
| starting from the current position of the effect. |
| |
| </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 effect targets in their current state. |
| Unlike a call to the <code>pause()</code> method, |
| you cannot call the <code>resume()</code> method after calling |
| the <code>stop()</code> method. |
| However, you can call the <code>play()</code> method to restart the effect. |
| <p>The effect instance dispatches an <code>effectEnd</code> event |
| when you call this method as part of ending the effect.</p> |
| |
| <p>For mask effects, the mask is not removed automatically |
| when the effect is stopped. |
| Running further mask effects on the same target(s) |
| without first removing the mask can produce unexpected results.</p> |
| |
| </p></div><div class="detailSectionHeader"> Event Detail </div><a name="event:effectEnd"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">effectEnd</td><td class="detailHeaderType"> Event </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/EffectEvent.html"><code>mx.events.EffectEvent</code></a><br/><span class="label">EffectEvent.type property = </span><a href="../../mx/events/EffectEvent.html#EFFECT_END"><code>mx.events.EffectEvent.EFFECT_END</code></a><br/><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> |
| 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 <code>end()</code> method. |
| </p> |
| The <code>EffectEvent.EFFECT_END</code> constant defines the value of the |
| <code>type</code> property of the event object for an |
| <code>effectEnd</code> event. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>effectInstance</code></td><td>The effect instance object |
| for the event.</td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="event:effectStart"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">effectStart</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/EffectEvent.html"><code>mx.events.EffectEvent</code></a><br/><span class="label">EffectEvent.type property = </span><a href="../../mx/events/EffectEvent.html#EFFECT_START"><code>mx.events.EffectEvent.EFFECT_START</code></a><br/><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> |
| Dispatched when the effect starts playing. |
| </p> |
| The <code>EffectEvent.EFFECT_START</code> constant defines the value of the |
| <code>type</code> property of the event object for an |
| <code>effectStart</code> event. |
| |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>effectInstance</code></td><td>The effect instance object |
| for the event.</td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="event:effectStop"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">effectStop</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/EffectEvent.html"><code>mx.events.EffectEvent</code></a><br/><span class="label">EffectEvent.type property = </span><a href="../../mx/events/EffectEvent.html#EFFECT_STOP"><code>mx.events.EffectEvent.EFFECT_STOP</code></a><br/><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> |
| Dispatched when the effect has been stopped, |
| which only occurs when the effect is |
| interrupted by a call to the <code>stop()</code> method. |
| The EFFECT_END event is also dispatched to indicate that |
| the effect has ended. This extra event is sent first, as an |
| indicator to listeners that the effect did not reach its |
| end state. |
| </p> |
| The <code>EffectEvent.EFFECT_STOP</code> constant defines the value of the |
| <code>type</code> property of the event object for an |
| <code>effectStop</code> event. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>effectInstance</code></td><td>The effect instance object |
| for the event.</td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="includeExamplesSummary"></a><div class="detailSectionHeader">Examples</div><div class="exampleHeader">SimpleEffectExample.mxml</div><div class="detailBody"><div class="listing"><pre><?xml version="1.0"?> |
| <!-- |
| |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| |
| --> |
| <!-- Simple example to demonstrate the Effect 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.controls.Alert; |
| |
| // Event handler for the effectEnd event. |
| private function endEffectHandler():void { |
| Alert.show("Effect Ended!"); |
| } |
| |
| // Event handler for the reset button. |
| private function resetHandler():void { |
| expand.end(); |
| img.width=30; |
| img.height=60; |
| button1.enabled=true; |
| } |
| ]]> |
| </fx:Script> |
| |
| <fx:Declarations> |
| <mx:Resize id="expand" target="{img}" widthTo="100" heightTo="200" |
| duration="10000" effectEnd="endEffectHandler();"/> |
| </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 control the Resize effect."/> |
| |
| <mx:Image id="img" width="30" height="60" |
| source="@Embed(source='assets/Product1.png')"/> |
| |
| |
| <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> |
| </pre></div><script language="javascript" type="text/javascript"><!-- AC_FL_RunContent( "src", "examples/SimpleEffectExample", "width", "100%", |
| "height","400px", "salign", "TL", "id", "example1", "quality", "high", "bgcolor", "", "name", |
| "example1", "flashvars","", "allowScriptAccess","sameDomain", "type", |
| "application/x-shockwave-flash","pluginspage", "http://www.macromedia.com/go/getflashplayer" ); --></script></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 --> |
