| Package | flash.display |
| Class | public class NativeMenuItem |
| Inheritance | NativeMenuItem  EventDispatcher Object |
| Subclasses | ContextMenuItem |
A menu item can be a command, a submenu, or a separator line:
false for the isSeparator
parameter.submenu
property. You can also call the addSubmenu() method of the
parent NativeMenu object to create the item and set the submenu
property at the same time.true for the isSeparator
parameter.Listen for select events on an item or a parent menu to detect when a
menu command is selected. Neither submenus nor separators dispatch
select events. Listen for displaying events to determine when
a menu item is about to be displayed.
See also
| Property | Defined By | ||
|---|---|---|---|
 checked : Boolean
Controls whether this menu item displays a checkmark.
| NativeMenuItem | ||
 | constructor : Object
A reference to the class object or constructor function for a given object instance.
| Object | |
| data : Object
An arbitrary data object associated with this menu item.
| NativeMenuItem | ||
| enabled : Boolean
Controls whether this menu item is enabled.
| NativeMenuItem | ||
| isSeparator : Boolean
[read-only]
Reports whether this item is a menu separator line.
| NativeMenuItem | ||
| keyEquivalent : String
The key equivalent for this menu item.
| NativeMenuItem | ||
| keyEquivalentModifiers : Array
The array of key codes for the key equivalent modifiers.
| NativeMenuItem | ||
| label : String
The display string of this menu item.
| NativeMenuItem | ||
| menu : NativeMenu
[read-only]
The menu that contains this item.
| NativeMenuItem | ||
| mnemonicIndex : int
The position of the mnemonic character in the menu item label.
| NativeMenuItem | ||
| name : String
The name of this menu item.
| NativeMenuItem | ||
| prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
| submenu : NativeMenu
The submenu associated with this menu item.
| NativeMenuItem | ||
| Method | Defined By | ||
|---|---|---|---|
|
Creates a new NativeMenuItem object.
| NativeMenuItem | ||
|
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 | |
|
Creates a copy of the NativeMenuItem object.
| NativeMenuItem | ||
|
Dispatches an event into the event flow.
| EventDispatcher | |
|
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 a listener from the EventDispatcher object.
| EventDispatcher | |
|
Sets the availability of a dynamic property for loop operations.
| Object | |
|
Returns a string containing all the properties of the NativeMenuItem object.
| NativeMenuItem | ||
|
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 | ||
|---|---|---|---|---|
| Dispatched when Flash Player or an AIR application gains operating system focus and becomes active. | EventDispatcher | ||
| Dispatched when Flash Player or an AIR application loses operating system focus and is becoming inactive. | EventDispatcher | ||
| Dispatched by this NativeMenuItem object immediately before the menu containing the item is displayed. | NativeMenuItem | |||
| Dispatched whenever a menu item is selected by the user. | NativeMenuItem | |||
| checked | property |
Hide Inherited Public Properties
Show Inherited Public Propertieschecked:Boolean [read-write] Controls whether this menu item displays a checkmark.
public function get checked():Boolean
public function set checked(value:Boolean):void
| data | property |
data:Object [read-write] An arbitrary data object associated with this menu item.
You can assign any object to this property. The assigned object is
not used by the menu system, but is available to event handling code
(through the target property of the event object).
By default, the value of this property is null.
public function get data():Object
public function set data(value:Object):void
| enabled | property |
enabled:Boolean [read-write] Controls whether this menu item is enabled.
public function get enabled():Boolean
public function set enabled(value:Boolean):void
| isSeparator | property |
isSeparator:Boolean [read-only] Reports whether this item is a menu separator line.
Create a separator line by setting the isSeparator
parameter in the NativeMenuItem constructor to true.
public function get isSeparator():Boolean
| keyEquivalent | property |
keyEquivalent:String [read-write] The key equivalent for this menu item.
Set the keyEquivalent with a lowercase letter to assign
a shortcut without a Shift-key modifier. Set with an uppercase letter
to assign a shortcut with the Shift-key modifier.
By default, a key equivalent modifier (Control on Windows and
Command on Mac OS X) is included as part of the key equivalent.
If you want the key equivalent to be a key with no modifier,
set the keyEquivalentModifiers property to an
empty array.
public function get keyEquivalent():String
public function set keyEquivalent(value:String):void
| keyEquivalentModifiers | property |
keyEquivalentModifiers:Array [read-write] The array of key codes for the key equivalent modifiers.
Use the constants defined in the Keyboard class to specify the modifier key codes. Valid modifer keys include:
Keyboard.ALTERNATEKeyboard.COMMANDKeyboard.CONTROLIf you do not assign any modifiers, then by default the Keyboard.CONTROL key is
assigned on Windows and the Keyboard.COMMAND key is assigned on Mac OS X. If you
do not want the key equivalent to include these modifiers, set this property to an empty array.
If you assign an uppercase letter to the keyEquivalent property, the Shift key is
used as a modifier automatically. Setting keyEquivalentModifier to an empty array
does not remove the Shift key as a modifier.
public function get keyEquivalentModifiers():Array
public function set keyEquivalentModifiers(value:Array):void
See also
| label | property |
label:String [read-write] The display string of this menu item.
public function get label():String
public function set label(value:String):void
| menu | property |
menu:NativeMenu [read-only] The menu that contains this item.
public function get menu():NativeMenu
| mnemonicIndex | property |
mnemonicIndex:int [read-write] The position of the mnemonic character in the menu item label.
The character at the specified position is the mnemonic character for the menu item. The index is zero-based, so the first character has an index of 0.
This property is ignored on operating systems that do not use menu mnemonics.
public function get mnemonicIndex():int
public function set mnemonicIndex(value:int):void
| name | property |
name:String [read-write] The name of this menu item.
The name value is not displayed and can be used as a locale-independent identifier. A name is not assigned automatically.
public function get name():String
public function set name(value:String):void
| submenu | property |
submenu:NativeMenu [read-write] The submenu associated with this menu item.
Assigning a NativeMenu object to this property changes the appearance and behavior of the menu item. A submenu item displays the submenu icon and no longer dispatches select events.
public function get submenu():NativeMenu
public function set submenu(value:NativeMenu):void
See also
| NativeMenuItem | () | Constructor |
public function NativeMenuItem(label:String = "", isSeparator:Boolean = false)
Creates a new NativeMenuItem object.
To create a menu command, set the label parameter to a
string containing the display label and set isSeparator
to false.
To create a submenu command, create a command item and then assign the
NativeMenu object for the submenu to the item's submenu
property. Add the item to the parent menu.
To create a separator, set the label parameter to an empty
string and set isSeparator to true.
Add and remove items from a menu using the NativeMenu addItem()
and removeItem() methods.
label:String (default = " |
|
isSeparator:Boolean (default = false)true to create a separator; set to
false otherwise.
|
See also
| clone | () | method |
public function clone():NativeMenuItem
Creates a copy of the NativeMenuItem object.
ReturnsNativeMenuItem |
| toString | () | method |
public override function toString():String
Returns a string containing all the properties of the NativeMenuItem object.
ReturnsString — A string containing all the properties of the Event object.
|
| displaying | Event |
flash.events.Event
flash.events.Event.DISPLAYING
Dispatched by this NativeMenuItem object immediately before the menu containing the item is displayed.
The target property of the event object references the
NativeMenu object containing this NativeMenuItem object; the
currentTarget property references this NativeMenuItem.
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
flash.events.Event.SELECT
Dispatched whenever a menu item is selected by the user.
A select event bubbles from this 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 this NativeMenuItem object;
the currentTarget property references the dispatching
object (either this NativeMenuItem or an ancestral NativeMenu object).
Note: If the window containing the menu is in fullscreen mode,
the NativeMenuItem object does not dispatch a select event
when the user enters a keyboard equivalent for a menu item. You can, however, listen
for a keyDown event dispatched by the stage property of the
NativeWindow 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. |