Pacoteflash.display
Classepublic class NativeMenu
HerançaNativeMenu Inheritance EventDispatcher Inheritance Object
Subclasses ContextMenu

The NativeMenu class contains methods and properties for defining menus.

AIR supports the following menus:

MenuInstanceCapability checkSupported onDefault provided?
ApplicationShell.shell.menuShell.supportsMenuMac OS XYes
WindowNativeWindow.menuNativeWindow.supportsMenuWindowsNo
Dock application iconShell.shell.icon.menuShell.supportsDockIconMac OS XYes
System tray iconShell.shell.icon.menuShell.supportsSystemTrayIconWindowsNo
ContextInteractiveObject.contextMenuAllAllNo
Pop-upApplication definedAllAllNo

A menu can contain items for commands, submenus, and separator lines. Menu items are added to a menu with the addItem(), addItemAt(), addSubmenu(), and addSubmenuAt() methods. The display order of a menu's items matches the order of the items in the menu's items array.

Submenus are attached to their parent menu through the submenu property of the matching menu item in the parent menu. The root menu of window and application menus must only contain submenu items; items without submenus may not be displayed and are contrary to user expectation for these types of menus.

Menus dispatch select events when a cammand item in the menu, or one of its submenus is selected. (Submenu and seprator items are not selectable.) The target property of the event object will reference the selected item.

Menus dispatch displaying events just before the menu is displayed. You can use this event to update the contents of the menu based on the current state of the application.

Note: The ContextMenu class extends the NativeMenu class, but retains the methods, properties, and event behavior of the legacy ContextMenu class. This leads to some overlap in functionality. For exemplo, the ContextMenu, menuSelect event, is essentially the same as the NativeMenu displaying event. You can use either a NativeMenu or a ContextMenu object to set a context menu. One benefit of using the ContextMenu object is that the ContextMenuEvent object contains a reference to the object that was clicked to open the menu.

Veja também

flash.display.NativeMenuItem
flash.display.NativeWindow.menu
flash.system.Shell.menu
flash.system.Shell.icon
flash.desktop.DockIcon
flash.desktop.SystemTrayIcon

Propriedades Públicas
 PropriedadeDefinido por
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  items : Array
[read-only] The array of NativeMenuItems in this menu.
NativeMenu
  numItems : int
[read-only] The number of NativeMenuItems in this menu.
NativeMenu
  parent : NativeMenu
[read-only] The parent menu.
NativeMenu
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
Métodos Públicos
 MétodoDefinido por
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
EventDispatcher
  
addItem(item:NativeMenuItem):NativeMenuItem
Adds a menu item at the bottom of the menu.
NativeMenu
  
addItemAt(item:NativeMenuItem, index:int):NativeMenuItem
Inserts a menu item at the specified position.
NativeMenu
  
addSubmenu(submenu:NativeMenu, label:String):NativeMenuItem
Adds a submenu to the menu by inserting a new menu item.
NativeMenu
  
addSubmenuAt(submenu:NativeMenu, index:int, label:String):NativeMenuItem
Adds a submenu to the menu by inserting a new menu item at the specified position.
NativeMenu
  
clone():NativeMenu
Creates a copy of the menu and all items.
NativeMenu
  
containsItem(item:NativeMenuItem):Boolean
Reports whether this menu contains the specified menu item.
NativeMenu
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
EventDispatcher
  
display(stage:Stage, stageX:Number, stageY:Number):void
Pops up this menu at the specified location.
NativeMenu
  
getItemAt(index:int):NativeMenuItem
Gets the menu item at the specified index.
NativeMenu
  
getItemByName(name:String):NativeMenuItem
Gets the menu item with the specified name.
NativeMenu
  
getItemIndex(item:NativeMenuItem):int
Gets the position of the specified item.
NativeMenu
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 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
  
performKeyEquivalent(event:KeyboardEvent):Boolean
Looks up and selects a menu item based on key equivalent
NativeMenu
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
  
removeItem(item:NativeMenuItem):NativeMenuItem
Removes the specified menu item.
NativeMenu
  
removeItemAt(index:int):NativeMenuItem
Removes and returns the menu item at the specified index.
NativeMenu
  
setItemIndex(item:NativeMenuItem, index:int):void
Moves a menu item to the specified position.
NativeMenu
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
 Inherited
willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Eventos
 Evento Descrição Definido por
 Inherited
activate
Dispatched when Flash Player or the and AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited
deactivate
Dispatched when Flash Player loses operating system focus and is becoming inactive.EventDispatcher
  
displaying
Dispatched by this NativeMenu object immediately before the menu is to be displayed.NativeMenu
  
select
Dispatched by this NativeMenu object when one of its menu items or an item in one of its descendant submenus is selected.NativeMenu
Detalhes da propriedade
itemspropriedade
items:Array  [read-only]

The array of NativeMenuItems in this menu.

The array is sorted in display order.


Implementação
    public function get items():Array
numItemspropriedade 
numItems:int  [read-only]

The number of NativeMenuItems in this menu.


Implementação
    public function get numItems():int
parentpropriedade 
parent:NativeMenu  [read-only]

The parent menu.

The parent of the root (top-level) menu object will be null.


Implementação
    public function get parent():NativeMenu
Detalhes do método
addItem()método
public function addItem(item:NativeMenuItem):NativeMenuItem

Adds a menu item at the bottom of the menu.

Parâmetros

item:NativeMenuItem — the NativeMenuItem to add at the bottom of the menu

Retorna
NativeMenuItem
addItemAt()método 
public function addItemAt(item:NativeMenuItem, index:int):NativeMenuItem

