| <!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="MaskEffect,mx.effects.MaskEffect,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.MaskEffect</title></head><body><script language="javascript" type="text/javascript" src="../../asdoc.js"></script><script language="javascript" type="text/javascript" src="../../help.js"></script><script language="javascript" type="text/javascript" src="../../cookies.js"></script><script language="javascript" type="text/javascript"><!-- |
| asdocTitle = 'MaskEffect - 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/MaskEffect.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">MaskEffect</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a> | <a href="#methodSummary">Methods</a> | <a href="#eventSummary">Events</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("MaskEffect"); titleBar_setSubNav(false,true,false,false,false,false,true,false,true,false,false ,false,false,false,false,false);} |
| --> |
| </script><div xmlns:fn="http://www.w3.org/2005/xpath-functions" class="MainContent"><table class="classHeaderTable" cellpadding="0" cellspacing="0"><tr><td class="classHeaderTableLabel">Package</td><td><a href="package-detail.html" onclick="javascript:loadClassListFrame('class-list.html')">mx.effects</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class MaskEffect</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">MaskEffect <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> <a href="../../mx/effects/Effect.html">Effect</a> <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> flash.events.EventDispatcher</td></tr><tr><td class="classHeaderTableLabel">Subclasses</td><td> <a href="../../mx/effects/Iris.html">Iris</a>, <a href="../../mx/effects/WipeDown.html">WipeDown</a>, <a href="../../mx/effects/WipeLeft.html">WipeLeft</a>, <a href="../../mx/effects/WipeRight.html">WipeRight</a>, <a href="../../mx/effects/WipeUp.html">WipeUp</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 MaskEffect class is an abstract base class for all effects |
| that animate a mask, such as the wipe effects and the Iris effect. |
| This class encapsulates methods and properties that are common |
| among all mask-based effects. |
| <p>A mask effect uses an overlay, called a mask, to perform the effect. |
| By default, the mask is a rectangle with the same size |
| as the target component. </p> |
| <p>The before or after state of the target component of a mask effect |
| must be invisible. |
| That means a mask effect always makes a target component appear on |
| the screen, or disappear from the screen.</p> |
| <p>You use the <code>scaleXFrom</code>, <code>scaleYFrom</code>, |
| <code>scaleXTo</code>, and <code>scaleX</code> properties to specify |
| the initial and final scale of the mask, where a value of 1.0 corresponds |
| to scaling the mask to the size of the target component, 2.0 scales |
| the mask to twice the size of the component, 0.5 scales the mask to half |
| the size of the component, and so on. |
| To use any one of these properties, you must specify all four.</p> |
| <p>You use the <code>xFrom</code>, <code>yFrom</code>, <code>xTo</code>, |
| and <code>yTo</code> properties to specify the coordinates of the initial |
| position and final position of the mask relative to the target component, |
| where (0, 0) corresponds to the upper left corner of the target. |
| To use any one of these properties, you must specify all four.</p> |
| <p>The coordinates of the initial and final position of the mask |
| depend on the type of effect and whether the <code>show</code> property |
| is <code>true</code> or <code>false</code>. |
| For example, for the WipeLeft effect with a <code>show</code> value of |
| <code>false</code>, the coordinates of the initial mask position |
| are (0, 0),corresponding to the upper-left corner of the target, |
| and the coordinates of the final position are the upper-right corner |
| of the target (width, 0), where width is the width of the target.</p> |
| |
| <p>For a <code>show</code> value of <code>true</code> for the WipeLeft |
| effect, the coordinates of the initial mask position are (width, 0), |
| and the coordinates of the final position are (0, 0).</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 MaskEffect class defines the following properties, |
| which all of its subclasses inherit:</p> |
| |
| <pre> |
| <mx:<i>tagname</i> |
| createMaskFunction="" |
| moveEasingFunction="" |
| scaleEasingFunction="" |
| scaleXFrom="" |
| scaleXTo="" |
| scaleYFrom="" |
| scaleYTo="" |
| show="true|false" |
| xFrom="" |
| xTo="" |
| yFrom="" |
| yTo="" |
| /> |
| </pre> |
| |
| </div><script language="javascript" type="text/javascript"><!-- |
| setMXMLOnly(); |
| --></script><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso"><a href="../../mx/effects/effectClasses/MaskEffectInstance.html" target="">mx.effects.effectClasses.MaskEffectInstance</a><br/><a href="TweenEffect.html" target="">mx.effects.TweenEffect</a></div><br/><hr></div><a name="propertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Properties</div><div class="showHideLinks"><div id="hideInheritedProperty" class="hideInheritedProperty"><a class="showHideLink" href="#propertySummary" onclick="javascript:setInheritedVisible(false,'Property');"><img class="showHideLinkImage" src="../../images/expanded.gif"> Hide Inherited Public Properties</a></div><div id="showInheritedProperty" class="showInheritedProperty"><a class="showHideLink" href="#propertySummary" onclick="javascript:setInheritedVisible(true,'Property');"><img class="showHideLinkImage" src="../../images/collapsed.gif"> Show Inherited Public Properties</a></div></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="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/effects/Effect.html#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"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#createMaskFunction" class="signatureLink">createMaskFunction</a> : Function<div class="summaryTableDescription"> |
| Function called when the effect creates the mask.</div></td><td class="summaryTableOwnerCol">MaskEffect</td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/effects/Effect.html#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"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/effects/Effect.html#duration" class="signatureLink">duration</a> : Number<div class="summaryTableDescription"> |
| Duration of the effect in milliseconds.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/effects/Effect.html#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"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/effects/Effect.html#filter" class="signatureLink">filter</a> : String<div class="summaryTableDescription"> |
| Specifies an algorithm for filtering targets for an effect.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/effects/Effect.html#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"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/effects/Effect.html#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"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/effects/Effect.html#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"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#moveEasingFunction" class="signatureLink">moveEasingFunction</a> : Function<div class="summaryTableDescription"> |
| Easing function to use for moving the mask.</div></td><td class="summaryTableOwnerCol">MaskEffect</td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/effects/Effect.html#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"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/effects/Effect.html#playheadTime" class="signatureLink">playheadTime</a> : Number<div class="summaryTableDescription"> |
| Current time position of the effect.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/effects/Effect.html#relevantProperties" class="signatureLink">relevantProperties</a> : Array<div class="summaryTableDescription"> |
| An Array of property names to use when performing filtering.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/effects/Effect.html#relevantStyles" class="signatureLink">relevantStyles</a> : Array<div class="summaryTableDescription"> |
| An Array of style names to use when performing filtering.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/effects/Effect.html#repeatCount" class="signatureLink">repeatCount</a> : int = 1<div class="summaryTableDescription"> |
| Number of times to repeat the effect.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/effects/Effect.html#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"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#scaleEasingFunction" class="signatureLink">scaleEasingFunction</a> : Function<div class="summaryTableDescription"> |
| Easing function to use for scaling the mask.</div></td><td class="summaryTableOwnerCol">MaskEffect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#scaleXFrom" class="signatureLink">scaleXFrom</a> : Number<div class="summaryTableDescription"> |
| Initial scaleX for mask.</div></td><td class="summaryTableOwnerCol">MaskEffect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#scaleXTo" class="signatureLink">scaleXTo</a> : Number<div class="summaryTableDescription"> |
| Ending scaleX for mask.</div></td><td class="summaryTableOwnerCol">MaskEffect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#scaleYFrom" class="signatureLink">scaleYFrom</a> : Number<div class="summaryTableDescription"> |
| Initial scaleY for mask.</div></td><td class="summaryTableOwnerCol">MaskEffect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#scaleYTo" class="signatureLink">scaleYTo</a> : Number<div class="summaryTableDescription"> |
| Ending scaleY for mask.</div></td><td class="summaryTableOwnerCol">MaskEffect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#showTarget" class="signatureLink">showTarget</a> : Boolean<div class="summaryTableDescription"> |
| Specifies that the target component is becoming visible, |
| true, or invisible, false.</div></td><td class="summaryTableOwnerCol">MaskEffect</td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/effects/Effect.html#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"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/effects/Effect.html#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"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/effects/Effect.html#target" class="signatureLink">target</a> : Object<div class="summaryTableDescription"> |
| The object to which this effect is applied.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/effects/Effect.html#targets" class="signatureLink">targets</a> : Array<div class="summaryTableDescription"> |
| An Array of objects that are targets for the effect.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/effects/Effect.html#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"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#xFrom" class="signatureLink">xFrom</a> : Number<div class="summaryTableDescription"> |
| Initial position's x coordinate for mask.</div></td><td class="summaryTableOwnerCol">MaskEffect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#xTo" class="signatureLink">xTo</a> : Number<div class="summaryTableDescription"> |
| Destination position's x coordinate for mask.</div></td><td class="summaryTableOwnerCol">MaskEffect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#yFrom" class="signatureLink">yFrom</a> : Number<div class="summaryTableDescription"> |
| Initial position's y coordinate for mask.</div></td><td class="summaryTableOwnerCol">MaskEffect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#yTo" class="signatureLink">yTo</a> : Number<div class="summaryTableDescription"> |
| Destination position's y coordinate for mask.</div></td><td class="summaryTableOwnerCol">MaskEffect</td></tr></table></div><a name="protectedPropertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Protected Properties</div><div class="showHideLinks"><div id="hideInheritedProtectedProperty" class="hideInheritedProtectedProperty"><a class="showHideLink" href="#protectedPropertySummary" onclick="javascript:setInheritedVisible(false,'ProtectedProperty');"><img class="showHideLinkImage" src="../../images/expanded.gif"> Hide Inherited Protected Properties</a></div><div id="showInheritedProtectedProperty" class="showInheritedProtectedProperty"><a class="showHideLink" href="#protectedPropertySummary" onclick="javascript:setInheritedVisible(true,'ProtectedProperty');"><img class="showHideLinkImage" src="../../images/collapsed.gif"> Show Inherited Protected Properties</a></div></div><table cellspacing="0" cellpadding="3" class="summaryTable hideInheritedProtectedProperty" id="summaryTableProtectedProperty"><tr><th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class="hideInheritedProtectedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/effects/Effect.html#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"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class="hideInheritedProtectedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/effects/Effect.html#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"><a href="../../mx/effects/Effect.html">Effect</a></td></tr></table></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </div><div class="showHideLinks"><div id="hideInheritedMethod" class="hideInheritedMethod"><a class="showHideLink" href="#methodSummary" onclick="javascript:setInheritedVisible(false,'Method');"><img class="showHideLinkImage" src="../../images/expanded.gif"> Hide Inherited Public Methods</a></div><div id="showInheritedMethod" class="showInheritedMethod"><a class="showHideLink" href="#methodSummary" onclick="javascript:setInheritedVisible(true,'Method');"><img class="showHideLinkImage" src="../../images/collapsed.gif"> Show Inherited Public Methods</a></div></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="#MaskEffect()" class="signatureLink">MaskEffect</a>(target:Object = null)</div><div class="summaryTableDescription"> |
| Constructor.</div></td><td class="summaryTableOwnerCol">MaskEffect</td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/effects/Effect.html#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"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/effects/Effect.html#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"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/effects/Effect.html#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"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/effects/Effect.html#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"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/effects/Effect.html#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"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/effects/Effect.html#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"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/effects/Effect.html#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"><a href="../../mx/effects/Effect.html">Effect</a></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">[override] |
| Returns the component properties modified by this effect.</div></td><td class="summaryTableOwnerCol">MaskEffect</td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/effects/Effect.html#pause()" class="signatureLink">pause</a>():void</div><div class="summaryTableDescription"> |
| Pauses the effect until you call the resume() method.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/effects/Effect.html#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"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/effects/Effect.html#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"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/effects/Effect.html#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"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/effects/Effect.html#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"><a href="../../mx/effects/Effect.html">Effect</a></td></tr></table></div><a name="protectedMethodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Protected Methods </div><div class="showHideLinks"><div id="hideInheritedProtectedMethod" class="hideInheritedProtectedMethod"><a class="showHideLink" href="#protectedMethodSummary" onclick="javascript:setInheritedVisible(false,'ProtectedMethod');"><img class="showHideLinkImage" src="../../images/expanded.gif"> Show Inherited Protected Methods</a></div><div id="showInheritedProtectedMethod" class="showInheritedProtectedMethod"><a class="showHideLink" href="#protectedMethodSummary" onclick="javascript:setInheritedVisible(true,'ProtectedMethod');"><img class="showHideLinkImage" src="../../images/collapsed.gif"> Show Inherited Protected Methods</a></div></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="hideInheritedProtectedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/effects/Effect.html#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"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class="hideInheritedProtectedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/effects/Effect.html#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"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class="hideInheritedProtectedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/effects/Effect.html#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"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class="hideInheritedProtectedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/effects/Effect.html#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"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class="hideInheritedProtectedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/effects/Effect.html#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"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class="hideInheritedProtectedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/effects/Effect.html#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"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class="hideInheritedProtectedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/effects/Effect.html#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"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#tweenEventHandler()" class="signatureLink">tweenEventHandler</a>(event:<a href="../../mx/events/TweenEvent.html">TweenEvent</a>):void</div><div class="summaryTableDescription"> |
| Called when the TweenEffect dispatches a TweenEvent.</div></td><td class="summaryTableOwnerCol">MaskEffect</td></tr></table></div><a name="eventSummary"></a><div class="summarySection"><div class="summaryTableTitle">Events</div><div class="showHideLinks"><div id="hideInheritedEvent" class="hideInheritedEvent"><a class="showHideLink" href="#eventSummary" onclick="javascript:setInheritedVisible(false,'Event');"><img class="showHideLinkImage" src="../../images/expanded.gif"> Hide Inherited Events</a></div><div id="showInheritedEvent" class="showInheritedEvent"><a class="showHideLink" href="#eventSummary" onclick="javascript:setInheritedVisible(true,'Event');"><img class="showHideLinkImage" src="../../images/collapsed.gif"> Show Inherited Events</a></div></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="hideInheritedEvent"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/effects/Effect.html#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"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class="hideInheritedEvent"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/effects/Effect.html#event:effectStart" class="signatureLink">effectStart</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when the effect starts playing.</td><td class="summaryTableOwnerCol"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class="hideInheritedEvent"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/effects/Effect.html#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"><a href="../../mx/effects/Effect.html">Effect</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:tweenEnd" class="signatureLink">tweenEnd</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when the effect ends.</td><td class="summaryTableOwnerCol">MaskEffect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:tweenStart" class="signatureLink">tweenStart</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when the effect starts, which corresponds to the first call to the onMoveTweenUpdate() and onScaleTweenUpdate() methods.</td><td class="summaryTableOwnerCol">MaskEffect</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:tweenUpdate" class="signatureLink">tweenUpdate</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched every time the effect updates the target.</td><td class="summaryTableOwnerCol">MaskEffect</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="createMaskFunction"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">createMaskFunction</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>public var createMaskFunction:Function</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> |
| Function called when the effect creates the mask. |
| The default value is a function that returns a Rectangle |
| with the same dimensions as the target. |
| <p>The custom mask function has the following signature:</p> |
| <pre> |
| public function createLargeMask(targ:Object, bounds:Rectangle):Shape |
| { |
| var myMask:Shape = new FlexShape(); |
| // Create mask. |
| return myMask; |
| } |
| </pre> |
| <p>Your custom mask function takes an argument |
| corresponding to the target component of the effect, |
| and a second argument that defines the dimensions of the |
| target so that you can correctly size the mask. |
| You use that argument to access properties of the target |
| component, such as <code>width</code> and <code>height</code>, |
| so that you can create a mask with the correct size.</p> |
| <p>The function returns a single Shape object |
| that defines the mask.</p> |
| |
| </p></div><a name="propertyDetail"></a><a name="moveEasingFunction"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">moveEasingFunction</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var moveEasingFunction:Function</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> |
| Easing function to use for moving the mask. |
| </p><p> The default value is <code>null</code>.</p></div><a name="propertyDetail"></a><a name="scaleEasingFunction"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">scaleEasingFunction</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var scaleEasingFunction:Function</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> |
| Easing function to use for scaling the mask. |
| </p><p> The default value is <code>null</code>.</p></div><a name="propertyDetail"></a><a name="scaleXFrom"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">scaleXFrom</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var scaleXFrom: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> |
| Initial scaleX for mask. |
| <p>To specify this property, |
| you must specify all four of these properties: |
| <code>scaleXFrom</code>, <code>scaleYFrom</code>, |
| <code>scaleXTo</code>, and <code>scaleX</code>.</p> |
| |
| </p></div><a name="propertyDetail"></a><a name="scaleXTo"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">scaleXTo</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var scaleXTo: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> |
| Ending scaleX for mask. |
| <p>To specify this property, |
| you must specify all four of these properties: |
| <code>scaleXFrom</code>, <code>scaleYFrom</code>, |
| <code>scaleXTo</code>, and <code>scaleX</code>.</p> |
| |
| </p></div><a name="propertyDetail"></a><a name="scaleYFrom"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">scaleYFrom</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var scaleYFrom: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> |
| Initial scaleY for mask. |
| <p>To specify this property, |
| you must specify all four of these properties: |
| <code>scaleXFrom</code>, <code>scaleYFrom</code>, |
| <code>scaleXTo</code>, and <code>scaleX</code>.</p> |
| |
| </p></div><a name="propertyDetail"></a><a name="scaleYTo"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">scaleYTo</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var scaleYTo: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> |
| Ending scaleY for mask. |
| <p>To specify this property, |
| you must specify all four of these properties: |
| <code>scaleXFrom</code>, <code>scaleYFrom</code>, |
| <code>scaleXTo</code>, and <code>scaleX</code>.</p> |
| |
| </p></div><a name="propertyDetail"></a><a name="showTarget"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">showTarget</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>showTarget: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> |
| Specifies that the target component is becoming visible, |
| <code>true</code>, or invisible, <code>false</code>. |
| If you specify this effect for a <code>showEffect</code> or |
| <code>hideEffect</code> trigger, Flex sets the |
| <code>showTarget</code> property for you, either to |
| <code>true</code> if the component becomes visible, |
| or <code>false</code> if the component becomes invisible. |
| If you use this effect with a different effect trigger, |
| you should set it yourself, often within the |
| event listener for the <code>startEffect</code> event. |
| </p><p> The default value is <code>true</code>.</p><br/><span class="label"> Implementation </span><br/><code> public function get showTarget():Boolean</code><br/><code> public function set showTarget(value:Boolean):void</code><br/></div><a name="propertyDetail"></a><a name="xFrom"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">xFrom</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var xFrom: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> |
| Initial position's x coordinate for mask. |
| <p>To specify this property, |
| you must specify all four of these properties: |
| <code>xFrom</code>, <code>yFrom</code>, <code>xTo</code>, |
| and <code>yTo</code>. </p> |
| |
| </p></div><a name="propertyDetail"></a><a name="xTo"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">xTo</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var xTo: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> |
| Destination position's x coordinate for mask. |
| <p>To specify this property, |
| you must specify all four of these properties: |
| <code>xFrom</code>, <code>yFrom</code>, <code>xTo</code>, |
| and <code>yTo</code>. </p> |
| |
| </p></div><a name="propertyDetail"></a><a name="yFrom"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">yFrom</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var yFrom: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> |
| Initial position's y coordinate for mask. |
| <p>To specify this property, |
| you must specify all four of these properties: |
| <code>xFrom</code>, <code>yFrom</code>, <code>xTo</code>, |
| and <code>yTo</code>. </p> |
| |
| </p></div><a name="propertyDetail"></a><a name="yTo"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">yTo</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var yTo: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> |
| Destination position's y coordinate for mask. |
| <p>To specify this property, |
| you must specify all four of these properties: |
| <code>xFrom</code>, <code>yFrom</code>, <code>xTo</code>, |
| and <code>yTo</code>. </p> |
| |
| </p></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="MaskEffect()"></a><a name="MaskEffect(Object)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">MaskEffect</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function MaskEffect(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><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="getAffectedProperties()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getAffectedProperties</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code>override 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 the component properties modified by this effect. |
| This method returns an Array containing: |
| <code>[ "visible", "width", "height" ]</code>. |
| Since the WipeDown, WipeLeft, WipeRight, and WipeDown effect |
| subclasses all modify these same properties, those classes |
| do not implement this method. |
| |
| <p>If you subclass the MaskEffect class to create a custom effect, |
| and it modifies a different set of properties on the target, |
| you must override this method |
| and return an Array containing a list of the properties |
| modified by your subclass.</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><p><span class="label">See also</span></p><div class="seeAlso"><a href="Effect.html#getAffectedProperties()" target="">mx.effects.Effect.getAffectedProperties()</a></div></div><a name="tweenEventHandler()"></a><a name="tweenEventHandler(mx.events.TweenEvent)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">tweenEventHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function tweenEventHandler(event:<a href="../../mx/events/TweenEvent.html">TweenEvent</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 the TweenEffect dispatches a TweenEvent. |
| 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/TweenEvent.html">TweenEvent</a></code> — An event object of type TweenEvent. |
| |
| </td></tr></table></p></div><div class="detailSectionHeader"> Event Detail </div><a name="event:tweenEnd"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">tweenEnd</td><td class="detailHeaderType"> Event </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/TweenEvent.html"><code>mx.events.TweenEvent</code></a><br/><span class="label">TweenEvent.type property = </span><a href="../../mx/events/TweenEvent.html#TWEEN_END"><code>mx.events.TweenEvent.TWEEN_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 the effect ends. |
| <p>When an effect plays a single time, this event occurs |
| at the same time as an <code>effectEnd</code> event. |
| If you configure the effect to repeat, |
| it occurs at the end of every repetition of the effect, |
| and the <code>endEffect</code> event occurs |
| after the effect plays for the final time.</p> |
| </p> |
| The <code>TweenEvent.TWEEN_END</code> constant defines the value of the |
| event object's <code>type</code> property for a <code>tweenEnd</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>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><tr><td><code>value</code></td><td>The value passed to the |
| <code>onTweenEnd()</code> method.</td></tr></table> |
| </div><a name="event:tweenStart"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">tweenStart</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/TweenEvent.html"><code>mx.events.TweenEvent</code></a><br/><span class="label">TweenEvent.type property = </span><a href="../../mx/events/TweenEvent.html#TWEEN_START"><code>mx.events.TweenEvent.TWEEN_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, which corresponds to the |
| first call to the <code>onMoveTweenUpdate()</code> |
| and <code>onScaleTweenUpdate()</code> methods. |
| Flex also dispatches the first <code>tweenUpdate</code> event |
| for the effect at the same time. |
| <p>The <code>Effect.effectStart</code> event is dispatched |
| before the <code>tweenStart</code> event.</p> |
| </p> |
| The <code>TweenEvent.TWEEN_START</code> constant defines the value of the |
| event object's <code>type</code> property for a <code>tweenStart</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>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><tr><td><code>value</code></td><td>The value passed to the |
| <code>onTweenUpdate()</code> method.</td></tr></table> |
| </div><a name="event:tweenUpdate"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">tweenUpdate</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/TweenEvent.html"><code>mx.events.TweenEvent</code></a><br/><span class="label">TweenEvent.type property = </span><a href="../../mx/events/TweenEvent.html#TWEEN_UPDATE"><code>mx.events.TweenEvent.TWEEN_UPDATE</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 every time the effect updates the target. |
| The dispatching of this event corresponds to the |
| calls to the <code>onMoveTweenUpdate()</code> |
| and <code>onScaleTweenUpdate()</code> methods. |
| </p> |
| The <code>TweenEvent.TWEEN_UPDATE</code> constant defines the value of the |
| event object's <code>type</code> property for a <code>tweenUpdate</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>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><tr><td><code>value</code></td><td>The value passed to the |
| <code>onTweenUpdate()</code> method.</td></tr></table> |
| </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 --> |
