Packagemx.events
Classpublic class MenuEvent
InheritanceMenuEvent Inheritance ListEvent Inheritance flash.events.Event

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

The MenuEvent class represents events that are associated with menu activities in controls such as Menu, MenuBar, and PopUpMenuButton.

See also

mx.controls.Menu
mx.controls.MenuBar
mx.controls.PopUpMenuButton


Public Properties
 PropertyDefined By
 InheritedcolumnIndex : int
The zero-based index of the column that contains the item renderer where the event occurred.
ListEvent
  index : int
The index of the associated menu item within its parent menu or submenu.
MenuEvent
  item : Object
The specific item in the dataProvider.
MenuEvent
 InheriteditemRenderer : IListItemRenderer
The item renderer where the event occurred.
ListEvent
  label : String
The label text of the associated menu item.
MenuEvent
  menu : Menu
The specific Menu instance associated with the event, such as the menu or submenu that was hidden or opened.
MenuEvent
  menuBar : MenuBar
The MenuBar instance that is the parent of the selected Menu control, or null when the target Menu control is not parented by a MenuBar control.
MenuEvent
 Inheritedreason : String
The reason the itemEditEnd event was dispatched.
ListEvent
 InheritedrowIndex : int
In the zero-based index of the row that contains the item renderer where the event occured, or for editing events, the index of the item in the data provider that is being edited.
ListEvent
Public Methods
 MethodDefined By
  
MenuEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, menuBar:MenuBar = null, menu:Menu = null, item:Object = null, itemRenderer:IListItemRenderer = null, label:String = null, index:int = -1)
Constructor.
MenuEvent
Public Constants
 ConstantDefined By
  CHANGE : String = change
[static] The MenuEvent.CHANGE event type constant indicates that selection changed as a result of user interaction.
MenuEvent
  ITEM_CLICK : String = itemClick
[static] The MenuEvent.ITEM_CLICK event type constant indicates that the user selected a menu item.
MenuEvent
 InheritedITEM_DOUBLE_CLICK : String = itemDoubleClick
[static] The ListEvent.ITEM_DOUBLE_CLICK constant defines the value of the type property of the ListEvent object for an itemDoubleClick event, which indicates that the user double clicked the mouse over a visual item in the control.
ListEvent
 InheritedITEM_EDIT_BEGIN : String = itemEditBegin
[static] The ListEvent.ITEM_EDIT_BEGIN constant defines the value of the type property of the event object for a itemEditBegin event, which indicates that an item is ready to be edited.
ListEvent
 InheritedITEM_EDIT_BEGINNING : String = itemEditBeginning
[static] The ListEvent.ITEM_EDIT_BEGINNING constant defines the value of the type property of the ListEvent object for a itemEditBeginning event, which indicates that the user has prepared to edit an item, for example, by releasing the mouse button over the item.
ListEvent
 InheritedITEM_EDIT_END : String = itemEditEnd
[static] The ListEvent.ITEM_EDIT_END constant defines the value of the type property of the ListEvent object for a itemEditEnd event, which indicates that an edit session is ending.
ListEvent
 InheritedITEM_FOCUS_IN : String = itemFocusIn
[static] The ListEvent.ITEM_FOCUS_IN constant defines the value of the type property of the ListEvent object for an itemFocusIn event, which indicates that an item has received the focus.
ListEvent
 InheritedITEM_FOCUS_OUT : String = itemFocusOut
[static] The ListEvent.ITEM_FOCUS_OUT constant defines the value of the type property of the ListEvent object for an itemFocusOut event, which indicates that an item has lost the focus.
ListEvent
  ITEM_ROLL_OUT : String = itemRollOut
[static] The MenuEvent.ITEM_ROLL_OUT type constant indicates that the mouse pointer rolled out of a menu item.
MenuEvent
  ITEM_ROLL_OVER : String = itemRollOver
[static] The MenuEvent.ITEM_ROLL_OVER type constant indicates that the mouse pointer rolled over a menu item.
MenuEvent
  MENU_HIDE : String = menuHide
[static] The MenuEvent.MENU_HIDE event type constant indicates that a menu or submenu closed.
MenuEvent
  MENU_SHOW : String = menuShow
[static] The MenuEvent.MENU_SHOW type constant indicates that the mouse pointer rolled a menu or submenu opened.
MenuEvent
Property Detail
indexproperty
public var index:int

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

The index of the associated menu item within its parent menu or submenu. This is -1 for the menuShow and menuHide events.

itemproperty 
public var item:Object

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

The specific item in the dataProvider. This is null for the menuShow and menuHide events.

labelproperty 
public var label:String

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

The label text of the associated menu item. This is null for the menuShow and menuHide events.

menuproperty 
public var menu:Menu

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

The specific Menu instance associated with the event, such as the menu or submenu that was hidden or opened. This property is null if a MenuBar item is dispatching the event.

menuBarproperty 
public var menuBar:MenuBar

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

The MenuBar instance that is the parent of the selected Menu control, or null when the target Menu control is not parented by a MenuBar control.

Constructor Detail
MenuEvent()Constructor
public function MenuEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, menuBar:MenuBar = null, menu:Menu = null, item:Object = null, itemRenderer:IListItemRenderer = null, label:String = null, index:int = -1)

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

Constructor. Normally called by the Menu object.

Parameters
type:String — The event type; indicates the action that caused the event.
 
bubbles:Boolean (default = false) — Specifies whether the event can bubble up the display list hierarchy.
 
cancelable:Boolean (default = true) — Specifies whether the behavior associated with the event can be prevented.
 
menuBar:MenuBar (default = null) — The MenuBar instance that is the parent of the selected Menu control, or null when the target Menu control is not parented by a MenuBar control.
 
menu:Menu (default = null) — The specific Menu instance associated with the event, such as the menu or submenu that was hidden or opened. This property is null if a MenuBar item dispatches the event.
 
item:Object (default = null) — The item in the dataProvider of the associated menu item.
 
itemRenderer:IListItemRenderer (default = null) — The ListItemRenderer of the associated menu item.
 
label:String (default = null) — The label text of the associated menu item.
 
index:int (default = -1) — The index in the menu of the associated menu item.
Constant Detail
CHANGEConstant
public static const CHANGE:String = change

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

The MenuEvent.CHANGE event type constant indicates that selection changed as a result of user interaction.

The properties of the event object for this event type have the following values. Not all properties are meaningful for all kinds of events. See the detailed property descriptions for more information.

PropertyValue
bubblesfalse
cancelabletrue
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
indexThe index in the menu of the selected menu item.
itemThe item in the dataProvider that was selected.
itemRendererThe item renderer of the selected menu item.
labelThe label text of the selected menu item.
menuThe specific Menu instance associated with this event, or null if a MenuBar item is dispatching the event.
menuBarThe MenuBar instance that is the parent of the Menu control, or null if the Menu control is not parented by a MenuBar control.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
typeMenuEvent.CHANGE

ITEM_CLICKConstant 
public static const ITEM_CLICK:String = itemClick

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

The MenuEvent.ITEM_CLICK event type constant indicates that the user selected a menu item.

The properties of the event object for this event type have the following values. Not all properties are meaningful for all kinds of events. See the detailed property descriptions for more information.

PropertyValue
bubblesfalse
cancelabletrue
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
indexThe index in the menu of the selected menu item.
itemThe item in the dataProvider that was selected.
itemRendererThe ListItemRenderer of the selected menu item.
labelThe label text of the selected menu item.
menuThe specific Menu instance associated with this event, or null if a MenuBar item is dispatching the event.
menuBarThe MenuBar instance that is the parent of the Menu control, or null if the Menu control is not parented by a MenuBar control.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
typeMenuEvent.ITEM_CLICK

ITEM_ROLL_OUTConstant 
public static const ITEM_ROLL_OUT:String = itemRollOut

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

The MenuEvent.ITEM_ROLL_OUT type constant indicates that the mouse pointer rolled out of a menu item.

The properties of the event object for this event type have the following values. Not all properties are meaningful for all kinds of events. See the detailed property descriptions for more information.

PropertyValue
bubblesfalse
cancelabletrue
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
indexThe index in the menu of the menu item that was rolled out of.
itemThe item in the dataProvider corresponding to the menu item that was rolled out of.
itemRendererThe ListItemRenderer of the menu item that was rolled out of.
labelThe label text of the menu item that was rolled out of.
menuThe specific Menu instance associated with this event, or null if a MenuBar item is dispatching the event.
menuBarThe MenuBar instance that is the parent of the Menu control, or null if the Menu control is not parented by a MenuBar control.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
typeMenuEvent.ITEM_ROLL_OUT

ITEM_ROLL_OVERConstant 
public static const ITEM_ROLL_OVER:String = itemRollOver

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

The MenuEvent.ITEM_ROLL_OVER type constant indicates that the mouse pointer rolled over a menu item.

The properties of the event object for this event type have the following values. Not all properties are meaningful for all kinds of events. See the detailed property descriptions for more information.

PropertyValue
bubblesfalse
cancelabletrue
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
indexThe index in the menu of the menu item that was rolled over.
itemThe item in the dataProvider associated with the rolled over menu item.
itemRendererThe ListItemRenderer of the menu item that was rolled over.
labelThe label text of the menu item that was rolled over.
menuThe specific Menu instance associated with this event, or null if a MenuBar item is dispatching the event.
menuBarThe MenuBar instance that is the parent of the Menu control, or null if the Menu control is not parented by a MenuBar control.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
typeMenuEvent.ITEM_ROLL_OVER

MENU_HIDEConstant 
public static const MENU_HIDE:String = menuHide

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

The MenuEvent.MENU_HIDE event type constant indicates that a menu or submenu closed.

The properties of the event object for this event type have the following values. Not all properties are meaningful for all kinds of events. See the detailed property descriptions for more information.

PropertyValue
bubblesfalse
cancelabletrue
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
index-1. This property is not set for this type of event.
itemnull. This property is not set for this type of event.
itemRenderernull. This property is not set for this type of event.
labelnull. This property is not set for this type of event.
menuThe specific Menu instance associated with this event, or null if a MenuBar item is dispatching the event.
menuBarThe MenuBar instance that is the parent of the Menu control, or null if the Menu control is not parented by a MenuBar control.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
typeMenuEvent.MENU_HIDE

MENU_SHOWConstant 
public static const MENU_SHOW:String = menuShow

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

The MenuEvent.MENU_SHOW type constant indicates that the mouse pointer rolled a menu or submenu opened.

The properties of the event object for this event type have the following values. Not all properties are meaningful for all kinds of events. See the detailed property descriptions for more information.

PropertyValue
bubblesfalse
cancelabletrue
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
index-1. This property is not set for this type of event.
itemnull. This property is not set for this type of event.
itemRenderernull. This property is not set for this type of event.
labelnull. This property is not set for this type of event.
menuThe specific Menu instance associated with this event, or null if a MenuBar item is dispatching the event.
menuBarThe MenuBar instance that is the parent of the Menu control, or null if the Menu control is not parented by a MenuBar control.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
typeMenuEvent.MENU_SHOW