Package | flash.display |
Class | public class NativeMenu |
Inheritance | NativeMenu EventDispatcher Object |
Subclasses | ContextMenu |
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0 |
AIR supports the following types of menus:
Menu | Instance | Capability test | Supported on | Default provided? |
---|---|---|---|---|
Application |
NativeApplication.nativeApplication.menu
|
NativeApplication.supportsMenu
| Mac OS X | Yes |
Window |
NativeWindow.menu
|
NativeWindow.supportsMenu
| Windows, Linux | No |
Dock icon |
NativeApplication.nativeApplication.icon.menu
|
NativeApplication.supportsDockIcon
| Mac OS X | Yes |
System tray icon |
NativeApplication.nativeApplication.icon.menu
|
NativeApplication.supportsSystemTrayIcon
| Windows, Linux | No |
Context |
InteractiveObject.contextMenu
| Always supported | All | No |
Pop-up | Any NativeMenu instance | Always supported | All | No |
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 contain only 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 command item in the menu or one of its
submenus is selected. (Submenu and separator items are not selectable.) The
target
property of the event object references 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: You can use either a NativeMenu or a ContextMenu object to set a context menu. Flash Player supports only the ContextMenu class, not the NativeMenu class.
See also
flash.display.NativeMenuItem
flash.display.NativeWindow.menu
flash.desktop.DockIcon
flash.desktop.SystemTrayIcon
flash.desktop.NativeApplication.menu
flash.desktop.NativeApplication.icon
Property | Defined By | ||
---|---|---|---|
constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | ||
items : Array
The array of NativeMenuItem objects in this menu. | NativeMenu | ||
numItems : int [read-only]
The number of NativeMenuItem objects in this menu. | NativeMenu | ||
parent : NativeMenu [read-only]
The parent menu. | NativeMenu | ||
prototype : Object [static]
A reference to the prototype object of a class or function object. | Object |
Method | Defined By | ||
---|---|---|---|
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 | ||
Adds a menu item at the bottom of the menu. | NativeMenu | ||
Inserts a menu item at the specified position. | NativeMenu | ||
Adds a submenu to the menu by inserting a new menu item. | NativeMenu | ||
Adds a submenu to the menu by inserting a new menu item at the
specified position. | NativeMenu | ||
Creates a copy of the menu and all items. | NativeMenu | ||
Reports whether this menu contains the specified menu item. | NativeMenu | ||
Dispatches an event into the event flow. | EventDispatcher | ||
Pops up this menu at the specified location. | NativeMenu | ||
Gets the menu item at the specified index. | NativeMenu | ||
Gets the menu item with the specified name. | NativeMenu | ||
Gets the position of the specified item. | NativeMenu | ||
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | ||
Indicates whether an object has a specified property defined. | Object | ||
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | ||
Indicates whether the specified property exists and is enumerable. | Object | ||
Removes all items from the menu. | NativeMenu | ||
Removes a listener from the EventDispatcher object. | EventDispatcher | ||
Removes the specified menu item. | NativeMenu | ||
Removes and returns the menu item at the specified index. | NativeMenu | ||
Moves a menu item to the specified position. | NativeMenu | ||
Sets the availability of a dynamic property for loop operations. | Object | ||
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | ||
Returns the string representation of the specified object. | Object | ||
Returns the primitive value of the specified object. | Object | ||
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher |
Event | Summary | Defined By | ||
---|---|---|---|---|
[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | |||
[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | |||
Dispatched by this NativeMenu object immediately before the menu is to be displayed. | NativeMenu | |||
Dispatched by this NativeMenu object when one of its menu items or an item in one of its descendant submenus is selected. | NativeMenu |
items | property |
items:Array
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0 |
The array of NativeMenuItem objects in this menu.
The array is sorted in display order.
Note: This property is read-only in AIR 1.0. It became read/write in AIR 1.1.
Implementation
public function get items():Array
public function set items(value:Array):void
numItems | property |
numItems:int
[read-only] Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0 |
The number of NativeMenuItem objects in this menu.
Implementation
public function get numItems():int
parent | property |
parent:NativeMenu
[read-only] Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0 |
The parent menu.
The parent
of the root (top-level) menu object is
null
.
Implementation
public function get parent():NativeMenu
addItem | () | method |
public function addItem(item:NativeMenuItem):NativeMenuItem
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0 |
Adds a menu item at the bottom of the menu.
When creating a context menu, you can add either NativeMenuItem or ContextMenuItem objects. However, it is advisable to use only one type of object in a context menu so that all items in the menu have the same properties.
Note: Adding an item to a menu can cause an application to hang if the item's submenu is set to the menu itself (causing a circular reference).
Parameters
item:NativeMenuItem — The NativeMenuItem object to add at the bottom of the menu.
|
NativeMenuItem |
Throws
ArgumentError — If item is null .
| |
ArgumentError — If item is a member of another menu.
|
addItemAt | () | method |
public function addItemAt(item:NativeMenuItem, index:int):NativeMenuItem
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0 |
Inserts a menu item at the specified position.
Note: Adding an item to a menu can cause an application to hang if the item's submenu is set to the menu itself (causing a circular reference).
Parameters
item:NativeMenuItem — The NativeMenuItem object to insert.
| |
index:int — The (zero-based) position in menu
at which to insert the menu item.
|
NativeMenuItem |
Throws
ArgumentError — If item is null .
| |
ArgumentError — If item is a member of another menu.
| |
RangeError — If the index is outside the bounds of the menu's
items array.
|
addSubmenu | () | method |
public function addSubmenu(submenu:NativeMenu, label:String):NativeMenuItem
Runtime Versions: | AIR 1.0 |
Adds a submenu to the menu by inserting a new menu item.
Calling the addSubMenu()
method is equivalent to creating a new menu
item, adding it to the menu, and assigning a NativeMenu object to the
item's submenu
property.
Note: Adding a menu as a submenu of itself (in a circular reference) can cause an application to hang.
Parameters
submenu:NativeMenu — The NativeMenu object that defines the submenu to be added.
| |
label:String — The display label for the menu item to be added.
|
NativeMenuItem — The NativeMenuItem object created for the submenu.
|
addSubmenuAt | () | method |
public function addSubmenuAt(submenu:NativeMenu, index:int, label:String):NativeMenuItem
Runtime Versions: | AIR 1.0 |
Adds a submenu to the menu by inserting a new menu item at the specified position.
Calling the addSubMenuAt()
method 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.
Note: Adding a menu as a submenu of itself (in a circular reference) can cause an application to hang.
Parameters
submenu:NativeMenu — The NativeMenu object that defines 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.
|
NativeMenuItem — The NativeMenuItem object created for the submenu.
|
clone | () | method |
public function clone():NativeMenu
Runtime Versions: | AIR 1.0 |
Creates a copy of the menu and all items.
ReturnsNativeMenu |
containsItem | () | method |
public function containsItem(item:NativeMenuItem):Boolean
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0 |
Reports whether this menu contains the specified menu item.
Parameters
item:NativeMenuItem — The NativeMenuItem object to look up.
|
Boolean — true if item is in this menu.
|
display | () | method |
public function display(stage:Stage, stageX:Number, stageY:Number):void
Runtime Versions: | AIR 1.0 |
Pops up this menu at the specified location.
Parameters
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 | () | method |
public function getItemAt(index:int):NativeMenuItem
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0 |
Gets the menu item at the specified index.
Parameters
index:int — The (zero-based) position of the item to return.
|
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 | () | method |
public function getItemByName(name:String):NativeMenuItem
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0 |
Gets the menu item with the specified name.
Note: The name
property of menu items is not assigned by
default.
Parameters
name:String — The string to look up.
|
NativeMenuItem — The NativeMenuItem object with the specified name or
null , if no such item exists in the menu.
|
getItemIndex | () | method |
public function getItemIndex(item:NativeMenuItem):int
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0 |
Gets the position of the specified item.
Parameters
item:NativeMenuItem — The NativeMenuItem object to look up.
|
int — The (zero-based) position of the specified item in this menu
or null , if the item is not in this menu.
|
removeAllItems | () | method |
public function removeAllItems():void
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0 |
Removes all items from the menu.
removeItem | () | method |
public function removeItem(item:NativeMenuItem):NativeMenuItem
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0 |
Removes the specified menu item.
Parameters
item:NativeMenuItem — The NativeMenuItem object to remove from this menu.
|
NativeMenuItem |
Throws
RangeError — If the item is not in this menu
|
removeItemAt | () | method |
public function removeItemAt(index:int):NativeMenuItem
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0 |
Removes and returns the menu item at the specified index.
Parameters
index:int — The (zero-based) position of the item to remove.
|
NativeMenuItem — The NativeMenuItem object removed.
|
Throws
RangeError — If index is outside the bounds of
this menu's items array.
|
setItemIndex | () | method |
public function setItemIndex(item:NativeMenuItem, index:int):void
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0 |
Moves a menu item to the specified position. If the item is not already in the menu, calling this method adds the item to the menu.
Parameters
item:NativeMenuItem — The NativeMenuItem object to move.
| |
index:int — The (zero-based) position in the menu to which to move the
item .
|
Throws
RangeError — If index is outside the bounds of the
menu's items array.
|
displaying | Event |
flash.events.Event
property Event.type =
flash.events.Event.DISPLAYING
Runtime Versions: | AIR 1.0 |
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.
TheEvent.DISPLAYING
constant 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:
Property | Value |
---|---|
bubbles | false |
cancelable | false |
currentTarget | The object that is actively processing the Event object with an event listener. |
target | The object that is about to be displayed. |
select | Event |
flash.events.Event
property Event.type =
flash.events.Event.SELECT
Runtime Versions: | AIR 1.0 |
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 bubbles 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 references the selected NativeMenuItem object;
the currentTarget
property references this NativeMenu object.
Event.SELECT
constant defines the value of the type
property of a select
event object.
This event has the following properties:
Property | Value |
---|---|
bubbles | false |
cancelable | false ; there is no default behavior to cancel. |
currentTarget | The object that is actively processing the Event object with an event listener. |
target | The object on which an item has been selected. |
Fri Mar 19 2010, 02:45 AM -07:00