blob: 88bb267862e291192fe195fcb10541b884d16875 [file] [log] [blame]
<!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="MenuListData,mx.controls.menuClasses.MenuListData,branchIcon,data,data,dataProvider,icon,icon,label,label,listData,maxMeasuredBranchIconWidth,maxMeasuredIconWidth,maxMeasuredTypeIconWidth,measuredBranchIconWidth,measuredBranchIconWidth,measuredIconWidth,measuredIconWidth,measuredTypeIconWidth,measuredTypeIconWidth,menu,menu,menuBar,menuBar,menuBarItemIndex,menuBarItemIndex,menuBarItemState,menuBarItemState,separatorIcon,typeIcon,useTwoColumns"><title>mx.controls.menuClasses.MenuListData</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 = 'MenuListData - 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>&nbsp;|&nbsp;<a href="../../../class-summary.html" onclick="loadClassListFrame('../../../all-classes.html')">All Classes</a>&nbsp;|&nbsp;<a href="../../../all-index-A.html" onclick="loadClassListFrame('../../../index-list.html')">Index</a>&nbsp;|&nbsp;<a id="framesLink1" href="../../../index.html?mx/controls/menuClasses/MenuListData.html&amp;mx/controls/menuClasses/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">MenuListData</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td></tr><tr class="titleTableRow3"><td colspan="3">&nbsp;</td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("MenuListData"); titleBar_setSubNav(false,true,false,false,false,false,false,false,true,false,false ,false,false,false,false,false);}
-->
</script><div xmlns:fn="http://www.w3.org/2005/xpath-functions" class="MainContent"><table class="classHeaderTable" cellpadding="0" cellspacing="0"><tr><td class="classHeaderTableLabel">Package</td><td><a href="package-detail.html" onclick="javascript:loadClassListFrame('class-list.html')">mx.controls.menuClasses</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class MenuListData</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">MenuListData <img src="../../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> <a href="../../../mx/controls/listClasses/ListData.html">ListData</a> <img src="../../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> <a href="../../../mx/controls/listClasses/BaseListData.html">BaseListData</a> <img src="../../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> flash.events.EventDispatcher</td></tr></table><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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 :&nbsp;</b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p></p><p></p>
The MenuListData class defines the data type of the <code>listData</code> property
implemented by drop-in item renderers or drop-in item editors for the Menu and
MenuBar control. All drop-in item renderers and drop-in item editors must implement the
IDropInListItemRenderer interface, which defines the <code>listData</code> property.
<p></p><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso"><a href="../../../mx/controls/listClasses/IDropInListItemRenderer.html" target="">mx.controls.listClasses.IDropInListItemRenderer</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>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../mx/controls/listClasses/BaseListData.html#columnIndex" class="signatureLink">columnIndex</a> : int<div class="summaryTableDescription">
The index of the column of the List-based control relative
to the currently visible columns of the control, where the first column
is at an index of 1.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/controls/listClasses/BaseListData.html">BaseListData</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../mx/controls/listClasses/ListData.html#icon" class="signatureLink">icon</a> : Class<div class="summaryTableDescription">
A Class representing the icon for the item in the List control computed
from the list class's itemToIcon() method
</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/controls/listClasses/ListData.html">ListData</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../mx/controls/listClasses/BaseListData.html#label" class="signatureLink">label</a> : String<div class="summaryTableDescription">
The textual representation of the item data, based on the list class's
itemToLabel() method.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/controls/listClasses/BaseListData.html">BaseListData</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../mx/controls/listClasses/ListData.html#labelField" class="signatureLink">labelField</a> : String<div class="summaryTableDescription">
The value of the labelField property in the list class.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/controls/listClasses/ListData.html">ListData</a></td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#maxMeasuredBranchIconWidth" class="signatureLink">maxMeasuredBranchIconWidth</a> : Number<div class="summaryTableDescription">
The max branch icon width for all MenuItemListRenderers
</div></td><td class="summaryTableOwnerCol">MenuListData</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#maxMeasuredIconWidth" class="signatureLink">maxMeasuredIconWidth</a> : Number<div class="summaryTableDescription">
The max icon width for all MenuItemListRenderers
</div></td><td class="summaryTableOwnerCol">MenuListData</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#maxMeasuredTypeIconWidth" class="signatureLink">maxMeasuredTypeIconWidth</a> : Number<div class="summaryTableDescription">
The max type icon width for all MenuItemListRenderers
</div></td><td class="summaryTableOwnerCol">MenuListData</td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../mx/controls/listClasses/BaseListData.html#owner" class="signatureLink">owner</a> : <a href="../../../mx/core/IUIComponent.html">IUIComponent</a><div class="summaryTableDescription">
A reference to the list object that owns this item.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/controls/listClasses/BaseListData.html">BaseListData</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../mx/controls/listClasses/BaseListData.html#rowIndex" class="signatureLink">rowIndex</a> : int<div class="summaryTableDescription">
The index of the row of the DataGrid, List, or Tree control relative
to the currently visible rows of the control, where the first row
is at an index of 1.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/controls/listClasses/BaseListData.html">BaseListData</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../mx/controls/listClasses/BaseListData.html#uid" class="signatureLink">uid</a> : String<div class="summaryTableDescription">
The unique identifier for this item.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/controls/listClasses/BaseListData.html">BaseListData</a></td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#useTwoColumns" class="signatureLink">useTwoColumns</a> : Boolean<div class="summaryTableDescription">
Whether the left icons should layout in two separate columns
(one for icons and one for type icons, like check and radio)
</div></td><td class="summaryTableOwnerCol">MenuListData</td></tr></table></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableMethod"><tr><th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#MenuListData()" class="signatureLink">MenuListData</a>(text:String, icon:Class, labelField:String, uid:String, owner:<a href="../../../mx/core/IUIComponent.html">IUIComponent</a>, rowIndex:int = 0, columnIndex:int = 0)</div><div class="summaryTableDescription">
Constructor.</div></td><td class="summaryTableOwnerCol">MenuListData</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="maxMeasuredBranchIconWidth"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">maxMeasuredBranchIconWidth</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>public var maxMeasuredBranchIconWidth:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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 :&nbsp;</b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p>
The max branch icon width for all MenuItemListRenderers
</p></div><a name="propertyDetail"></a><a name="maxMeasuredIconWidth"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">maxMeasuredIconWidth</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>public var maxMeasuredIconWidth:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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 :&nbsp;</b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p>
The max icon width for all MenuItemListRenderers
</p></div><a name="propertyDetail"></a><a name="maxMeasuredTypeIconWidth"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">maxMeasuredTypeIconWidth</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>public var maxMeasuredTypeIconWidth:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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 :&nbsp;</b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p>
The max type icon width for all MenuItemListRenderers
</p></div><a name="propertyDetail"></a><a name="useTwoColumns"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">useTwoColumns</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>public var useTwoColumns:Boolean</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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 :&nbsp;</b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p>
Whether the left icons should layout in two separate columns
(one for icons and one for type icons, like check and radio)
</p></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="MenuListData()"></a><a name="MenuListData(String,Class,String,String,mx.core.IUIComponent,int,int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">MenuListData</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function MenuListData(text:String, icon:Class, labelField:String, uid:String, owner:<a href="../../../mx/core/IUIComponent.html">IUIComponent</a>, rowIndex:int = 0, columnIndex:int = 0)</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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 :&nbsp;</b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p>
Constructor.
</p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">text</span>:String</code> &mdash; Text representation of the item data.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">icon</span>:Class</code> &mdash; A Class or String object representing the icon
for the item in the List control.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">labelField</span>:String</code> &mdash; The name of the field of the data provider
containing the label data of the List component.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">uid</span>:String</code> &mdash; A unique identifier for the item.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">owner</span>:<a href="../../../mx/core/IUIComponent.html">IUIComponent</a></code> &mdash; A reference to the Menu control.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">rowIndex</span>:int</code> (default = <code>0</code>)<code></code> &mdash; The index of the item in the data provider for the Menu control.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">columnIndex</span>:int</code> (default = <code>0</code>)<code></code> &mdash; The index of the column in the currently visible columns of the
control.
</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 -->