Inserts a menu item at the specified position.

Parâmetros

item:NativeMenuItem — the NativeMenuItem to insert
 
index:int — the (zero-based) position in menu at which to insert the menu item

Retorna
NativeMenuItem

Throws
ArgumentError — if item is null
 
RangeError — if the index is outside the bounds of the menu's items array
addSubmenu()método 
public function addSubmenu(submenu:NativeMenu, label:String):NativeMenuItem

Adds a submenu to the menu by inserting a new menu item.

addSubMenuAt() is equivalent to creating a new menu item, adding it to the menu, and assigning a NativeMenu object to the item's submenu property.

Parâmetros

submenu:NativeMenu — The NativeMenu object defining the submenu to be added
 
label:String — The display label for the menu item to be added

Retorna
NativeMenuItem — the NativeMenuItem object created for the submenu
addSubmenuAt()método 
public function addSubmenuAt(submenu:NativeMenu, index:int, label:String):NativeMenuItem

Adds a submenu to the menu by inserting a new menu item at the specified position.

addSubMenuAt() is equivalent to creating a new menu item, inserting it at the desired position in the menu, and assigning a NativeMenu object to the item's submenu property.

Parâmetros

submenu:NativeMenu — The NativeMenu object defining the submenu to be added
 
index:int — The position in the items array of this menu at which to insert the menu item to be added
 
label:String — The display label for the menu item to be added

Retorna
NativeMenuItem — the NativeMenuItem object created for the submenu
clone()método 
public function clone():NativeMenu

Creates a copy of the menu and all items.

Retorna
NativeMenu
containsItem()método 
public function containsItem(item:NativeMenuItem):Boolean

Reports whether this menu contains the specified menu item.

Parâmetros

item:NativeMenuItem — The NativeMenuItem object to look up

Retorna
Boolean — true if item is in this menu
display()método 
public function display(stage:Stage, stageX:Number, stageY:Number):void

Pops up this menu at the specified location.

Parâmetros

stage:Stage — The Stage object on which to display this menu
 
stageX:Number — The number of horizontal pixels, relative to the origin of stage at which to display this menu
 
stageY:Number — The number of vertical pixels, relative to the origin of stage at which to display this menu

getItemAt()método 
public function getItemAt(index:int):NativeMenuItem

Gets the menu item at the specified index.

Parâmetros

index:int — the (zero-based) position of the item to return.

Retorna
NativeMenuItem — the NativeMenuItem object at the specified position in the menu

Throws
RangeError — if index is outside the bounds of the menu's items array
getItemByName()método 
public function getItemByName(name:String):NativeMenuItem

Gets the menu item with the specified name.

Note: The name property of menu items is not assigned by default.

Parâmetros

name:String — the string to look up

Retorna
NativeMenuItem — the NativeMenuItem object with the specified name or null, if no such item exists in the menu
getItemIndex()método 
public function getItemIndex(item:NativeMenuItem):int

Gets the position of the specified item.

Parâmetros

item:NativeMenuItem — the NativeMenuItem to look up

Retorna
int — the (zero-based) position of the specified item in this menu or null, if the item is not in this menu
performKeyEquivalent()método 
public function performKeyEquivalent(event:KeyboardEvent):Boolean

Looks up and selects a menu item based on key equivalent

Parâmetros

event:KeyboardEvent — The keyboard event to test against

Retorna
Boolean
removeItem()método 
public function removeItem(item:NativeMenuItem):NativeMenuItem

Removes the specified menu item.

Parâmetros

item:NativeMenuItem — the NativeMenuItem object to remove from this menu

Retorna
NativeMenuItem

Throws
RangeError — if item is not in this menu
removeItemAt()método 
public function removeItemAt(index:int):NativeMenuItem

Removes and returns the menu item at the specified index.

Parâmetros

index:int — the (zero-based) position of the item to remove

Retorna
NativeMenuItem — the NativeMenuItem object removed

Throws
RangeError — if index is outside the bounds of this menu's items array.
setItemIndex()método 
public function setItemIndex(item:NativeMenuItem, index:int):void

Moves a menu item to the specified position.

Parâmetros

item:NativeMenuItem — the NativeMenuItem object to move
 
index:int — the (zero-based) position in the menu to which to move item


Throws
RangeError — if index is outside the bounds of the menu's items array.
Detalhes do evento
displaying Evento
Event Object Type: flash.events.Event
Event.type property = flash.events.Event.DISPLAYING

Dispatched by this NativeMenu object immediately before the menu is to be displayed.

Listen to this event to update the menu before it is displayed. Displaying events are also dispatched by the items in a menu.

Defines the value of the type property of a displaying event object.

Note: This event does not go through a "capture phase" and is dispatched directly to the target, whether the target is on the display list or not.

This event has the following properties:

PropriedadeValor
bubblesfalse
cancelablefalse
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe object that is about to be displayed.
select Evento  
Event Object Type: flash.events.Event
Event.type property = flash.events.Event.SELECT

Dispatched by this NativeMenu object when one of its menu items or an item in one of its descendant submenus is selected.

A select event will "bubble" from a menu item to its containing menu and on up through the parent menu chain to the root menu object. The target property of the event object will reference the selected NativeMenuItem object; the currentTarget property will reference this NativeMenu object.

The Event.SELECT constant defines the value of the type property of a select event object.

This event has the following properties:

PropriedadeValor
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe object on which an item has been selected.



© 2004-2007 Adobe Systems Incorporated. All rights reserved.
Traduzido e mantido por Igor Costa - www.igorcosta.com