| Package | mx.events |
| Class | public class MenuEvent |
| Inheritance | MenuEvent  ListEvent Event Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
More examples
Learn more
Related API Elements
Public Properties
| Property | Defined By | ||
|---|---|---|---|
 | bubbles : Boolean [read-only]
Indicates whether an event is a bubbling event. | Event | |
| cancelable : Boolean [read-only]
Indicates whether the behavior associated with the event can be prevented. | Event | |
| columnIndex : int
The zero-based index of the column that contains
the item renderer where the event occurred. | ListEvent | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| currentTarget : Object [read-only]
The object that is actively processing the Event object with an event listener. | Event | |
| eventPhase : uint [read-only]
The current phase in the event flow. | Event | |
| 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 | ||
| itemRenderer : 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 | ||
| reason : String
The reason the itemEditEnd event was dispatched. | ListEvent | |
| rowIndex : 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 | |
| target : Object [read-only]
The event target. | Event | |
| type : String [read-only]
The type of event. | Event | |
Public Methods
| Method | Defined 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 | ||
|
Duplicates an instance of an Event subclass. | Event | |
|
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Checks whether the preventDefault() method has been called on the event. | Event | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Cancels an event's default behavior if that behavior can be canceled. | Event | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | |
|
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns a string containing all the properties of the Event object. | Event | |
|
Returns the primitive value of the specified object. | Object | |
Public Constants
| Constant | Defined 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 | ||
| 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
index | property |
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.
item | property |
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.
label | property |
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.
menu | property |
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.
menuBar | property |
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.
Parameterstype:String — The event type; indicates the action that caused the event.
| |
bubbles:Boolean (default = false) | |
cancelable:Boolean (default = true) | |
menuBar:MenuBar (default = null) | |
menu:Menu (default = null) | |
item:Object (default = null) | |
itemRenderer:IListItemRenderer (default = null) | |
label:String (default = null) | |
index:int (default = -1) |
Constant Detail
CHANGE | Constant |
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.
| Property | Value |
|---|---|
bubbles | false |
cancelable | true |
currentTarget | The 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 | The index in the menu of the selected menu item. |
item | The item in the dataProvider that was selected. |
itemRenderer | The item renderer of the selected menu item. |
label | The label text of the selected menu item. |
menu | The specific Menu instance associated with this event, or
null if a MenuBar item is dispatching the event. |
menuBar | The MenuBar instance that is the parent of the
Menu control, or null if the Menu control is not
parented by a MenuBar control. |
target | The 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. |
type | MenuEvent.CHANGE |
ITEM_CLICK | Constant |
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.
| Property | Value |
|---|---|
bubbles | false |
cancelable | true |
currentTarget | The 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 | The index in the menu of the selected menu item. |
item | The item in the dataProvider that was selected. |
itemRenderer | The ListItemRenderer of the selected menu item. |
label | The label text of the selected menu item. |
menu | The specific Menu instance associated with this event, or
null if a MenuBar item is dispatching the event. |
menuBar | The MenuBar instance that is the parent of the
Menu control, or null if the Menu control is not
parented by a MenuBar control. |
target | The 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. |
type | MenuEvent.ITEM_CLICK |
ITEM_ROLL_OUT | Constant |
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.
| Property | Value |
|---|---|
bubbles | false |
cancelable | true |
currentTarget | The 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 | The index in the menu of the menu item that was rolled out of. |
item | The item in the dataProvider corresponding to the menu item that was rolled out of. |
itemRenderer | The ListItemRenderer of the menu item that was rolled out of. |
label | The label text of the menu item that was rolled out of. |
menu | The specific Menu instance associated with this event, or
null if a MenuBar item is dispatching the event. |
menuBar | The MenuBar instance that is the parent of the
Menu control, or null if the Menu control is not
parented by a MenuBar control. |
target | The 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. |
type | MenuEvent.ITEM_ROLL_OUT |
ITEM_ROLL_OVER | Constant |
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.
| Property | Value |
|---|---|
bubbles | false |
cancelable | true |
currentTarget | The 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 | The index in the menu of the menu item that was rolled over. |
item | The item in the dataProvider associated with the rolled over menu item. |
itemRenderer | The ListItemRenderer of the menu item that was rolled over. |
label | The label text of the menu item that was rolled over. |
menu | The specific Menu instance associated with this event, or
null if a MenuBar item is dispatching the event. |
menuBar | The MenuBar instance that is the parent of the
Menu control, or null if the Menu control is not
parented by a MenuBar control. |
target | The 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. |
type | MenuEvent.ITEM_ROLL_OVER |
MENU_HIDE | Constant |
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.
| Property | Value |
|---|---|
bubbles | false |
cancelable | true |
currentTarget | The 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. |
item | null. This property is not set for this type of event. |
itemRenderer | null. This property is not set for this type of event. |
label | null. This property is not set for this type of event. |
menu | The specific Menu instance associated with this event, or
null if a MenuBar item is dispatching the event. |
menuBar | The MenuBar instance that is the parent of the
Menu control, or null if the Menu control is not
parented by a MenuBar control. |
target | The 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. |
type | MenuEvent.MENU_HIDE |
MENU_SHOW | Constant |
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.
| Property | Value |
|---|---|
bubbles | false |
cancelable | true |
currentTarget | The 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. |
item | null. This property is not set for this type of event. |
itemRenderer | null. This property is not set for this type of event. |
label | null. This property is not set for this type of event. |
menu | The specific Menu instance associated with this event, or
null if a MenuBar item is dispatching the event. |
menuBar | The MenuBar instance that is the parent of the
Menu control, or null if the Menu control is not
parented by a MenuBar control. |
target | The 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. |
type | MenuEvent.MENU_SHOW |
Thu Dec 4 2014, 05:50 PM -08:00