Packagecom.ghostwire.ui.events
Classpublic class uiMenuEvent
InheritanceuiMenuEvent Inheritance flash.events.Event

The uiMenuEvent class defines events that are dispatched due to menu activities.

~ This class is available in Aspire UI Components Standard Edition ~



Public Properties
 PropertyDefined by
  item : Object
[read-only] Indicates the data object (item) associated with this event.
uiMenuEvent
  menu : uiMenu
[read-only] Indicates the uiMenu containing the menu item that triggered this event.
uiMenuEvent
Public Methods
 MethodDefined by
  
uiMenuEvent(type:String, item:Object, menu:uiMenu)
Creates a new uiMenuEvent object with the specified parameters.
uiMenuEvent
Public Constants
 ConstantDefined by
  MENU_HIDE : String = "menuHide"
[static] Dispatched when the currently shown popup uiMenu is closed.
uiMenuEvent
  MENU_SELECT : String = "menuSelect"
[static] Dispatched when a user selects an enabled menu item from a uiMenu instance.
uiMenuEvent
  MENU_SHOW : String = "menuShow"
[static] Dispatched when a submenu uiMenu instance is created and displayed.
uiMenuEvent
Property detail
itemproperty
item:Object  [read-only]

Indicates the data object (item) associated with this event.

Implementation
    public function get item():Object
menuproperty 
menu:uiMenu  [read-only]

Indicates the uiMenu containing the menu item that triggered this event.

Implementation
    public function get menu():uiMenu
Constructor detail
uiMenuEvent()constructor
public function uiMenuEvent(type:String, item:Object, menu:uiMenu)

Creates a new uiMenuEvent object with the specified parameters.

Parameters
type:String — The type of the event.
 
item:Object — The data object associated with the menu item that is interacted with when the event is dispatched.
 
menu:uiMenu — The uiMenu that contains the menu item triggering this event.
Constant detail
MENU_HIDEconstant
public static const MENU_HIDE:String = "menuHide"

Dispatched when the currently shown popup uiMenu is closed.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event object with an event listener. For example, if you use myMenuBar.addEventListener() to register an event listener, myMenuBar is the value of the currentTarget.
targetThe object that dispatched the event. The target is not always the object listening for the event. Use the currentTarget property to access the object that is listening for the event.
itemnull. This property is not set for this type of event.
menuThe popup uiMenu that is closed.
MENU_SELECTconstant 
public static const MENU_SELECT:String = "menuSelect"

Dispatched when a user selects an enabled menu item from a uiMenu instance.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event object with an event listener. For example, if you use myMenuBar.addEventListener() to register an event listener, myMenuBar is the value of the currentTarget.
targetThe object that dispatched the event. The target is not always the object listening for the event. Use the currentTarget property to access the object that is listening for the event.
itemA data object representing the menu item selected.
menuThe uiMenu containing the menu item that has been selected.
MENU_SHOWconstant 
public static const MENU_SHOW:String = "menuShow"

Dispatched when a submenu uiMenu instance is created and displayed.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event object with an event listener. For example, if you use myMenuBar.addEventListener() to register an event listener, myMenuBar is the value of the currentTarget.
targetThe object that dispatched the event. The target is not always the object listening for the event. Use the currentTarget property to access the object that is listening for the event.
itemA data object representing the menu item in the parent menu that owns this submenu.
menuThe submenu uiMenu instance that is created and displayed.