ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
mx.events 

FlexNativeMenuEvent  - AS3 Flex
Packagemx.events
Classpublic class FlexNativeMenuEvent
InheritanceFlexNativeMenuEvent Inheritance Event Inheritance Object

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.

More examples

Manually dispatching events

Learn more

About Flex events

Related API Elements

mx.controls.FlexNativeMenu

Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : 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.
FlexNativeMenuEvent
      item : Object
The specific item in the dataProvider.
FlexNativeMenuEvent
      label : String
The label text of the associated menu item.
FlexNativeMenuEvent
      nativeMenu : NativeMenu
The specific NativeMenu instance associated with the event, such as the menu displayed.
FlexNativeMenuEvent
      nativeMenuItem : NativeMenuItem
The specific NativeMenuItem instance associated with the event, such as the item clicked.
FlexNativeMenuEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
    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
 Inherited
clone():Event
Duplicates an instance of an Event subclass.
Event
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
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
 Inherited
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns a string containing all the properties of the Event object.
Event
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
      ITEM_CLICK : String = "itemClick"
[static] The FlexNativeMenuEvent.ITEM_CLICK event type constant indicates that the user selected a menu item.
FlexNativeMenuEvent
      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
    

index

property
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.

    

item

property 
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.

    

label

property 
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.

    

nativeMenu

property 
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.

    

nativeMenuItem

property 
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
    

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
    

ITEM_CLICK

Constant
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
    

MENU_SHOW

Constant 
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



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy