| <!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="SpriteVisualElement,spark.core.SpriteVisualElement,ALPHA,AUTO,CLIP,DOWN,END,HOME,LEFT,LUMINOSITY,NEVER,OWNS_SHARED_OBJECT,OWNS_UNSHARED_OBJECT,PAGE_DOWN,PAGE_LEFT,PAGE_RIGHT,PAGE_UP,RIGHT,UNTRUSTED,UP,USES_SHARED_OBJECT,accessibilityProperties,activeRequests,baseline,baselinePosition,blendMode,bottom,cacheEntries,cachedData,clipAndEnableScrolling,complete,content,contentHeight,contentWidth,depth,designLayer,displayAsPassword,displayObject,displayObjectSharingMode,editable,enableCaching,enableQueueing,enabled,focusEnabled,hasLayoutMatrix3D,horizontalCenter,horizontalScrollPosition,horizontalScrollPosition,id,includeInLayout,is3D,isTruncated,layoutDirection,left,lineBreak,luminosityClip,luminosityInvert,mask,maskType,maxActiveRequests,maxCacheEntries,maxChars,moduleFactory,multiline,numCacheEntries,owner,percentHeight,percentWidth,postLayoutTransformOffsets,priorityGroup,redrawRequested,requestQueue,restrict,right,rotationX,rotationY,selectable,selectionActivePosition,selectionAnchorPosition,tabIndex,text,top,transformX,transformY,transformZ,verticalCenter,verticalScrollPosition,verticalScrollPosition,viewHeight,viewWidth,visible,addCacheEntry,appendText,canShareWithNext,canShareWithPrevious,createDisplayObject,getBoundsXAtSize,getBoundsYAtSize,getCacheEntry,getHorizontalScrollPositionDelta,getLayoutBoundsHeight,getLayoutBoundsWidth,getLayoutBoundsX,getLayoutBoundsY,getLayoutMatrix,getLayoutMatrix3D,getMaxBoundsHeight,getMaxBoundsWidth,getMinBoundsHeight,getMinBoundsWidth,getPreferredBoundsHeight,getPreferredBoundsWidth,getVerticalScrollPositionDelta,initialized,insertText,invalidateGraphicElementDisplayList,invalidateGraphicElementProperties,invalidateGraphicElementSharing,invalidateGraphicElementSize,invalidateLayoutDirection,invalidateParentSizeAndDisplayList,isNavigationUnit,keepSoftKeyboardActive,load,load,parentChanged,prepareForTouchScroll,prioritize,removeAllCacheEntries,removeAllQueueEntries,removeCacheEntry,scrollToRange,selectAll,selectRange,setFocus,setLayoutBoundsPosition,setLayoutBoundsSize,setLayoutMatrix,setLayoutMatrix3D,setSharedDisplayObject,transformAround,transformHeightForLayout,transformPointToParent,transformWidthForLayout,validateDisplayList,validateProperties,validateSize"><title>spark.core.SpriteVisualElement</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 = 'SpriteVisualElement - 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?spark/core/SpriteVisualElement.html&spark/core/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">SpriteVisualElement</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a> | <a href="#methodSummary">Methods</a></td></tr><tr class="titleTableRow3"><td colspan="3"> </td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve"> |
| <!-- |
| |
| if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("SpriteVisualElement"); titleBar_setSubNav(false,true,false,false,false,false,false,false,true,false,false ,false,false,false,false,false);} |
| --> |
| </script><div xmlns:fn="http://www.w3.org/2005/xpath-functions" class="MainContent"><table class="classHeaderTable" cellpadding="0" cellspacing="0"><tr><td class="classHeaderTableLabel">Package</td><td><a href="package-detail.html" onclick="javascript:loadClassListFrame('class-list.html')">spark.core</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class SpriteVisualElement</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">SpriteVisualElement <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> <a href="../../mx/core/FlexSprite.html">FlexSprite</a> <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> flash.display.Sprite</td></tr><tr><td class="classHeaderTableLabel">Implements</td><td> <a href="../../mx/core/IVisualElement.html">IVisualElement</a>, <a href="../../mx/core/IMXMLObject.html">IMXMLObject</a>, <a href="../../mx/core/IFlexModule.html">IFlexModule</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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p></p><p></p> |
| The SpriteVisualElement class is a light-weight Sprite-based implemention |
| of the IVisualElement interface. Spark containers can lay out and render SpriteVisualElement objects. |
| |
| <p>If you use ActionScript to add an FXG component to an application, it should be of type SpriteVisualElement.</p> |
| <p></p><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="#baseline" class="signatureLink">baseline</a> : Object<div class="summaryTableDescription"> |
| |
| The vertical distance in pixels from the anchor target to |
| the control's baseline position.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#baselinePosition" class="signatureLink">baselinePosition</a> : Number<div class="summaryTableDescription">[read-only] |
| |
| The y-coordinate of the baseline |
| of the first line of text of the component.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#blendMode" class="signatureLink">blendMode</a> : String<div class="summaryTableDescription">[override] |
| A value from the BlendMode class that specifies which blend mode to use.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#bottom" class="signatureLink">bottom</a> : Object<div class="summaryTableDescription"> |
| |
| The vertical distance in pixels from the bottom edge of the component to the |
| anchor target's bottom edge.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#depth" class="signatureLink">depth</a> : Number<div class="summaryTableDescription"> |
| |
| Determines the order in which items inside of containers |
| are rendered.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#designLayer" class="signatureLink">designLayer</a> : <a href="../../mx/core/DesignLayer.html">DesignLayer</a><div class="summaryTableDescription"> |
| Specifies the optional DesignLayer instance associated with this visual |
| element.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#hasLayoutMatrix3D" class="signatureLink">hasLayoutMatrix3D</a> : Boolean<div class="summaryTableDescription">[read-only] |
| |
| Contains true if the element has 3D Matrix.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#horizontalCenter" class="signatureLink">horizontalCenter</a> : Object<div class="summaryTableDescription"> |
| |
| The horizontal distance in pixels from the center of the component to the |
| center of the anchor target's content area.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#id" class="signatureLink">id</a> : String<div class="summaryTableDescription"> |
| The identity of the component.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#includeInLayout" class="signatureLink">includeInLayout</a> : Boolean<div class="summaryTableDescription"> |
| Specifies whether this component is included in the layout of the |
| parent container.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#is3D" class="signatureLink">is3D</a> : Boolean<div class="summaryTableDescription">[read-only] |
| |
| Contains true when the element is in 3D.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#layoutDirection" class="signatureLink">layoutDirection</a> : String<div class="summaryTableDescription"> |
| |
| Specifies the desired layout direction for an element: one of LayoutDirection.LTR |
| (left to right), LayoutDirection.RTL (right to left), or null (inherit).</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#left" class="signatureLink">left</a> : Object<div class="summaryTableDescription"> |
| |
| The horizontal distance in pixels from the left edge of the component to the |
| anchor target's left edge.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#luminosityClip" class="signatureLink">luminosityClip</a> : Boolean<div class="summaryTableDescription"> |
| A property that controls whether the luminosity |
| mask clips the masked content.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#luminosityInvert" class="signatureLink">luminosityInvert</a> : Boolean<div class="summaryTableDescription"> |
| A property that controls the calculation of the RGB |
| color value of a graphic element being masked by |
| a luminosity mask.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#mask" class="signatureLink">mask</a> : DisplayObject<div class="summaryTableDescription">[override] |
| Sets the mask.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#maskType" class="signatureLink">maskType</a> : String<div class="summaryTableDescription"> |
| The mask type.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#moduleFactory" class="signatureLink">moduleFactory</a> : <a href="../../mx/core/IFlexModuleFactory.html">IFlexModuleFactory</a><div class="summaryTableDescription"> |
| A module factory is used as context for using embeded fonts and for |
| finding the style manager that controls the styles for this |
| component.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#owner" class="signatureLink">owner</a> : DisplayObjectContainer<div class="summaryTableDescription"> |
| |
| The owner of this IVisualElement object.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#percentHeight" class="signatureLink">percentHeight</a> : Number<div class="summaryTableDescription"> |
| |
| Specifies the height of a component as a percentage |
| of its parent's size.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#percentWidth" class="signatureLink">percentWidth</a> : Number<div class="summaryTableDescription"> |
| Specifies the width of a component as a percentage |
| of its parent's size.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#postLayoutTransformOffsets" class="signatureLink">postLayoutTransformOffsets</a> : <a href="../../mx/geom/TransformOffsets.html">TransformOffsets</a><div class="summaryTableDescription"> |
| Defines a set of adjustments that can be applied to the object's |
| transform in a way that is invisible to its parent's layout.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#right" class="signatureLink">right</a> : Object<div class="summaryTableDescription"> |
| |
| The horizontal distance in pixels from the right edge of the component to the |
| anchor target's right edge.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#rotationX" class="signatureLink">rotationX</a> : Number<div class="summaryTableDescription">[override] |
| Indicates the x-axis rotation of the DisplayObject instance, in degrees, |
| from its original orientation relative to the 3D parent container.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#rotationY" class="signatureLink">rotationY</a> : Number<div class="summaryTableDescription">[override] |
| Indicates the y-axis rotation of the DisplayObject instance, in degrees, |
| from its original orientation relative to the 3D parent container.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#top" class="signatureLink">top</a> : Object<div class="summaryTableDescription"> |
| |
| The vertical distance in pixels from the top edge of the component to the |
| anchor target's top edge.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#transformX" class="signatureLink">transformX</a> : Number<div class="summaryTableDescription"> |
| Sets the x coordinate for the transform center of the component.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#transformY" class="signatureLink">transformY</a> : Number<div class="summaryTableDescription"> |
| Sets the y coordinate for the transform center of the component.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#transformZ" class="signatureLink">transformZ</a> : Number<div class="summaryTableDescription"> |
| Sets the z coordinate for the transform center of the component.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#verticalCenter" class="signatureLink">verticalCenter</a> : Object<div class="summaryTableDescription"> |
| |
| The vertical distance in pixels from the center of the component to the |
| center of the anchor target's content area.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#visible" class="signatureLink">visible</a> : Boolean<div class="summaryTableDescription">[override] |
| |
| Controls the visibility of this visual element.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</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="#viewHeight" class="signatureLink">viewHeight</a> : Number<div class="summaryTableDescription">[write-only] |
| Defines the vertical space that the graphic uses in the layout.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#viewWidth" class="signatureLink">viewWidth</a> : Number<div class="summaryTableDescription">[write-only] |
| Defines the horizontal space that the graphic uses in the layout.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</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="#SpriteVisualElement()" class="signatureLink">SpriteVisualElement</a>()</div><div class="summaryTableDescription"> |
| Constructor.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getBoundsXAtSize()" class="signatureLink">getBoundsXAtSize</a>(width:Number, height:Number, postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| |
| Returns the x coordinate of the element's bounds at the specified element size.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getBoundsYAtSize()" class="signatureLink">getBoundsYAtSize</a>(width:Number, height:Number, postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| |
| Returns the y coordinate of the element's bounds at the specified element size.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getLayoutBoundsHeight()" class="signatureLink">getLayoutBoundsHeight</a>(postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| |
| Returns the element's layout height.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getLayoutBoundsWidth()" class="signatureLink">getLayoutBoundsWidth</a>(postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| Returns the element's layout width.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getLayoutBoundsX()" class="signatureLink">getLayoutBoundsX</a>(postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| |
| Returns the x coordinate that the element uses to draw on screen.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getLayoutBoundsY()" class="signatureLink">getLayoutBoundsY</a>(postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| |
| Returns the y coordinate that the element uses to draw on screen.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getLayoutMatrix()" class="signatureLink">getLayoutMatrix</a>():Matrix</div><div class="summaryTableDescription"> |
| |
| Returns the transform matrix that is used to calculate the component's |
| layout relative to its siblings.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getLayoutMatrix3D()" class="signatureLink">getLayoutMatrix3D</a>():Matrix3D</div><div class="summaryTableDescription"> |
| |
| Returns the layout transform Matrix3D for this element.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getMaxBoundsHeight()" class="signatureLink">getMaxBoundsHeight</a>(postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| |
| Returns the element's maximum height.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getMaxBoundsWidth()" class="signatureLink">getMaxBoundsWidth</a>(postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| |
| Returns the element's maximum width.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getMinBoundsHeight()" class="signatureLink">getMinBoundsHeight</a>(postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| |
| Returns the element's minimum height.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getMinBoundsWidth()" class="signatureLink">getMinBoundsWidth</a>(postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| |
| Returns the element's minimum width.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getPreferredBoundsHeight()" class="signatureLink">getPreferredBoundsHeight</a>(postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| |
| Returns the element's preferred height.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getPreferredBoundsWidth()" class="signatureLink">getPreferredBoundsWidth</a>(postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| |
| Returns the element's preferred width.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#initialized()" class="signatureLink">initialized</a>(document:Object, id:String):void</div><div class="summaryTableDescription"> |
| Called automatically by the MXML compiler when the SpriteVisualElement |
| is created using an MXML tag.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#invalidateLayoutDirection()" class="signatureLink">invalidateLayoutDirection</a>():void</div><div class="summaryTableDescription"> |
| |
| An element must call this method when its layoutDirection changes or |
| when its parent's layoutDirection changes.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#setLayoutBoundsPosition()" class="signatureLink">setLayoutBoundsPosition</a>(newBoundsX:Number, newBoundsY:Number, postLayoutTransform:Boolean = true):void</div><div class="summaryTableDescription"> |
| |
| Sets the coordinates that the element uses to draw on screen.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#setLayoutBoundsSize()" class="signatureLink">setLayoutBoundsSize</a>(width:Number, height:Number, postLayoutTransform:Boolean = true):void</div><div class="summaryTableDescription"> |
| |
| Sets the layout size of the element.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#setLayoutMatrix()" class="signatureLink">setLayoutMatrix</a>(value:Matrix, invalidateLayout:Boolean):void</div><div class="summaryTableDescription"> |
| |
| Sets the transform Matrix that is used to calculate the component's layout |
| size and position relative to its siblings.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#setLayoutMatrix3D()" class="signatureLink">setLayoutMatrix3D</a>(value:Matrix3D, invalidateLayout:Boolean):void</div><div class="summaryTableDescription"> |
| |
| Sets the transform Matrix3D that is used to calculate the component's layout |
| size and position relative to its siblings.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</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/core/FlexSprite.html#toString()" class="signatureLink">toString</a>():String</div><div class="summaryTableDescription">[override] |
| Returns a string indicating the location of this object |
| within the hierarchy of DisplayObjects in the Application.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/FlexSprite.html">FlexSprite</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#transformAround()" class="signatureLink">transformAround</a>(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void</div><div class="summaryTableDescription"> |
| A utility method to update the rotation, scale, and translation of the |
| transform while keeping a particular point, specified in the component's |
| own coordinate space, fixed in the parent's coordinate space.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#transformPointToParent()" class="signatureLink">transformPointToParent</a>(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void</div><div class="summaryTableDescription"> |
| A utility method to transform a point specified in the local |
| coordinates of this object to its location in the object's parent's |
| coordinates.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</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="#invalidateParentSizeAndDisplayList()" class="signatureLink">invalidateParentSizeAndDisplayList</a>():void</div><div class="summaryTableDescription"> |
| Invalidates parent size and display list if |
| this object affects its layout (includeInLayout is true).</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#transformHeightForLayout()" class="signatureLink">transformHeightForLayout</a>(width:Number, height:Number, postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| Transform the element's size.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#transformWidthForLayout()" class="signatureLink">transformWidthForLayout</a>(width:Number, height:Number, postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| Transform the element's size.</div></td><td class="summaryTableOwnerCol">SpriteVisualElement</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="baseline"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">baseline</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>baseline: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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| The vertical distance in pixels from the anchor target to |
| the control's baseline position. |
| <p>By default the anchor target is the top edge of the container's |
| content area. In layouts with advanced constraints, the target can be |
| a constraint row.</p> |
| <p>Setting the property to a number or to a numerical string like "10" |
| specifies use of the default anchor target.</p> |
| <p>To specify an anchor target, set the property value to a string in the format: |
| "anchorTargetName:value". For example, "row1:10".</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get baseline():Object</code><br/><code> public function set baseline(value:Object):void</code><br/></div><a name="propertyDetail"></a><a name="baselinePosition"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">baselinePosition</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>baselinePosition:Number</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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| The y-coordinate of the baseline |
| of the first line of text of the component. |
| <p>This property is used to implement |
| the <code>baseline</code> constraint style. |
| It is also used to align the label of a FormItem |
| with the controls in the FormItem.</p> |
| <p>Each component should override this property.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get baselinePosition():Number</code><br/></div><a name="propertyDetail"></a><a name="blendMode"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">blendMode</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>blendMode:String</code>[override] <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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| A value from the BlendMode class that specifies which blend mode to use. |
| |
| </p><p> The default value is <code>auto</code>.</p><br/><span class="label"> Implementation </span><br/><code> public function get blendMode():String</code><br/><code> public function set blendMode(value:String):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso">flash.display.DisplayObject.blendMode<br/>flash.display.BlendMode</div></div><a name="propertyDetail"></a><a name="bottom"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">bottom</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>bottom: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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| The vertical distance in pixels from the bottom edge of the component to the |
| anchor target's bottom edge. |
| <p>By default the anchor target is the container's content area. In layouts |
| with advanced constraints, the target can be a constraint row.</p> |
| <p>Setting the property to a number or to a numerical string like "10" |
| specifies use of the default anchor target.</p> |
| <p>To specify an anchor target, set the property value to a string in the format: |
| "anchorTargetName:value". For example, "row1:10".</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get bottom():Object</code><br/><code> public function set bottom(value:Object):void</code><br/></div><a name="propertyDetail"></a><a name="depth"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">depth</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>depth: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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Determines the order in which items inside of containers |
| are rendered. |
| Spark containers order their items based on their |
| <code>depth</code> property, with the lowest depth in the back, |
| and the higher in the front. |
| Items with the same depth value appear in the order |
| they are added to the container. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get depth():Number</code><br/><code> public function set depth(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="designLayer"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">designLayer</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>designLayer:<a href="../../mx/core/DesignLayer.html">DesignLayer</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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Specifies the optional DesignLayer instance associated with this visual |
| element. |
| <p>When a DesignLayer is assigned, a visual element must consider the |
| visibility and alpha of its parent layer when ultimately committing its |
| own effective visibility or alpha to its backing DisplayObject |
| (if applicable).</p> |
| <p>A visual element must listen for <code>layerPropertyChange</code> |
| notifications from the associated layer parent. When the |
| <code>effectiveAlpha</code> or <code>effectiveVisibility</code> of the |
| layer changes, the element must then compute its own effective visibility |
| (or alpha) and apply it accordingly.</p> |
| <p>This property should not be set within MXML directly.</p> |
| |
| <p>The <code>designLayer</code> property is not used for z-order control, |
| please see <code>depth</code>.</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get designLayer():<a href="../../mx/core/DesignLayer.html">DesignLayer</a></code><br/><code> public function set designLayer(value:<a href="../../mx/core/DesignLayer.html">DesignLayer</a>):void</code><br/></div><a name="propertyDetail"></a><a name="hasLayoutMatrix3D"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">hasLayoutMatrix3D</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>hasLayoutMatrix3D: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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Contains <code>true</code> if the element has 3D Matrix. |
| <p>Use <code>hasLayoutMatrix3D</code> instead of calling and examining the |
| return value of <code>getLayoutMatrix3D()</code> because that method returns a valid |
| matrix even when the element is in 2D.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get hasLayoutMatrix3D():Boolean</code><br/></div><a name="propertyDetail"></a><a name="horizontalCenter"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">horizontalCenter</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>horizontalCenter: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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| The horizontal distance in pixels from the center of the component to the |
| center of the anchor target's content area. |
| <p>The default anchor target is the container itself.</p> |
| <p>In layouts with advanced constraints, the anchor target can be a constraint column. |
| Then the content area is the space between the preceding column |
| (or container side) and the target column.</p> |
| <p>Setting the property to a number or to a numerical string like "10" |
| specifies use of the default anchor target.</p> |
| <p>To specify an anchor target, set the property value to a string in the format |
| "constraintColumnId:value". For example, "col1:10".</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get horizontalCenter():Object</code><br/><code> public function set horizontalCenter(value:Object):void</code><br/></div><a name="propertyDetail"></a><a name="id"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">id</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>id: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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| The identity of the component. |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get id():String</code><br/><code> public function set id(value:String):void</code><br/></div><a name="propertyDetail"></a><a name="includeInLayout"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">includeInLayout</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>includeInLayout: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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Specifies whether this component is included in the layout of the |
| parent container. |
| If <code>true</code>, the object is included in its parent container's |
| layout and is sized and positioned by its parent container as per its layout rules. |
| If <code>false</code>, the object size and position are not affected by its parent container's |
| layout. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get includeInLayout():Boolean</code><br/><code> public function set includeInLayout(value:Boolean):void</code><br/></div><a name="propertyDetail"></a><a name="is3D"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">is3D</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>is3D: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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Contains <code>true</code> when the element is in 3D. |
| The element can be in 3D either because |
| it has 3D transform properties or it has 3D post layout transform offsets or both. |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get is3D():Boolean</code><br/></div><a name="propertyDetail"></a><a name="layoutDirection"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">layoutDirection</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>layoutDirection: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 4.5</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 10, AIR 2.5</td></tr></table><p></p><p></p><p> |
| |
| Specifies the desired layout direction for an element: one of LayoutDirection.LTR |
| (left to right), LayoutDirection.RTL (right to left), or null (inherit). |
| |
| This property is typically backed by an inheriting style. If null, |
| the layoutDirection style will be set to undefined. |
| |
| Classes like GraphicElement, which implement ILayoutDirectionElement but do not |
| support styles, must additionally support a null value for this property |
| which means the layoutDirection must be inherited from its parent. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get layoutDirection():String</code><br/><code> public function set layoutDirection(value:String):void</code><br/></div><a name="propertyDetail"></a><a name="left"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">left</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>left: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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| The horizontal distance in pixels from the left edge of the component to the |
| anchor target's left edge. |
| <p>By default the anchor target is the container's content area. In layouts |
| with advanced constraints, the target can be a constraint column.</p> |
| <p>Setting the property to a number or to a numerical string like "10" |
| specifies use of the default anchor target.</p> |
| <p>To specify an anchor target, set the property value to a string in the format |
| "anchorTargetName:value". For example, "col1:10".</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get left():Object</code><br/><code> public function set left(value:Object):void</code><br/></div><a name="propertyDetail"></a><a name="luminosityClip"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">luminosityClip</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>luminosityClip: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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| A property that controls whether the luminosity |
| mask clips the masked content. This property can |
| only have an effect if the graphic element has a |
| mask applied to it that is of type |
| MaskType.LUMINOSITY. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get luminosityClip():Boolean</code><br/><code> public function set luminosityClip(value:Boolean):void</code><br/></div><a name="propertyDetail"></a><a name="luminosityInvert"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">luminosityInvert</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>luminosityInvert: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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| A property that controls the calculation of the RGB |
| color value of a graphic element being masked by |
| a luminosity mask. If true, the RGB color value of a |
| pixel in the source content is inverted and multipled |
| by the corresponding region in the mask. If false, |
| the source content's pixel's RGB color value is used |
| directly. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get luminosityInvert():Boolean</code><br/><code> public function set luminosityInvert(value:Boolean):void</code><br/></div><a name="propertyDetail"></a><a name="mask"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">mask</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>mask:DisplayObject</code>[override] <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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Sets the mask. The mask will be added to the display list. The mask must |
| not already on a display list nor in the elements array. |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get mask():DisplayObject</code><br/><code> public function set mask(value:DisplayObject):void</code><br/></div><a name="propertyDetail"></a><a name="maskType"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">maskType</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>maskType: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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| <p>The mask type. Possible values are <code>MaskType.CLIP</code>, <code>MaskType.ALPHA</code> |
| or <code>MaskType.LUMINOSITY</code>.</p> |
| <p><b>Clip Masking</b></p> |
| |
| <p>When masking in clip mode, a clipping masks is reduced to 1-bit. This means that a mask will |
| not affect the opacity of a pixel in the source content; it either leaves the value unmodified, |
| if the corresponding pixel in the mask is has a non-zero alpha value, or makes it fully |
| transparent, if the mask pixel value has an alpha value of zero.</p> |
| |
| <p><b>Alpha Masking</b></p> |
| |
| <p>In alpha mode, the opacity of each pixel in the source content is multiplied by the opacity |
| of the corresponding region of the mask. i.e., a pixel in the source content with an opacity of |
| 1 that is masked by a region of opacity of .5 will have a resulting opacity of .5. A source pixel |
| with an opacity of .8 masked by a region with opacity of .5 will have a resulting opacity of .4.</p> |
| |
| <p><b>Luminosity Masking</b></p> |
| |
| <p>A luminosity mask, sometimes called a 'soft mask', works very similarly to an alpha mask |
| except that both the opacity and RGB color value of a pixel in the source content is multiplied |
| by the opacity and RGB color value of the corresponding region in the mask.</p> |
| |
| <p>Luminosity masking is not native to Flash but is common in Adobe Creative Suite tools like Adobe |
| Illustrator and Adobe Photoshop. In order to accomplish the visual effect of a luminosity mask in |
| Flash-rendered content, a graphic element specifying a luminosity mask actually instantiates a shader |
| filter that mimics the visual look of a luminosity mask as rendered in Adobe Creative Suite tools.</p> |
| |
| <p>Objects being masked by luminosity masks can set properties to control the RGB color value and |
| clipping of the mask. See the luminosityInvert and luminosityClip attributes.</p> |
| |
| </p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code> public function get maskType():String</code><br/><code> public function set maskType(value:String):void</code><br/></div><a name="propertyDetail"></a><a name="moduleFactory"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">moduleFactory</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>moduleFactory:<a href="../../mx/core/IFlexModuleFactory.html">IFlexModuleFactory</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 4</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 module factory is used as context for using embeded fonts and for |
| finding the style manager that controls the styles for this |
| component. |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get moduleFactory():<a href="../../mx/core/IFlexModuleFactory.html">IFlexModuleFactory</a></code><br/><code> public function set moduleFactory(value:<a href="../../mx/core/IFlexModuleFactory.html">IFlexModuleFactory</a>):void</code><br/></div><a name="propertyDetail"></a><a name="owner"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">owner</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>owner:DisplayObjectContainer</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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| The owner of this IVisualElement object. |
| By default, it is the parent of this IVisualElement object. |
| However, if this IVisualElement object is a child component that is |
| popped up by its parent, such as the drop-down list of a ComboBox control, |
| the owner is the component that popped up this IVisualElement object. |
| <p>This property is not managed by Flex, but by each component. |
| Therefore, if you use the <code>PopUpManger.createPopUp()</code> or |
| <code>PopUpManger.addPopUp()</code> method to pop up a child component, |
| you should set the <code>owner</code> property of the child component |
| to the component that popped it up.</p> |
| <p>The default value is the value of the <code>parent</code> property.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get owner():DisplayObjectContainer</code><br/><code> public function set owner(value:DisplayObjectContainer):void</code><br/></div><a name="propertyDetail"></a><a name="percentHeight"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">percentHeight</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>percentHeight: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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Specifies the height of a component as a percentage |
| of its parent's size. Allowed values are 0-100. |
| Setting the <code>height</code> or <code>explicitHeight</code> properties |
| resets this property to NaN. |
| <p>This property returns a numeric value only if the property was |
| previously set; it does not reflect the exact size of the component |
| in percent.</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get percentHeight():Number</code><br/><code> public function set percentHeight(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="percentWidth"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">percentWidth</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>percentWidth: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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Specifies the width of a component as a percentage |
| of its parent's size. Allowed values are 0-100. The default value is NaN. |
| Setting the <code>width</code> or <code>explicitWidth</code> properties |
| resets this property to NaN. |
| <p>This property returns a numeric value only if the property was |
| previously set; it does not reflect the exact size of the component |
| in percent.</p> |
| <p>This property is always set to NaN for the UITextField control.</p> |
| |
| <p>When used with Spark layouts, this property is used to calculate the |
| width of the component's bounds after scaling and rotation. For example |
| if the component is rotated at 90 degrees, then specifying |
| <code>percentWidth</code> will affect the component's height.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get percentWidth():Number</code><br/><code> public function set percentWidth(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="postLayoutTransformOffsets"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">postLayoutTransformOffsets</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>postLayoutTransformOffsets:<a href="../../mx/geom/TransformOffsets.html">TransformOffsets</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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Defines a set of adjustments that can be applied to the object's |
| transform in a way that is invisible to its parent's layout. |
| |
| <p>For example, if you want a layout to adjust for an object |
| that is rotated 90 degrees, set the object's |
| <code>rotation</code> property. If you want the layout to <i>not</i> |
| adjust for the object being rotated, |
| set its <code>postLayoutTransformOffsets.rotationZ</code> property.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get postLayoutTransformOffsets():<a href="../../mx/geom/TransformOffsets.html">TransformOffsets</a></code><br/><code> public function set postLayoutTransformOffsets(value:<a href="../../mx/geom/TransformOffsets.html">TransformOffsets</a>):void</code><br/></div><a name="propertyDetail"></a><a name="right"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">right</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>right: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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| The horizontal distance in pixels from the right edge of the component to the |
| anchor target's right edge. |
| <p>By default the anchor target is the container's content area. In layouts |
| with advanced constraints, the target can be a constraint column.</p> |
| <p>Setting the property to a number or to a numerical string like "10" |
| specifies use of the default anchor target.</p> |
| <p>To specify an anchor target, set the property value to a string in the format |
| "anchorTargetName:value". For example, "col1:10".</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get right():Object</code><br/><code> public function set right(value:Object):void</code><br/></div><a name="propertyDetail"></a><a name="rotationX"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">rotationX</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>rotationX:Number</code>[override] <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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Indicates the x-axis rotation of the DisplayObject instance, in degrees, |
| from its original orientation relative to the 3D parent container. |
| Values from 0 to 180 represent clockwise rotation; values from 0 to -180 |
| represent counterclockwise rotation. Values outside this range are added |
| to or subtracted from 360 to obtain a value within the range. |
| This property is ignored during calculation by any of Flex's 2D layouts. |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get rotationX():Number</code><br/><code> public function set rotationX(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="rotationY"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">rotationY</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>rotationY:Number</code>[override] <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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Indicates the y-axis rotation of the DisplayObject instance, in degrees, |
| from its original orientation relative to the 3D parent container. |
| Values from 0 to 180 represent clockwise rotation; values from 0 to -180 |
| represent counterclockwise rotation. Values outside this range are added |
| to or subtracted from 360 to obtain a value within the range. |
| This property is ignored during calculation by any of Flex's 2D layouts. |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get rotationY():Number</code><br/><code> public function set rotationY(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="top"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">top</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>top: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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| The vertical distance in pixels from the top edge of the component to the |
| anchor target's top edge. |
| <p>By default the anchor target is the container's content area. In layouts |
| with advanced constraints, the target can be a constraint row.</p> |
| <p>Setting the property to a number or to a numerical string like "10" |
| specifies use of the default anchor target.</p> |
| <p>To specify an anchor target, set the property value to a string in the format |
| "anchorTargetName:value". For example, "row1:10".</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get top():Object</code><br/><code> public function set top(value:Object):void</code><br/></div><a name="propertyDetail"></a><a name="transformX"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">transformX</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>transformX: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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Sets the x coordinate for the transform center of the component. |
| <p>When this object is the target of a Spark transform effect, |
| you can override this property by setting |
| the <code>AnimateTransform.autoCenterTransform</code> property. |
| If <code>autoCenterTransform</code> is <code>false</code>, the transform |
| center is determined by the <code>transformX</code>, |
| <code>transformY</code>, and <code>transformZ</code> properties |
| of the effect target. |
| If <code>autoCenterTransform</code> is <code>true</code>, |
| the effect occurs around the center of the target, |
| <code>(width/2, height/2)</code>.</p> |
| <p>Setting this property on the Spark effect class |
| overrides the setting on the target object.</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get transformX():Number</code><br/><code> public function set transformX(value:Number):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../spark/effects/AnimateTransform.html#autoCenterTransform" target="">spark.effects.AnimateTransform.autoCenterTransform</a><br/><a href="../../spark/effects/AnimateTransform.html#transformX" target="">spark.effects.AnimateTransform.transformX</a></div></div><a name="propertyDetail"></a><a name="transformY"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">transformY</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>transformY: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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Sets the y coordinate for the transform center of the component. |
| <p>When this object is the target of a Spark transform effect, |
| you can override this property by setting |
| the <code>AnimateTransform.autoCenterTransform</code> property. |
| If <code>autoCenterTransform</code> is <code>false</code>, the transform |
| center is determined by the <code>transformY</code>, |
| <code>transformY</code>, and <code>transformZ</code> properties |
| of the effect target. |
| If <code>autoCenterTransform</code> is <code>true</code>, |
| the effect occurs around the center of the target, |
| <code>(width/2, height/2)</code>.</p> |
| <p>Setting this property on the Spark effect class |
| overrides the setting on the target object.</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get transformY():Number</code><br/><code> public function set transformY(value:Number):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../spark/effects/AnimateTransform.html#autoCenterTransform" target="">spark.effects.AnimateTransform.autoCenterTransform</a><br/><a href="../../spark/effects/AnimateTransform.html#transformY" target="">spark.effects.AnimateTransform.transformY</a></div></div><a name="propertyDetail"></a><a name="transformZ"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">transformZ</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>transformZ: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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Sets the z coordinate for the transform center of the component. |
| <p>When this object is the target of a Spark transform effect, |
| you can override this property by setting |
| the <code>AnimateTransform.autoCenterTransform</code> property. |
| If <code>autoCenterTransform</code> is <code>false</code>, the transform |
| center is determined by the <code>transformZ</code>, |
| <code>transformY</code>, and <code>transformZ</code> properties |
| of the effect target. |
| If <code>autoCenterTransform</code> is <code>true</code>, |
| the effect occurs around the center of the target, |
| <code>(width/2, height/2)</code>.</p> |
| <p>Setting this property on the Spark effect class |
| overrides the setting on the target object.</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get transformZ():Number</code><br/><code> public function set transformZ(value:Number):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../spark/effects/AnimateTransform.html#autoCenterTransform" target="">spark.effects.AnimateTransform.autoCenterTransform</a><br/><a href="../../spark/effects/AnimateTransform.html#transformZ" target="">spark.effects.AnimateTransform.transformZ</a></div></div><a name="propertyDetail"></a><a name="verticalCenter"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">verticalCenter</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>verticalCenter: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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| The vertical distance in pixels from the center of the component to the |
| center of the anchor target's content area. |
| <p>The default anchor target is the container itself.</p> |
| <p>In layouts with advanced constraints, the anchor target can be a constraint row. |
| Then the content area is the space between the preceding row |
| (or container side) and the target row.</p> |
| <p>Setting the property to a number or to a numerical string like "10" |
| specifies use of the default anchor target.</p> |
| <p>To specify an anchor target, set the property value to a string in the format |
| "constraintColumnId:value". For example, "row1:10".</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get verticalCenter():Object</code><br/><code> public function set verticalCenter(value:Object):void</code><br/></div><a name="propertyDetail"></a><a name="viewHeight"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">viewHeight</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>viewHeight:Number</code> [write-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Defines the vertical space that the graphic uses in the layout. When you set this value, the content is not scaled. |
| Whereas, if you specify the value of the <code>height</code> property, the content is scaled. |
| |
| <p>There are two cases where this can be useful: |
| 1) Specify a <code>viewHeight</code> larger than the natural size of the content. You might do this so that the graphic takes |
| up more space than its visual size. |
| 2) Specify a <code>viewHeight</code> that is smaller than the natural size of the content. You might do this if your graphic has extra |
| chrome or a border that extends past the edges of the graphic. In this scenario, be sure to disable clipping in your layout.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> protected function set viewHeight(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="viewWidth"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">viewWidth</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>viewWidth:Number</code> [write-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Defines the horizontal space that the graphic uses in the layout. When you set this value, the content is not scaled. |
| Whereas, if you specify the value of the <code>width</code> property, the content is scaled. |
| |
| <p>There are two cases where this can be useful: |
| 1) Specify a <code>viewWidth</code> larger than the natural size of the content. You might do this so that the graphic takes |
| up more space than its visual size. |
| 2) Specify a <code>viewWidth</code> that is smaller than the natural size of the content. You might do this if your graphic has extra |
| chrome or a border that extends past the edges of the graphic. In this scenario, be sure to disable clipping in your layout.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> protected function set viewWidth(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="visible"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">visible</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>visible:Boolean</code>[override] <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 4.5</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 10, AIR 2.5</td></tr></table><p></p><p></p><p> |
| |
| Controls the visibility of this visual element. |
| If <code>true</code>, the object is visible. |
| |
| <p>If an object is not visible, but the <code>includeInLayout</code> |
| property is set to <code>true</code>, then the object |
| takes up space in the container, but is invisible.</p> |
| |
| <p>If <code>visible</code> is set to <code>true</code>, the object may not |
| necessarily be visible due to its size and whether container clipping |
| is enabled.</p> |
| |
| <p>Setting <code>visible</code> to <code>false</code>, |
| prevents the component from getting focus.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get visible():Boolean</code><br/><code> public function set visible(value:Boolean):void</code><br/></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="SpriteVisualElement()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">SpriteVisualElement</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function SpriteVisualElement()</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 4</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 10, AIR 1.5</td></tr></table><p></p><p> |
| Constructor. |
| </p></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="getBoundsXAtSize()"></a><a name="getBoundsXAtSize(Number,Number,Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getBoundsXAtSize</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Returns the x coordinate of the element's bounds at the specified element size. |
| |
| <p>This method is typically used by layouts during a call to the |
| <code>measure()</code> method to predict what |
| the element position will be, if the element is resized to particular dimensions.</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">width</span>:Number</code> — The element's bounds width, or NaN to use the preferred width. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">height</span>:Number</code> — The element's bounds height, or NaN to use the preferred height. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">postLayoutTransform</span>:Boolean</code> (default = <code>true</code>)<code></code> — When <code>postLayoutTransform</code> is true, the method returns |
| x coordinate of the element's bounding box top-left corner. |
| The bounding box is in element's parent coordinate space and is calculated |
| from the specified bounds size, layout position and layout transform matrix. |
| </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>Number</code> — The x coordinate of the element's bounds at the specified element size. |
| </td></tr></table></div><a name="getBoundsYAtSize()"></a><a name="getBoundsYAtSize(Number,Number,Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getBoundsYAtSize</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Returns the y coordinate of the element's bounds at the specified element size. |
| |
| This method is typically used by layouts during a call to |
| the <code>measure()</code> to predict what |
| the element position will be, if the element is resized to particular dimensions. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">width</span>:Number</code> — The element's bounds width, or NaN to use the preferred width. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">height</span>:Number</code> — The element's bounds height, or NaN to use the preferred height. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">postLayoutTransform</span>:Boolean</code> (default = <code>true</code>)<code></code> — When <code>postLayoutTransform</code> is true, the method returns |
| the y coordinate of the element's bounding box top-left corner. |
| The bounding box is in element's parent coordinate space and is calculated |
| from the specified bounds size, layout position and layout transform matrix. |
| |
| </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>Number</code> — The y coordinate of the element's bounds at the specified element size. |
| </td></tr></table></div><a name="getLayoutBoundsHeight()"></a><a name="getLayoutBoundsHeight(Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getLayoutBoundsHeight</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getLayoutBoundsHeight(postLayoutTransform:Boolean = true):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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Returns the element's layout height. This is the size that the element uses |
| to draw on screen. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">postLayoutTransform</span>:Boolean</code> (default = <code>true</code>)<code></code> — When <code>postLayoutTransform</code> is true, the method returns |
| the element's bounding box width. The bounding box is in the element's parent |
| coordinate space and is calculated from the element's layout size and |
| layout transform matrix. |
| |
| </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>Number</code> — The element's layout height. |
| </td></tr></table></div><a name="getLayoutBoundsWidth()"></a><a name="getLayoutBoundsWidth(Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getLayoutBoundsWidth</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getLayoutBoundsWidth(postLayoutTransform:Boolean = true):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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Returns the element's layout width. This is the size that the element uses |
| to draw on screen. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">postLayoutTransform</span>:Boolean</code> (default = <code>true</code>)<code></code> — When <code>postLayoutTransform</code> is true, the method returns |
| the element's bounding box width. The bounding box is in element's parent |
| coordinate space and is calculated from the element's layout size and |
| layout transform matrix. |
| |
| </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>Number</code> — The element's layout width. |
| </td></tr></table></div><a name="getLayoutBoundsX()"></a><a name="getLayoutBoundsX(Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getLayoutBoundsX</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getLayoutBoundsX(postLayoutTransform:Boolean = true):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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Returns the x coordinate that the element uses to draw on screen. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">postLayoutTransform</span>:Boolean</code> (default = <code>true</code>)<code></code> — When <code>postLayoutTransform</code> is true, the method returns |
| x coordinate of the element's bounding box top-left corner. |
| The bounding box is in the element's parent coordinate space and is calculated |
| from the element's layout size, layout position and layout transform matrix. |
| |
| </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>Number</code> — The x coordinate that the element uses to draw on screen. |
| |
| </td></tr></table></div><a name="getLayoutBoundsY()"></a><a name="getLayoutBoundsY(Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getLayoutBoundsY</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getLayoutBoundsY(postLayoutTransform:Boolean = true):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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Returns the y coordinate that the element uses to draw on screen. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">postLayoutTransform</span>:Boolean</code> (default = <code>true</code>)<code></code> — When <code>postLayoutTransform</code> is true, the method returns |
| y coordinate of the element's bounding box top-left corner. |
| The bounding box is in the element's parent coordinate space and is calculated |
| from the element's layout size, layout position, and layout transform matrix. |
| |
| </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>Number</code> — The y coordinate that the element uses to draw on screen. |
| |
| </td></tr></table></div><a name="getLayoutMatrix()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getLayoutMatrix</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getLayoutMatrix():Matrix</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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Returns the transform matrix that is used to calculate the component's |
| layout relative to its siblings. |
| <p>This matrix is typically defined by the |
| component's 2D properties such as <code>x</code>, <code>y</code>, |
| <code>rotation</code>, <code>scaleX</code>, <code>scaleY</code>, |
| <code>transformX</code>, and <code>transformY</code>. |
| Some components may have additional transform properties that |
| are applied on top of the layout matrix to determine the final, |
| computed matrix. For example <code>UIComponent</code> |
| defines the <code>offsets</code> property.</p> |
| |
| </p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Matrix</code> — The layout transform Matrix for this element. |
| Do not directly modify the return value; call the <code>setLayoutMatrix()</code> method instead. |
| |
| </td></tr></table></div><a name="getLayoutMatrix3D()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getLayoutMatrix3D</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getLayoutMatrix3D():Matrix3D</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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Returns the layout transform Matrix3D for this element. |
| |
| <p>This matrix is typically defined by the |
| component's transform properties such as <code>x</code>, <code>y</code>, |
| <code>z</code>, <code>rotationX</code>, <code>rotationY</code>, |
| <code>rotationZ</code>, <code>scaleX</code>, <code>scaleY</code>, |
| <code>scaleZ</code>, <code>transformX</code>, and <code>transformY</code>. |
| Some components may have additional transform properties that |
| are applied on top of the layout matrix to determine the final, |
| computed matrix. For example <code>UIComponent</code> |
| defines the <code>offsets</code> property.</p> |
| |
| </p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Matrix3D</code> — The layout transform Matrix3D for this element. |
| Do not directly modify the return value but call the <code>setLayoutMatrix()</code> method instead. |
| |
| </td></tr></table></div><a name="getMaxBoundsHeight()"></a><a name="getMaxBoundsHeight(Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getMaxBoundsHeight</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getMaxBoundsHeight(postLayoutTransform:Boolean = true):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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Returns the element's maximum height. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">postLayoutTransform</span>:Boolean</code> (default = <code>true</code>)<code></code> — When <code>postLayoutTransform</code> is true, the method returns |
| the element's bounding box height. The bounding box is in the element's parent |
| coordinate space and is calculated from the element's maximum size and |
| layout transform matrix. |
| </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>Number</code> — The element's maximum height. |
| </td></tr></table></div><a name="getMaxBoundsWidth()"></a><a name="getMaxBoundsWidth(Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getMaxBoundsWidth</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getMaxBoundsWidth(postLayoutTransform:Boolean = true):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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Returns the element's maximum width. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">postLayoutTransform</span>:Boolean</code> (default = <code>true</code>)<code></code> — When <code>postLayoutTransform</code> is true, the method returns |
| the element's bounding box width. The bounding box is in the element's parent |
| coordinate space and is calculated from the element's maximum size and |
| layout transform matrix. |
| </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>Number</code> — The element's maximum width. |
| </td></tr></table></div><a name="getMinBoundsHeight()"></a><a name="getMinBoundsHeight(Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getMinBoundsHeight</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getMinBoundsHeight(postLayoutTransform:Boolean = true):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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Returns the element's minimum height. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">postLayoutTransform</span>:Boolean</code> (default = <code>true</code>)<code></code> — When <code>postLayoutTransform</code> is <code>true</code>, |
| the method returns the element's bounding box height. |
| The bounding box is in the element's parent |
| coordinate space and is calculated from the element's minimum size and |
| layout transform matrix. |
| </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>Number</code> — The element's maximum height. |
| </td></tr></table></div><a name="getMinBoundsWidth()"></a><a name="getMinBoundsWidth(Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getMinBoundsWidth</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getMinBoundsWidth(postLayoutTransform:Boolean = true):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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Returns the element's minimum width. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">postLayoutTransform</span>:Boolean</code> (default = <code>true</code>)<code></code> — When <code>postLayoutTransform</code> is <code>true</code>, |
| the method returns the element's bounding box width. |
| The bounding box is in the element's parent |
| coordinate space and is calculated from the element's minimum size and |
| layout transform matrix. |
| </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>Number</code> — The element's maximum width. |
| </td></tr></table></div><a name="getPreferredBoundsHeight()"></a><a name="getPreferredBoundsHeight(Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getPreferredBoundsHeight</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getPreferredBoundsHeight(postLayoutTransform:Boolean = true):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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Returns the element's preferred height. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">postLayoutTransform</span>:Boolean</code> (default = <code>true</code>)<code></code> — When <code>postLayoutTransform</code> is <code>true</code>, |
| the method returns the element's bounding box height. |
| The bounding box is in the element's parent |
| coordinate space and is calculated from the element's preferred size and |
| layout transform matrix. |
| </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>Number</code> — Returns the element's preferred height. Preferred height is |
| usually based on the default element size and any explicit overrides. |
| For UIComponent this is the same value as returned by |
| the <code>getExplicitOrMeasuredHeight()</code> method. |
| </td></tr></table></div><a name="getPreferredBoundsWidth()"></a><a name="getPreferredBoundsWidth(Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getPreferredBoundsWidth</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getPreferredBoundsWidth(postLayoutTransform:Boolean = true):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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Returns the element's preferred width. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">postLayoutTransform</span>:Boolean</code> (default = <code>true</code>)<code></code> — When <code>postLayoutTransform</code> is <code>true</code>, |
| the method returns the element's bounding box width. |
| The bounding box is in the element's parent |
| coordinate space and is calculated from the element's preferred size and |
| layout transform matrix. |
| </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>Number</code> — Returns the element's preferred width. Preferred width is |
| usually based on the default element size and any explicit overrides. |
| For UIComponent this is the same value as returned by |
| the <code>getExplicitOrMeasuredWidth()</code> method. |
| |
| </td></tr></table></div><a name="initialized()"></a><a name="initialized(Object,String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">initialized</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function initialized(document:Object, id:String):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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Called automatically by the MXML compiler when the SpriteVisualElement |
| is created using an MXML tag. |
| If you create the SpriteVisualElement through ActionScript you |
| must set the <code>id</code> property manually. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">document</span>:Object</code> — The MXML document containing this SpriteVisualElement (not used). |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">id</span>:String</code> — The MXML id for this SpriteVisualElement. |
| |
| </td></tr></table></p></div><a name="invalidateLayoutDirection()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">invalidateLayoutDirection</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function invalidateLayoutDirection():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 4.5</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 10, AIR 2.5</td></tr></table><p></p><p></p><p> |
| |
| An element must call this method when its layoutDirection changes or |
| when its parent's layoutDirection changes. |
| |
| If they differ, this method is responsible for mirroring the element’s contents |
| and for updating the element’s post-layout transform so that descendants inherit |
| a mirrored coordinate system. IVisualElements typically implement |
| mirroring by using postLayoutTransformOffsets to scale the X axis by -1 and |
| to translate the x coordinate of the origin by the element's width. |
| |
| The net effect of this "mirror" transform is to reverse the direction |
| in which the X axis increases without changing the element's location |
| relative to its parent's origin. |
| |
| </p></div><a name="invalidateParentSizeAndDisplayList()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">invalidateParentSizeAndDisplayList</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function invalidateParentSizeAndDisplayList():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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Invalidates parent size and display list if |
| this object affects its layout (includeInLayout is true). |
| </p></div><a name="setLayoutBoundsPosition()"></a><a name="setLayoutBoundsPosition(Number,Number,Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">setLayoutBoundsPosition</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function setLayoutBoundsPosition(newBoundsX:Number, newBoundsY:Number, postLayoutTransform:Boolean = true):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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Sets the coordinates that the element uses to draw on screen. |
| <p>Note that calls to the <code>setLayoutBoundSize()</code> method can affect the layout position, so |
| call <code>setLayoutBoundPosition()</code> after calling <code>setLayoutBoundSize()</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">newBoundsX</span>:Number</code> — The x-coordinate of the top-left corner of the bounding box. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">newBoundsY</span>:Number</code> — The y-coordinate of the top-left corner of the bounding box. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">postLayoutTransform</span>:Boolean</code> (default = <code>true</code>)<code></code> — When <code>postLayoutTransform</code> is <code>true</code>, |
| the element is positioned in such a way that the top-left corner of its bounding box is (x, y). |
| The bounding box is in the element's parent coordinate space and is calculated |
| from the element's layout size, layout position and layout transform matrix. |
| </td></tr></table></p></div><a name="setLayoutBoundsSize()"></a><a name="setLayoutBoundsSize(Number,Number,Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">setLayoutBoundsSize</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Sets the layout size of the element. |
| This is the size that the element uses to draw on screen. |
| |
| <p>If the <code>width</code> and/or <code>height</code> parameters are left unspecified (NaN), |
| Flex sets the element's layout size to its preferred width and/or preferred height.</p> |
| |
| <p>Note that calls to the <code>setLayoutBoundSize()</code> method can affect the layout position, so |
| call <code>setLayoutBoundPosition()</code> after calling <code>setLayoutBoundSize()</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">width</span>:Number</code> — The element's layout width. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">height</span>:Number</code> — The element's layout height. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">postLayoutTransform</span>:Boolean</code> (default = <code>true</code>)<code></code> — When <code>postLayoutTransform</code> is true, the specified sizes |
| are those of the element's bounding box. |
| The bounding box is in the element's parent coordinate space and is calculated |
| from the element's layout size, layout position, and layout transform matrix. |
| |
| </td></tr></table></p></div><a name="setLayoutMatrix()"></a><a name="setLayoutMatrix(flash.geom.Matrix,Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">setLayoutMatrix</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Sets the transform Matrix that is used to calculate the component's layout |
| size and position relative to its siblings. |
| <p>The matrix is typically defined by the |
| component's 2D properties such as <code>x</code>, <code>y</code>, |
| <code>rotation</code>, <code>scaleX</code>, <code>scaleY</code>, |
| <code>transformX</code>, and <code>transformY</code>. |
| Some components may have additional transform properties that |
| are applied on top of the layout matrix to determine the final, |
| computed matrix. For example <code>UIComponent</code> |
| defines the <code>offsets</code>.</p> |
| |
| <p>Note that layout Matrix is factored in the <code>getPreferredSize()</code>, |
| <code>getMinSize()</code>, <code>getMaxSize()</code>, <code>getLayoutSize()</code> |
| methods when computed in parent coordinates |
| as well as in <code>getLayoutPosition()</code> in both parent and child coordinates. |
| Layouts that calculate the transform matrix explicitly typically call |
| this method and work with sizes in child coordinates. |
| Layouts calling this method pass <code>false</code> |
| to the <code>invalidateLayout()</code> method so that a subsequent layout pass is not |
| triggered.</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">value</span>:Matrix</code> — The matrix. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">invalidateLayout</span>:Boolean</code> — <code>true</code> to cause the parent container |
| to re-layout its children. You typically pass <code>true</code> |
| to the <code>invalidateLayout()</code> method. |
| |
| </td></tr></table></p></div><a name="setLayoutMatrix3D()"></a><a name="setLayoutMatrix3D(flash.geom.Matrix3D,Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">setLayoutMatrix3D</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Sets the transform Matrix3D that is used to calculate the component's layout |
| size and position relative to its siblings. |
| <p>This matrix is typically defined by the |
| component's transform properties such as <code>x</code>, <code>y</code>, |
| <code>z</code>, <code>rotationX</code>, <code>rotationY</code>, |
| <code>rotationZ</code>, <code>scaleX</code>, <code>scaleY</code>, |
| <code>scaleZ</code>, <code>transformX</code>, and <code>transformY</code>. |
| Some components may have additional transform properties that |
| are applied on top of the layout matrix to determine the final, |
| computed matrix. For example <code>UIComponent</code> |
| defines the <code>offsets</code> property.</p> |
| |
| <p>Note that layout Matrix3D is factored in the <code>getPreferredSize()</code>, |
| <code>getMinSize()</code>, <code>getMaxSize()</code>, <code>getLayoutSize()</code> |
| when computed in parent coordinates |
| as well as in <code>getLayoutPosition()</code> in both parent and child coordinates. |
| Layouts that calculate the transform matrix explicitly typically call |
| this method and work with sizes in child coordinates. |
| Layouts calling this method pass <code>false</code> |
| to the <code>invalidateLayout()</code> method so that a subsequent layout pass is not |
| triggered.</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">value</span>:Matrix3D</code> — The matrix. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">invalidateLayout</span>:Boolean</code> — <code>true</code> to cause the parent container |
| to re-layout its children. You typically pass <code>true</code> |
| to the <code>invalidateLayout()</code> method. |
| |
| </td></tr></table></p></div><a name="transformAround()"></a><a name="transformAround(flash.geom.Vector3D,flash.geom.Vector3D,flash.geom.Vector3D,flash.geom.Vector3D,flash.geom.Vector3D,flash.geom.Vector3D,flash.geom.Vector3D,Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">transformAround</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| A utility method to update the rotation, scale, and translation of the |
| transform while keeping a particular point, specified in the component's |
| own coordinate space, fixed in the parent's coordinate space. |
| This function will assign the rotation, scale, and translation values |
| provided, then update the x/y/z properties as necessary to keep |
| the transform center fixed. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">transformCenter</span>:Vector3D</code> — The point, in the component's own coordinates, |
| to keep fixed relative to its parent. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">scale</span>:Vector3D</code> (default = <code>null</code>)<code></code> — The new values for the scale of the transform. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">rotation</span>:Vector3D</code> (default = <code>null</code>)<code></code> — the new values for the rotation of the transform |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">translation</span>:Vector3D</code> (default = <code>null</code>)<code></code> — The new values for the translation of the transform. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">postLayoutScale</span>:Vector3D</code> (default = <code>null</code>)<code></code> — The new values for the post-layout scale |
| of the transform. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">postLayoutRotation</span>:Vector3D</code> (default = <code>null</code>)<code></code> — The new values for the post-layout rotation |
| of the transform. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">postLayoutTranslation</span>:Vector3D</code> (default = <code>null</code>)<code></code> — The new values for the post-layout translation |
| of the transform. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">invalidateLayout</span>:Boolean</code> (default = <code>true</code>)<code></code> — If <code>true</code>, the parent container size and display are |
| invalidated. Layouts calling this method pass <code>false</code> |
| so that a subsequent layout pass is not triggered. |
| |
| </td></tr></table></p></div><a name="transformHeightForLayout()"></a><a name="transformHeightForLayout(Number,Number,Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">transformHeightForLayout</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function transformHeightForLayout(width:Number, height:Number, postLayoutTransform:Boolean = true):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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Transform the element's size. |
| <p>This method calculates the bounding box of the graphic element as if the element’s width/height properties were set to the passed in values. |
| The method returns the height of the bounding box.</p> |
| |
| <p>In general, this method is not for use by developers. Instead, you should implement or override the methods defined by the ILayoutElement interface.</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">width</span>:Number</code> — The target pre-transform width. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">height</span>:Number</code> — The target pre-transform height. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">postLayoutTransform</span>:Boolean</code> (default = <code>true</code>)<code></code> — When <code>true</code>, the returned bounding box is around the transformed element in its parent space (the element's transform is applied first). |
| |
| </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>Number</code> — Returns the transformed height. Transformation is this element's |
| layout transformation matrix. |
| </td></tr></table></div><a name="transformPointToParent()"></a><a name="transformPointToParent(flash.geom.Vector3D,flash.geom.Vector3D,flash.geom.Vector3D)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">transformPointToParent</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| A utility method to transform a point specified in the local |
| coordinates of this object to its location in the object's parent's |
| coordinates. The pre-layout and post-layout result will be set on |
| the <code>position</code> and <code>postLayoutPosition</code> |
| parameters, if they are non-null. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">localPosition</span>:Vector3D</code> — The point to be transformed, specified in the |
| local coordinates of the object. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">position</span>:Vector3D</code> — A Vector3D point that will hold the pre-layout |
| result. If null, the parameter is ignored. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">postLayoutPosition</span>:Vector3D</code> — A Vector3D point that will hold the post-layout |
| result. If null, the parameter is ignored. |
| </td></tr></table></p></div><a name="transformWidthForLayout()"></a><a name="transformWidthForLayout(Number,Number,Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">transformWidthForLayout</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function transformWidthForLayout(width:Number, height:Number, postLayoutTransform:Boolean = true):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 4</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 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Transform the element's size. |
| <p>This method calculates the bounding box of the graphic element as if the element’s width/height properties were set to the passed in values. |
| The method returns the width of the bounding box.</p> |
| |
| <p>In general, this method is not for use by developers. Instead, you should implement or override the methods defined by the ILayoutElement interface.</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">width</span>:Number</code> — The target pre-transform width. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">height</span>:Number</code> — The target pre-transform height. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">postLayoutTransform</span>:Boolean</code> (default = <code>true</code>)<code></code> — When <code>true</code>, the returned bounding box is around the transformed element in its parent space (the element's transform is applied first). |
| |
| </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>Number</code> — Returns the transformed width. Transformation is this element's |
| layout transformation matrix. |
| </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 --> |
