mx.events.MenuEvent - Adobe® Flex® 4 Language Reference (Flex 4)

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

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

Public Properties

Hide Inherited Public Properties

Show Inherited 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
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		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

Hide Inherited Public Methods

Show Inherited 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
		clone():Event Duplicates an instance of an Event subclass.	Event
		formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.	Event
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event.	Event
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		preventDefault():void Cancels an event's default behavior if that behavior can be canceled.	Event
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.	Event
		stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.	Event
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns a string containing all the properties of the Event object.	Event
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined By
		ACTIVATE : String = "activate" [static] The ACTIVATE constant defines the value of the type property of an activate event object.	Event
		ADDED : String = "added" [static] The Event.ADDED constant defines the value of the type property of an added event object.	Event
		ADDED_TO_STAGE : String = "addedToStage" [static] The Event.ADDED_TO_STAGE constant defines the value of the type property of an addedToStage event object.	Event
		CANCEL : String = "cancel" [static] The Event.CANCEL constant defines the value of the type property of a cancel event object.	Event
		CHANGE : String = "change" [static] The MenuEvent.CHANGE event type constant indicates that selection changed as a result of user interaction.	MenuEvent
		CLEAR : String = "clear" [static] The Event.CLEAR constant efines the value of the type property of a clear event object.	Event
		CLOSE : String = "close" [static] The Event.CLOSE constant defines the value of the type property of a close event object.	Event
		CLOSING : String = "closing" [static] The Event.CLOSING constant defines the value of the type property of a closing event object.	Event
		COMPLETE : String = "complete" [static] The Event.COMPLETE constant defines the value of the type property of a complete event object.	Event
		CONNECT : String = "connect" [static] The Event.CONNECT constant defines the value of the type property of a connect event object.	Event
		COPY : String = "copy" [static] Defines the value of the type property of a copy event object.	Event
		CUT : String = "cut" [static] Defines the value of the type property of a cut event object.	Event
		DEACTIVATE : String = "deactivate" [static] The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.	Event
		DISPLAYING : String = "displaying" [static] The Event.DISPLAYING constant defines the value of the type property of a displaying event object.	Event
		ENTER_FRAME : String = "enterFrame" [static] The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.	Event
		EXIT_FRAME : String = "exitFrame" [static] The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.	Event
		EXITING : String = "exiting" [static] The Event.EXITING constant defines the value of the type property of an exiting event object.	Event
		FRAME_CONSTRUCTED : String = "frameConstructed" [static] The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.	Event
		FULLSCREEN : String = "fullScreen" [static] The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.	Event
		HTML_BOUNDS_CHANGE : String = "htmlBoundsChange" [static] The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.	Event
		HTML_DOM_INITIALIZE : String = "htmlDOMInitialize" [static] The Event.HTML_DOM_INITIALIZE constant defines the value of the type property of an htmlDOMInitialize event object.	Event
		HTML_RENDER : String = "htmlRender" [static] The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.	Event
		ID3 : String = "id3" [static] The Event.ID3 constant defines the value of the type property of an id3 event object.	Event
		INIT : String = "init" [static] The Event.INIT constant defines the value of the type property of an init event object.	Event
		ITEM_CLICK : String = "itemClick" [static] The MenuEvent.ITEM_CLICK event type constant indicates that the user selected a menu item.	MenuEvent
		ITEM_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
		ITEM_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
		ITEM_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
		ITEM_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
		ITEM_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
		ITEM_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
		LOCATION_CHANGE : String = "locationChange" [static] The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.	Event
		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
		MOUSE_LEAVE : String = "mouseLeave" [static] The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.	Event
		NETWORK_CHANGE : String = "networkChange" [static] The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.	Event
		OPEN : String = "open" [static] The Event.OPEN constant defines the value of the type property of an open event object.	Event
		PASTE : String = "paste" [static] The Event.PASTE constant defines the value of the type property of a paste event object.	Event
		REMOVED : String = "removed" [static] The Event.REMOVED constant defines the value of the type property of a removed event object.	Event
		REMOVED_FROM_STAGE : String = "removedFromStage" [static] The Event.REMOVED_FROM_STAGE constant defines the value of the type property of a removedFromStage event object.	Event
		RENDER : String = "render" [static] The Event.RENDER constant defines the value of the type property of a render event object.	Event
		RESIZE : String = "resize" [static] The Event.RESIZE constant defines the value of the type property of a resize event object.	Event
		SCROLL : String = "scroll" [static] The Event.SCROLL constant defines the value of the type property of a scroll event object.	Event
		SELECT : String = "select" [static] The Event.SELECT constant defines the value of the type property of a select event object.	Event
		SELECT_ALL : String = "selectAll" [static] The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.	Event
		SOUND_COMPLETE : String = "soundComplete" [static] The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.	Event
		TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static] The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.	Event
		TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static] The Event.TAB_ENABLED_CHANGE constant defines the value of the type property of a tabEnabledChange event object.	Event
		TAB_INDEX_CHANGE : String = "tabIndexChange" [static] The Event.TAB_INDEX_CHANGE constant defines the value of the type property of a tabIndexChange event object.	Event
		UNLOAD : String = "unload" [static] The Event.UNLOAD constant defines the value of the type property of an unload event object.	Event
		USER_IDLE : String = "userIdle" [static] The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.	Event
		USER_PRESENT : String = "userPresent" [static] The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.	Event

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.

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.

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

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.

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.

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.

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.

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.

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