Packagemx.events
Classpublic class FlexNativeMenuEvent
InheritanceFlexNativeMenuEvent Inheritance flash.events.Event

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

The FlexNativeMenuEvent class represents events that are associated with menu activities in FlexNativeMenu.

See also

mx.controls.FlexNativeMenu


Public Properties
 PropertyDefined By
  AIR-only index : int
The index of the associated menu item within its parent menu or submenu.
FlexNativeMenuEvent
  AIR-only item : Object
The specific item in the dataProvider.
FlexNativeMenuEvent
  AIR-only label : String
The label text of the associated menu item.
FlexNativeMenuEvent
  AIR-only nativeMenu : NativeMenu
The specific NativeMenu instance associated with the event, such as the menu displayed.
FlexNativeMenuEvent
  AIR-only nativeMenuItem : NativeMenuItem
The specific NativeMenuItem instance associated with the event, such as the item clicked.
FlexNativeMenuEvent
Public Methods
 MethodDefined By
  
AIR-only FlexNativeMenuEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, nativeMenu:NativeMenu = null, nativeMenuItem:NativeMenuItem = null, item:Object = null, label:String = null, index:int = -1)
Constructor.
FlexNativeMenuEvent
Public Constants
 ConstantDefined By
  AIR-only ITEM_CLICK : String = itemClick
[static] The FlexNativeMenuEvent.ITEM_CLICK event type constant indicates that the user selected a menu item.
FlexNativeMenuEvent
  AIR-only MENU_SHOW : String = menuShow
[static] The FlexNativeMenuEvent.MENU_SHOW type constant indicates that the mouse pointer rolled a menu or submenu opened.
FlexNativeMenuEvent
Property Detail
AIR-only indexproperty
public var index:int

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

The index of the associated menu item within its parent menu or submenu. This is -1 for events that aren't associated with an individual item.

AIR-only itemproperty 
public var item:Object

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

The specific item in the dataProvider. This is null for events that aren't associated with an individual item.

AIR-only labelproperty 
public var label:String

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

The label text of the associated menu item. This is null for events that aren't associated with an individual item.

AIR-only nativeMenuproperty 
public var nativeMenu:NativeMenu

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

The specific NativeMenu instance associated with the event, such as the menu displayed.

AIR-only nativeMenuItemproperty 
public var nativeMenuItem:NativeMenuItem

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

The specific NativeMenuItem instance associated with the event, such as the item clicked. This is null for events that aren't associated with an individual item.

Constructor Detail
AIR-only FlexNativeMenuEvent()Constructor
public function FlexNativeMenuEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, nativeMenu:NativeMenu = null, nativeMenuItem:NativeMenuItem = null, item:Object = null, label:String = null, index:int = -1)

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

Constructor. Normally called by the FlexNativeMenu 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.
 
nativeMenu:NativeMenu (default = null) — The specific NativeMenu instance associated with the event.
 
nativeMenuItem:NativeMenuItem (default = null) — The specific NativeMenuItem instance associated with the event.
 
item:Object (default = null) — The item in the dataProvider 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
AIR-only ITEM_CLICKConstant
public static const ITEM_CLICK:String = itemClick

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

The FlexNativeMenuEvent.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.
labelThe label text of the selected menu item.
nativeMenuThe specific NativeMenu instance associated with this event.
nativeMenuItemThe specific NativeMenuItem instance associated with this event.
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.
typeFlexNativeMenuEvent.ITEM_CLICK

AIR-only MENU_SHOWConstant 
public static const MENU_SHOW:String = menuShow

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

The FlexNativeMenuEvent.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.
labelnull. This property is not set for this type of event.
nativeMenuThe specific NativeMenu instance associated with this event.
nativeMenuItemnull. This property is not set for this type of event.
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.
typeFlexNativeMenuEvent.MENU_SHOW