| <!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="ViewMenuLayout,spark.layouts.ViewMenuLayout,BASELINE,BOTTOM,CENTER,COLUMNS,CONTENT_JUSTIFY,CONTENT_JUSTIFY,JUSTIFY,JUSTIFY,JUSTIFY_USING_GAP,JUSTIFY_USING_GAP,JUSTIFY_USING_HEIGHT,JUSTIFY_USING_WIDTH,LEFT,LEFT,MIDDLE,RIGHT,ROWS,TOP,TOP,alphaOutEnd,alphaOutStart,angle,buttonBar,buttonRotation,columnAlign,columnCount,columnCount,columnWidth,columnWidth,constraintColumns,constraintRows,depthColor,depthColor,depthColor,depthColorAlpha,depthColorAlpha,depthColorAlpha,direction,elementHorizontalAlign,elementHorizontalAlign,elementVerticalAlign,elementVerticalAlign,firstIndexInView,firstIndexInView,gap,gap,horizontalAlign,horizontalAlign,horizontalAlign,horizontalAlign,horizontalAlign,horizontalAlign,horizontalAlign,horizontalAlignOffset,horizontalAlignOffset,horizontalAlignOffsetPercent,horizontalAlignOffsetPercent,horizontalDisplacement,horizontalDisplacement,horizontalGap,horizontalGap,horizontalOffset,lastIndexInView,lastIndexInView,layoutAllButtonBarBounds,maximumZ,maximumZ,minElementSize,numUnselectedElements,numUnselectedElements,numVisibleElements,orientation,padding,padding,padding,paddingBottom,paddingBottom,paddingBottom,paddingLeft,paddingLeft,paddingLeft,paddingRight,paddingRight,paddingRight,paddingTop,paddingTop,paddingTop,radiusX,radiusY,radiusZ,requestedColumnCount,requestedColumnCount,requestedMaxColumnCount,requestedMaxColumnCount,requestedMaxRowCount,requestedMinColumnCount,requestedMinRowCount,requestedRowCount,requestedRowCount,rotateX,rotateY,rotationAnchor,rotationX,rotationY,rowAlign,rowCount,rowCount,rowHeight,rowHeight,selectedHorizontalDisplacement,selectedVerticalDisplacement,target,useScrollRect,variableColumnWidth,variableRowHeight,verticalAlign,verticalAlign,verticalAlign,verticalAlign,verticalAlign,verticalAlign,verticalAlign,verticalAlignOffset,verticalAlignOffset,verticalAlignOffsetPercent,verticalAlignOffsetPercent,verticalDisplacement,verticalDisplacement,verticalGap,verticalGap,verticalOffset"><title>spark.layouts.ViewMenuLayout</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 = 'ViewMenuLayout - 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/layouts/ViewMenuLayout.html&spark/layouts/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">ViewMenuLayout</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("ViewMenuLayout"); 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.layouts</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class ViewMenuLayout</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">ViewMenuLayout <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> <a href="../../spark/layouts/supportClasses/LayoutBase.html">LayoutBase</a> <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> <a href="../../mx/utils/OnDemandEventDispatcher.html">OnDemandEventDispatcher</a> <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> Object</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.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>AIR 2.5</td></tr></table><p></p><p></p><p></p><p></p> |
| The ViewMenuLayout class defines the layout of the ViewMenu container. |
| The menu can have multiple rows depending on the number of menu items. |
| <p>The <code>requestedMaxColumnCount</code> property |
| defines the maximum number of menu items in a row. |
| By default, the property is set to three.</p> |
| <p>The ViewMenuLayout class define the layout as follows: </p> |
| |
| <ul> |
| <li>If you define three or fewer menu items, |
| where the <code>requestedMaxColumnCount</code> property contains |
| the default value of three, the menu items are displayed in a single row. |
| Each menu item has the same size. |
| <p>If you define four or more menu items, meaning more menu items |
| than specified by the <code>requestedMaxColumnCount</code> property, |
| the ViewMenu container creates multiple rows.</p> |
| </li> |
| <li>If the number of menu items is evenly divisible by |
| the <code>requestedMaxColumnCount</code> property, |
| each row contains the same number of menu items. |
| Each menu item is the same size. |
| <p>For example the <code>requestedMaxColumnCount</code> property |
| is set to the default value of three and you define six menu items. |
| The menu displays two rows, each containing three menu items. </p> |
| </li> |
| <li>If the number of menu items is not evenly divisible by |
| the <code>requestedMaxColumnCount</code> property, |
| rows can contain a different number of menu items. |
| The size of the menu items depends on the number of menu items |
| in the row. |
| <p>For example the <code>requestedMaxColumnCount</code> property |
| is set to the default value of three and you define eight menu items. |
| The menu displays three rows. |
| The first row contains two menu items. |
| The second and third rows each contains three items. </p> |
| </li> |
| </ul> |
| |
| <p>You can create your own custom layout for the menu by creating |
| your own layout class. |
| By default, the spark.skins.mobile.ViewMenuSkin class defines |
| the skin for the ViewMenu container. |
| To apply a customized ViewMenuLayout class to the ViewMenu container, |
| define a new skin class for the ViewMenu container. </p> |
| <p>The ViewMenuSkin class includes a definition for a Group |
| container named <code>contentGroup</code>, as shown below:</p> |
| <pre> |
| <s:Group id="contentGroup" left="0" right="0" top="3" bottom="2" |
| minWidth="0" minHeight="0"> |
| <s:layout> |
| <s:ViewMenuLayout horizontalGap="2" verticalGap="2" id="contentGroupLayout" |
| requestedMaxColumnCount="3" requestedMaxColumnCount.landscapeGroup="6"/> |
| </s:layout> |
| </s:Group></pre> |
| |
| <p>To apply your customized ViewMenuLayout class, your skin class |
| should define a container named <code>contentGroup</code>. |
| That container uses the <code>layout</code> property |
| to specify your customized layout class. </p> |
| |
| <p></p><a name="mxmlSyntaxSummary"></a><span class="classHeaderTableLabel">MXML Syntax</span><span id="showMxmlLink" style="display:none"><a href="#mxmlSyntaxSummary" onclick="toggleMXMLOnly();"><img src="../../images/collapsed.gif" title="collapsed" alt="collapsed" class="collapsedImage">Show MXML Syntax</a><br/></span><span id="hideMxmlLink"><a href="#mxmlSyntaxSummary" onclick="toggleMXMLOnly();"><img src="../../images/expanded.gif" title="expanded" alt="expanded" class="expandedImage">Hide MXML Syntax</a></span><div id="mxmlSyntax" class="mxmlSyntax"> |
| <p>The <code><s:ViewMenuLayout></code> tag inherits all of the tag |
| attributes of its superclass and adds the following tag attributes:</p> |
| <pre> |
| <s:ViewMenuLayout |
| <strong>Properties</strong> |
| horizontalGap="2" |
| requestedMaxColumnCount="3" |
| verticalGap="2" |
| /> |
| </pre> |
| </div><script language="javascript" type="text/javascript"><!-- |
| setMXMLOnly(); |
| --></script><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso"><a href="../../spark/components/ViewMenu.html" target="">spark.components.ViewMenu</a><br/><a href="../../spark/components/ViewMenuItem.html" target="">spark.components.ViewMenuItem</a><br/><a href="../../spark/skins/mobile/ViewMenuSkin.html" target="">spark.skins.mobile.ViewMenuSkin</a></div><br/><hr></div><a name="propertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Properties</div><div class="showHideLinks"><div id="hideInheritedProperty" class="hideInheritedProperty"><a class="showHideLink" href="#propertySummary" onclick="javascript:setInheritedVisible(false,'Property');"><img class="showHideLinkImage" src="../../images/expanded.gif"> Hide Inherited Public Properties</a></div><div id="showInheritedProperty" class="showInheritedProperty"><a class="showHideLink" href="#propertySummary" onclick="javascript:setInheritedVisible(true,'Property');"><img class="showHideLinkImage" src="../../images/collapsed.gif"> Show Inherited Public Properties</a></div></div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProperty"><tr><th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html#clipAndEnableScrolling" class="signatureLink">clipAndEnableScrolling</a> : Boolean<div class="summaryTableDescription"> |
| If true, specifies to clip the children to the boundaries of the viewport.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html">LayoutBase</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html#dropIndicator" class="signatureLink">dropIndicator</a> : DisplayObject<div class="summaryTableDescription"> |
| The DisplayObject that this layout uses for |
| the drop indicator during a drag-and-drop operation.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html">LayoutBase</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><img src="../../images/AirIcon12x12.gif" width="12" height="12" hspace="0" vspace="0" alt="AIR-only" title="Only available in the AIR runtime"> <a href="#horizontalGap" class="signatureLink">horizontalGap</a> : Number<div class="summaryTableDescription"> |
| The horizontal space between columns, in pixels.</div></td><td class="summaryTableOwnerCol">ViewMenuLayout</td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html#horizontalScrollPosition" class="signatureLink">horizontalScrollPosition</a> : Number<div class="summaryTableDescription"> |
| The x coordinate of the origin of the viewport in the component's coordinate system, |
| where the default value is (0,0) corresponding to the upper-left corner of the component.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html">LayoutBase</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><img src="../../images/AirIcon12x12.gif" width="12" height="12" hspace="0" vspace="0" alt="AIR-only" title="Only available in the AIR runtime"> <a href="#requestedMaxColumnCount" class="signatureLink">requestedMaxColumnCount</a> : int<div class="summaryTableDescription"> |
| The maximum number of columns to display in a row.</div></td><td class="summaryTableOwnerCol">ViewMenuLayout</td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html#target" class="signatureLink">target</a> : <a href="../../spark/components/supportClasses/GroupBase.html">GroupBase</a><div class="summaryTableDescription"> |
| The GroupBase container whose elements are measured, sized and positioned |
| by this layout.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html">LayoutBase</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html#typicalLayoutElement" class="signatureLink">typicalLayoutElement</a> : <a href="../../mx/core/ILayoutElement.html">ILayoutElement</a><div class="summaryTableDescription"> |
| Used by layouts when fixed row/column sizes are requested but |
| a specific size isn't specified.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html">LayoutBase</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html#useVirtualLayout" class="signatureLink">useVirtualLayout</a> : Boolean<div class="summaryTableDescription"> |
| A container can hold any number of children.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html">LayoutBase</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><img src="../../images/AirIcon12x12.gif" width="12" height="12" hspace="0" vspace="0" alt="AIR-only" title="Only available in the AIR runtime"> <a href="#verticalGap" class="signatureLink">verticalGap</a> : Number<div class="summaryTableDescription"> |
| The vertical space between rows, in pixels.</div></td><td class="summaryTableOwnerCol">ViewMenuLayout</td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html#verticalScrollPosition" class="signatureLink">verticalScrollPosition</a> : Number<div class="summaryTableDescription"> |
| The y coordinate of the origin of the viewport in the component's coordinate system, |
| where the default value is (0,0) corresponding to the upper-left corner of the component.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html">LayoutBase</a></td></tr></table></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </div><div class="showHideLinks"><div id="hideInheritedMethod" class="hideInheritedMethod"><a class="showHideLink" href="#methodSummary" onclick="javascript:setInheritedVisible(false,'Method');"><img class="showHideLinkImage" src="../../images/expanded.gif"> Hide Inherited Public Methods</a></div><div id="showInheritedMethod" class="showInheritedMethod"><a class="showHideLink" href="#methodSummary" onclick="javascript:setInheritedVisible(true,'Method');"><img class="showHideLinkImage" src="../../images/collapsed.gif"> Show Inherited Public Methods</a></div></div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableMethod"><tr><th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><img src="../../images/AirIcon12x12.gif" width="12" height="12" hspace="0" vspace="0" alt="AIR-only" title="Only available in the AIR runtime"> <a href="#ViewMenuLayout()" class="signatureLink">ViewMenuLayout</a>()</div><div class="summaryTableDescription"> |
| Constructor.</div></td><td class="summaryTableOwnerCol">ViewMenuLayout</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/utils/OnDemandEventDispatcher.html#addEventListener()" class="signatureLink">addEventListener</a>(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void</div><div class="summaryTableDescription"> |
| </div></td><td class="summaryTableOwnerCol"><a href="../../mx/utils/OnDemandEventDispatcher.html">OnDemandEventDispatcher</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../spark/layouts/supportClasses/LayoutBase.html#calculateDropLocation()" class="signatureLink">calculateDropLocation</a>(dragEvent:<a href="../../mx/events/DragEvent.html">DragEvent</a>):<a href="../../spark/layouts/supportClasses/DropLocation.html">DropLocation</a></div><div class="summaryTableDescription"> |
| Calculates the drop location in the data provider of the drop target for |
| the specified dragEvent.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html">LayoutBase</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../spark/layouts/supportClasses/LayoutBase.html#clearVirtualLayoutCache()" class="signatureLink">clearVirtualLayoutCache</a>():void</div><div class="summaryTableDescription"> |
| When useVirtualLayout is true, |
| this method can be used by the layout target |
| to clear cached layout information when the target changes.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html">LayoutBase</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/utils/OnDemandEventDispatcher.html#dispatchEvent()" class="signatureLink">dispatchEvent</a>(event:Event):Boolean</div><div class="summaryTableDescription"> |
| </div></td><td class="summaryTableOwnerCol"><a href="../../mx/utils/OnDemandEventDispatcher.html">OnDemandEventDispatcher</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../spark/layouts/supportClasses/LayoutBase.html#elementAdded()" class="signatureLink">elementAdded</a>(index:int):void</div><div class="summaryTableDescription"> |
| Called by the target after a layout element |
| has been added and before the target's size and display list are |
| validated.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html">LayoutBase</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../spark/layouts/supportClasses/LayoutBase.html#elementRemoved()" class="signatureLink">elementRemoved</a>(index:int):void</div><div class="summaryTableDescription"> |
| This method must is called by the target after a layout element |
| has been removed and before the target's size and display list are |
| validated.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html">LayoutBase</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../spark/layouts/supportClasses/LayoutBase.html#getElementBounds()" class="signatureLink">getElementBounds</a>(index:int):Rectangle</div><div class="summaryTableDescription"> |
| Returns the specified element's layout bounds as a Rectangle or null |
| if the index is invalid, the corresponding element is null, |
| includeInLayout=false, |
| or if this layout's target property is null.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html">LayoutBase</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../spark/layouts/supportClasses/LayoutBase.html#getHorizontalScrollPositionDelta()" class="signatureLink">getHorizontalScrollPositionDelta</a>(navigationUnit:uint):Number</div><div class="summaryTableDescription"> |
| Returns the change to the horizontal scroll position to handle |
| different scrolling options.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html">LayoutBase</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../spark/layouts/supportClasses/LayoutBase.html#getNavigationDestinationIndex()" class="signatureLink">getNavigationDestinationIndex</a>(currentIndex:int, navigationUnit:uint, arrowKeysWrapFocus:Boolean):int</div><div class="summaryTableDescription"> |
| Delegation method that determines which item |
| to navigate to based on the current item in focus |
| and user input in terms of NavigationUnit.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html">LayoutBase</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../spark/layouts/supportClasses/LayoutBase.html#getScrollPositionDeltaToElement()" class="signatureLink">getScrollPositionDeltaToElement</a>(index:int):Point</div><div class="summaryTableDescription"> |
| Computes the verticalScrollPosition and |
| horizontalScrollPosition deltas needed to |
| scroll the element at the specified index into view.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html">LayoutBase</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../spark/layouts/supportClasses/LayoutBase.html#getVerticalScrollPositionDelta()" class="signatureLink">getVerticalScrollPositionDelta</a>(navigationUnit:uint):Number</div><div class="summaryTableDescription"> |
| Returns the change to the vertical scroll position to handle |
| different scrolling options.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html">LayoutBase</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/utils/OnDemandEventDispatcher.html#hasEventListener()" class="signatureLink">hasEventListener</a>(type:String):Boolean</div><div class="summaryTableDescription"> |
| </div></td><td class="summaryTableOwnerCol"><a href="../../mx/utils/OnDemandEventDispatcher.html">OnDemandEventDispatcher</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../spark/layouts/supportClasses/LayoutBase.html#hideDropIndicator()" class="signatureLink">hideDropIndicator</a>():void</div><div class="summaryTableDescription"> |
| Hides the previously shown drop indicator, |
| created by the showDropIndicator() method, |
| removes it from the display list and also stops the drag scrolling.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html">LayoutBase</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../spark/layouts/supportClasses/LayoutBase.html#measure()" class="signatureLink">measure</a>():void</div><div class="summaryTableDescription"> |
| Measures the target's default size based on its content, and optionally |
| measures the target's default minimum size.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html">LayoutBase</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/utils/OnDemandEventDispatcher.html#removeEventListener()" class="signatureLink">removeEventListener</a>(type:String, listener:Function, useCapture:Boolean = false):void</div><div class="summaryTableDescription"> |
| </div></td><td class="summaryTableOwnerCol"><a href="../../mx/utils/OnDemandEventDispatcher.html">OnDemandEventDispatcher</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../spark/layouts/supportClasses/LayoutBase.html#showDropIndicator()" class="signatureLink">showDropIndicator</a>(dropLocation:<a href="../../spark/layouts/supportClasses/DropLocation.html">DropLocation</a>):void</div><div class="summaryTableDescription"> |
| Sizes, positions and parents the drop indicator based on the specified |
| drop location.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html">LayoutBase</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../spark/layouts/supportClasses/LayoutBase.html#updateDisplayList()" class="signatureLink">updateDisplayList</a>(width:Number, height:Number):void</div><div class="summaryTableDescription"> |
| Sizes and positions the target's elements.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html">LayoutBase</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../spark/layouts/supportClasses/LayoutBase.html#updateScrollRect()" class="signatureLink">updateScrollRect</a>(w:Number, h:Number):void</div><div class="summaryTableDescription"> |
| Called by the target at the end of its updateDisplayList |
| to have the layout update its scrollRect.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html">LayoutBase</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/utils/OnDemandEventDispatcher.html#willTrigger()" class="signatureLink">willTrigger</a>(type:String):Boolean</div><div class="summaryTableDescription"> |
| </div></td><td class="summaryTableOwnerCol"><a href="../../mx/utils/OnDemandEventDispatcher.html">OnDemandEventDispatcher</a></td></tr></table></div><a name="methodSummary"></a><a name="protectedMethodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Protected Methods </div><div class="showHideLinks"><div id="hideInheritedProtectedMethod" class="hideInheritedProtectedMethod"><a class="showHideLink" href="#protectedMethodSummary" onclick="javascript:setInheritedVisible(false,'ProtectedMethod');"><img class="showHideLinkImage" src="../../images/expanded.gif"> Show Inherited Protected Methods</a></div><div id="showInheritedProtectedMethod" class="showInheritedProtectedMethod"><a class="showHideLink" href="#protectedMethodSummary" onclick="javascript:setInheritedVisible(true,'ProtectedMethod');"><img class="showHideLinkImage" src="../../images/collapsed.gif"> Show Inherited Protected Methods</a></div></div><table cellspacing="0" cellpadding="3" class="summaryTable hideInheritedProtectedMethod" id="summaryTableProtectedMethod"><tr><th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class="hideInheritedProtectedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../spark/layouts/supportClasses/LayoutBase.html#calculateDragScrollDelta()" class="signatureLink">calculateDragScrollDelta</a>(dropLocation:<a href="../../spark/layouts/supportClasses/DropLocation.html">DropLocation</a>, elapsedTime:Number):Point</div><div class="summaryTableDescription"> |
| Calculates how much to scroll for the specified dropLocation |
| during a drag and drop gesture.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html">LayoutBase</a></td></tr><tr class="hideInheritedProtectedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../spark/layouts/supportClasses/LayoutBase.html#calculateDropIndex()" class="signatureLink">calculateDropIndex</a>(x:Number, y:Number):int</div><div class="summaryTableDescription"> |
| Returns the index where a new item should be inserted if |
| the user releases the mouse at the specified coordinates |
| while completing a drag and drop gesture.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html">LayoutBase</a></td></tr><tr class="hideInheritedProtectedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../spark/layouts/supportClasses/LayoutBase.html#calculateDropIndicatorBounds()" class="signatureLink">calculateDropIndicatorBounds</a>(dropLocation:<a href="../../spark/layouts/supportClasses/DropLocation.html">DropLocation</a>):Rectangle</div><div class="summaryTableDescription"> |
| Calculates the bounds for the drop indicator that provides visual feedback |
| to the user of where the items will be inserted at the end of a drag and drop |
| gesture.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html">LayoutBase</a></td></tr><tr class="hideInheritedProtectedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../spark/layouts/supportClasses/LayoutBase.html#getElementBoundsAboveScrollRect()" class="signatureLink">getElementBoundsAboveScrollRect</a>(scrollRect:Rectangle):Rectangle</div><div class="summaryTableDescription"> |
| Returns the bounds of the first layout element that either spans or |
| is above the scrollRect's top edge.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html">LayoutBase</a></td></tr><tr class="hideInheritedProtectedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../spark/layouts/supportClasses/LayoutBase.html#getElementBoundsBelowScrollRect()" class="signatureLink">getElementBoundsBelowScrollRect</a>(scrollRect:Rectangle):Rectangle</div><div class="summaryTableDescription"> |
| Returns the bounds of the first layout element that either spans or |
| is below the scrollRect's bottom edge.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html">LayoutBase</a></td></tr><tr class="hideInheritedProtectedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../spark/layouts/supportClasses/LayoutBase.html#getElementBoundsLeftOfScrollRect()" class="signatureLink">getElementBoundsLeftOfScrollRect</a>(scrollRect:Rectangle):Rectangle</div><div class="summaryTableDescription"> |
| Returns the bounds of the first layout element that either spans or |
| is to the left of the scrollRect's left edge.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html">LayoutBase</a></td></tr><tr class="hideInheritedProtectedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../spark/layouts/supportClasses/LayoutBase.html#getElementBoundsRightOfScrollRect()" class="signatureLink">getElementBoundsRightOfScrollRect</a>(scrollRect:Rectangle):Rectangle</div><div class="summaryTableDescription"> |
| Returns the bounds of the first layout element that either spans or |
| is to the right of the scrollRect's right edge.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html">LayoutBase</a></td></tr><tr class="hideInheritedProtectedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../spark/layouts/supportClasses/LayoutBase.html#getScrollRect()" class="signatureLink">getScrollRect</a>():Rectangle</div><div class="summaryTableDescription"> |
| Returns the bounds of the target's scroll rectangle in layout coordinates.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html">LayoutBase</a></td></tr><tr class="hideInheritedProtectedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../spark/layouts/supportClasses/LayoutBase.html#scrollPositionChanged()" class="signatureLink">scrollPositionChanged</a>():void</div><div class="summaryTableDescription"> |
| Called when the verticalScrollPosition or |
| horizontalScrollPosition properties change.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/layouts/supportClasses/LayoutBase.html">LayoutBase</a></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="horizontalGap"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName"><img src="../../images/AirIcon12x12.gif" width="12" height="12" hspace="0" vspace="0" alt="AIR-only" title="Only available in the AIR runtime"> horizontalGap</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>horizontalGap: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.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>AIR 2.5</td></tr></table><p></p><p></p><p> |
| The horizontal space between columns, in pixels. |
| </p><p> The default value is <code>2</code>.</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 horizontalGap():Number</code><br/><code> public function set horizontalGap(value:Number):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="ViewMenuLayout.html#verticalGap" target="">verticalGap</a></div></div><a name="propertyDetail"></a><a name="requestedMaxColumnCount"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName"><img src="../../images/AirIcon12x12.gif" width="12" height="12" hspace="0" vspace="0" alt="AIR-only" title="Only available in the AIR runtime"> requestedMaxColumnCount</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>requestedMaxColumnCount:int</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 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>AIR 1.5</td></tr></table><p></p><p></p><p> |
| The maximum number of columns to display in a row. |
| </p><p> The default value is <code>3</code>.</p><br/><span class="label"> Implementation </span><br/><code> public function get requestedMaxColumnCount():int</code><br/><code> public function set requestedMaxColumnCount(value:int):void</code><br/></div><a name="propertyDetail"></a><a name="verticalGap"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName"><img src="../../images/AirIcon12x12.gif" width="12" height="12" hspace="0" vspace="0" alt="AIR-only" title="Only available in the AIR runtime"> verticalGap</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>verticalGap: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.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>AIR 2.5</td></tr></table><p></p><p></p><p> |
| The vertical space between rows, in pixels. |
| </p><p> The default value is <code>2</code>.</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 verticalGap():Number</code><br/><code> public function set verticalGap(value:Number):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="ViewMenuLayout.html#horizontalGap" target="">horizontalGap</a></div></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="ViewMenuLayout()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName"><img src="../../images/AirIcon12x12.gif" width="12" height="12" hspace="0" vspace="0" alt="AIR-only" title="Only available in the AIR runtime"> ViewMenuLayout</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function ViewMenuLayout()</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>AIR 2.5</td></tr></table><p></p><p> |
| Constructor. |
| </p></div><br/><br/><hr><br/><p></p><center class="copyright"><footer>The Apache Software Foundation</footer><br/>Wed Nov 15 2017, 09:50 AM +01:00 </center></div></body></html><!--The Apache Software Foundation<br/>Wed Nov 15 2017, 09:50 AM +01:00 --> |
