Packagemx.controls.menuClasses
Classpublic class MenuListData
InheritanceMenuListData Inheritance ListData Inheritance BaseListData Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The MenuListData class defines the data type of the listData 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 listData property.

See also

mx.controls.listClasses.IDropInListItemRenderer


Public Properties
 PropertyDefined By
 InheritedcolumnIndex : int
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.
BaseListData
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 Inheritedicon : Class
A Class representing the icon for the item in the List control computed from the list class's itemToIcon() method
ListData
 Inheritedlabel : String
The textual representation of the item data, based on the list class's itemToLabel() method.
BaseListData
 InheritedlabelField : String
The value of the labelField property in the list class.
ListData
  maxMeasuredBranchIconWidth : Number
The max branch icon width for all MenuItemListRenderers
MenuListData
  maxMeasuredIconWidth : Number
The max icon width for all MenuItemListRenderers
MenuListData
  maxMeasuredTypeIconWidth : Number
The max type icon width for all MenuItemListRenderers
MenuListData
 Inheritedowner : IUIComponent
A reference to the list object that owns this item.
BaseListData
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 InheritedrowIndex : int
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.
BaseListData
 Inheriteduid : String
The unique identifier for this item.
BaseListData
  useTwoColumns : Boolean
Whether the left icons should layout in two separate columns (one for icons and one for type icons, like check and radio)
MenuListData
Public Methods
 MethodDefined By
  
MenuListData(text:String, icon:Class, labelField:String, uid:String, owner:IUIComponent, rowIndex:int = 0, columnIndex:int = 0)
Constructor.
MenuListData
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Property Detail
maxMeasuredBranchIconWidthproperty
public var maxMeasuredBranchIconWidth:Number

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The max branch icon width for all MenuItemListRenderers

maxMeasuredIconWidthproperty 
public var maxMeasuredIconWidth:Number

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The max icon width for all MenuItemListRenderers

maxMeasuredTypeIconWidthproperty 
public var maxMeasuredTypeIconWidth:Number

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The max type icon width for all MenuItemListRenderers

useTwoColumnsproperty 
public var useTwoColumns:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Whether the left icons should layout in two separate columns (one for icons and one for type icons, like check and radio)

Constructor Detail
MenuListData()Constructor
public function MenuListData(text:String, icon:Class, labelField:String, uid:String, owner:IUIComponent, rowIndex:int = 0, columnIndex:int = 0)

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Constructor.

Parameters
text:String — Text representation of the item data.
 
icon:Class — A Class or String object representing the icon for the item in the List control.
 
labelField:String — The name of the field of the data provider containing the label data of the List component.
 
uid:String — A unique identifier for the item.
 
owner:IUIComponent — A reference to the Menu control.
 
rowIndex:int (default = 0) — The index of the item in the data provider for the Menu control.
 
columnIndex:int (default = 0) — The index of the column in the currently visible columns of the control.