(AIR uniquement)
Packageflash.display
Classepublic class NativeMenu
HéritageNativeMenu Inheritance EventDispatcher Inheritance Object
Sous-classes ContextMenu

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0

La classe NativeMenu contient des méthodes et des propriétés permettant de définir des menus.

AIR prend en charge les types de menus suivants :

MenuOccurrenceTest de fonctionnalitéPris en charge surValeur par défaut fournie ?
Application NativeApplication.nativeApplication.menu NativeApplication.supportsMenu Mac OS XOui
Window NativeWindow.menu NativeWindow.supportsMenu Windows, LinuxNon
Icône du Dock NativeApplication.nativeApplication.icon.menu NativeApplication.supportsDockIcon Mac OS XOui
Icône de la zone de notification NativeApplication.nativeApplication.icon.menu NativeApplication.supportsSystemTrayIcon Windows, LinuxNon
Contexte InteractiveObject.contextMenu Toujours pris en chargeToutNon
Menu déroulantToute occurrence de NativeMenuToujours pris en chargeToutNon

Un menu peut contenir des options pour des commandes, des sous-menus et des lignes de démarcation. Des options de menu sont ajoutées à un menu à l'aide des méthodes addItem(), addItemAt(), addSubmenu() et addSubmenuAt(). L'ordre d'affichage des options d'un menu correspond à l'ordre des options dans le tableau items du menu.

Des sous-menus sont associés à leur menu parent via la propriété submenu de l'option de menu correspondant dans le menu parent. Le menu racine de fenêtres et de menus d'application doit contenir uniquement des options de sous-menu ; les options sans sous-menus risquent de ne pas s'afficher et sont contraires à l'attente de l'utilisateur pour ces types de menus.

Les menus distribuent des événements select lorsqu'un de leurs éléments de commande, ou l'un de ses sous-menu, est sélectionné. (Les éléments de sous-menu et de séparateur ne peuvent pas être sélectionnés.) La propriété target de l'objet événement fait référence à l'élément sélectionné.

Les menus distribuent des événements displaying juste avant l'affichage du menu. Vous pouvez utiliser cet événement pour mettre à jour le contenu du menu en fonction de l'état actuel de l'application.

Remarque : vous pouvez utiliser un objet NativeMenu ou ContextMenu pour définir un menu contextuel. Flash Player prend en charge la classe ContextMenu uniquement, pas la classe NativeMenu.

Voir aussi

flash.display.InteractiveObject.contextMenu
flash.display.NativeMenuItem
flash.display.NativeWindow.menu
flash.desktop.DockIcon
flash.desktop.SystemTrayIcon
flash.desktop.NativeApplication.menu
flash.desktop.NativeApplication.icon

Propriétés publiques
 PropriétéDéfini par
 Inheritedconstructor : Object
Référence à l'objet de classe ou à la fonction constructeur d'une occurrence donnée d'un objet.
Object
  AIR-only items : Array
Tableau d'objets NativeMenuItem dans ce menu.
NativeMenu
  AIR-only numItems : int
[lecture seule] Nombre d'objets NativeMenuItem dans ce menu.
NativeMenu
  AIR-only parent : NativeMenu
[lecture seule] Le menu parent.
NativeMenu
 Inheritedprototype : Object
[statique] Référence à l'objet prototype d'un objet de classe ou fonction.
Object
Méthodes publiques
 MéthodeDéfini par
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Enregistre un objet écouteur d’événement auprès d’un objet EventDispatcher afin que l’écouteur soit averti d’un événement.
EventDispatcher
  
AIR-only addItem(item:NativeMenuItem):NativeMenuItem
Ajoute un élément de menu en bas du menu.
NativeMenu
  
AIR-only addItemAt(item:NativeMenuItem, index:int):NativeMenuItem
Insère une option de menu à la position spécifiée.
NativeMenu
  
AIR-only addSubmenu(submenu:NativeMenu, label:String):NativeMenuItem
Ajoute un sous-menu au menu en insérant une nouvelle option de menu.
NativeMenu
  
AIR-only addSubmenuAt(submenu:NativeMenu, index:int, label:String):NativeMenuItem
Ajoute un sous-menu au menu en insérant une nouvelle option de menu à la position spécifiée.
NativeMenu
  
AIR-only clone():NativeMenu
Crée une copie du menu et de toutes les options.
NativeMenu
  
AIR-only containsItem(item:NativeMenuItem):Boolean
Indique si ce menu contient l'option de menu spécifiée.
NativeMenu
 Inherited
dispatchEvent(event:Event):Boolean
Distribue un événement dans le flux d'événements.
EventDispatcher
  
AIR-only display(stage:Stage, stageX:Number, stageY:Number):void
Déroule ce menu à l'emplacement spécifié.
NativeMenu
  
AIR-only getItemAt(index:int):NativeMenuItem
Obtient l'option de menu à l'index spécifié.
NativeMenu
  
AIR-only getItemByName(name:String):NativeMenuItem
Obtient l'option de menu avec le nom spécifié.
NativeMenu
  
AIR-only getItemIndex(item:NativeMenuItem):int
Obtient la position de l'option spécifiée.
NativeMenu
 Inherited
hasEventListener(type:String):Boolean
Vérifie si des écouteurs sont enregistrés auprès de l'objet EventDispatcher pour un type spécifique d'événement.
EventDispatcher
 Inherited
hasOwnProperty(name:String):Boolean
Indique si la propriété spécifiée d'un objet est définie.
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l'objet spécifié en tant que paramètre.
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
Indique si la propriété spécifiée existe et est énumérable.
Object
  
AIR-only removeAllItems():void
Supprime tous les éléments du menu.
NativeMenu
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Supprime un écouteur de l'objet EventDispatcher.
EventDispatcher
  
AIR-only removeItem(item:NativeMenuItem):NativeMenuItem
Supprime l'élément de menu spécifié.
NativeMenu
  
AIR-only removeItemAt(index:int):NativeMenuItem
Supprime et renvoie l'option de menu à l'index spécifié.
NativeMenu
  
AIR-only setItemIndex(item:NativeMenuItem, index:int):void
Déplace une option de menu vers la position spécifiée.
NativeMenu
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Définit la disponibilité d'une propriété dynamique pour les opérations en boucle.
Object
 Inherited
toString():String
Renvoie la représentation sous forme de chaîne de l'objet spécifié.
Object
 Inherited
valueOf():Object
Renvoie la valeur primitive de l'objet spécifié.
Object
 Inherited
willTrigger(type:String):Boolean
Vérifie si un écouteur d'événement est enregistré auprès de cet objet EventDispatcher ou de ses ancêtres pour le type d'événement spécifié.
EventDispatcher
Evénements
 Evénement Synthèse Défini par
 Inherited
activate
[Evénement de diffusion] Distribué lorsque l'application Flash Player obtient le focus du système d'exploitation et devient active.EventDispatcher
 Inherited
deactivate
[Evénement de diffusion] Distribué lorsque l'application Flash Player ou AIR perd le focus du système d'exploitation et devient inactive.EventDispatcher
  
AIR-only displaying
Distribué par cet objet NativeMenu immédiatement avant l'affichage du menu.NativeMenu
  
AIR-only select
Distribué par cet objet NativeMenu lorsque l'une de ses options de menu ou un élément dans l'un de ses sous-menus descendants est sélectionné.NativeMenu
Détails de la propriété
AIR-only itemspropriété
items:Array  [lecture-écriture]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0

Tableau d'objets NativeMenuItem dans ce menu.

Le tableau est trié par ordre d'affichage.

Remarque : cette propriété est disponible en lecture seule dans AIR 1.0. Elle est disponible en lecture et en écriture dans AIR 1.1.



Implémentation
    public function get items():Array
    public function set items(value:Array):void
AIR-only numItemspropriété 
numItems:int  [lecture seule]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0

Nombre d'objets NativeMenuItem dans ce menu.



Implémentation
    public function get numItems():int
AIR-only parentpropriété 
parent:NativeMenu  [lecture seule]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0

Le menu parent.

Le parent de l'objet menu racine (niveau supérieur) est null.



Implémentation
    public function get parent():NativeMenu
Détails de la méthode
AIR-only addItem()méthode
public function addItem(item:NativeMenuItem):NativeMenuItem

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0

Ajoute un élément de menu en bas du menu.

Lors de la création d'un menu contextuel, vous pouvez ajouter des objets NativeMenuItem ou ContextMenuItem. Nous vous conseillons toutefois de n'utiliser qu'un seul type d'objet dans un menu contextuel afin que tous les éléments du menu possèdent les mêmes propriétés.

Paramètres

item:NativeMenuItem — Objet NativeMenuItem à ajouter au bas du menu.

Valeur renvoyée
NativeMenuItem

Valeur émise
ArgumentError — Si item est null.
 
ArgumentError — Si item est membre d'un autre menu.
AIR-only addItemAt()méthode 
public function addItemAt(item:NativeMenuItem, index:int):NativeMenuItem

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0

Insère une option de menu à la position spécifiée.

Paramètres

item:NativeMenuItem — Objet NativeMenuItem à insérer.
 
index:int — Position (basée sur zéro) dans le menu à laquelle l'option de menu doit être insérée.

Valeur renvoyée
NativeMenuItem

Valeur émise
ArgumentError — Si item est null.
 
ArgumentError — Si item est membre d'un autre menu.
 
RangeError — Si l'index est situé hors des limites du tableau items du menu.
AIR-only addSubmenu()méthode 
public function addSubmenu(submenu:NativeMenu, label:String):NativeMenuItem

Versions du moteur d'exécution: AIR 1.0

Ajoute un sous-menu au menu en insérant une nouvelle option de menu.

Un appel à la méthode addSubMenuAt() équivaut à créer une option de menu, en l'ajoutant au menu, et en attribuant un objet NativeMenu à sa propriété submenu.

Paramètres

submenu:NativeMenu — Objet NativeMenu définissant le sous-menu à ajouter.
 
label:String — L'étiquette d'affichage pour l'option de menu à ajouter.

Valeur renvoyée
NativeMenuItem — Objet NativeMenuItem créé pour le sous-menu.
AIR-only addSubmenuAt()méthode 
public function addSubmenuAt(submenu:NativeMenu, index:int, label:String):NativeMenuItem

Versions du moteur d'exécution: AIR 1.0

Ajoute un sous-menu au menu en insérant une nouvelle option de menu à la position spécifiée.

Un appel à la méthode addSubMenuAt() équivaut à créer une option de menu, en l'insérant à la position souhaitée dans le menu, et en attribuant un objet NativeMenu à sa propriété submenu.

Paramètres

submenu:NativeMenu — Objet NativeMenu définissant le sous-menu à ajouter.
 
index:int — La position dans le tableau items de ce menu à laquelle insérer l'option de menu à ajouter.
 
label:String — L'étiquette d'affichage pour l'option de menu à ajouter.

Valeur renvoyée
NativeMenuItem — Objet NativeMenuItem créé pour le sous-menu.
AIR-only clone()méthode 
public function clone():NativeMenu

Versions du moteur d'exécution: AIR 1.0

Crée une copie du menu et de toutes les options.

Valeur renvoyée
NativeMenu
AIR-only containsItem()méthode 
public function containsItem(item:NativeMenuItem):Boolean

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0

Indique si ce menu contient l'option de menu spécifiée.

Paramètres

item:NativeMenuItem — Objet NativeMenuItem à rechercher.

Valeur renvoyée
Boolean — true si item est dans ce menu.
AIR-only display()méthode 
public function display(stage:Stage, stageX:Number, stageY:Number):void

Versions du moteur d'exécution: AIR 1.0

Déroule ce menu à l'emplacement spécifié.

Paramètres

stage:Stage — L'objet Stage sur lequel afficher ce menu.
 
stageX:Number — Nombre de pixels horizontaux, par rapport à l'origine de la scène, sur laquelle afficher ce menu.
 
stageY:Number — Nombre de pixels verticaux, par rapport à l'origine de la scène, sur laquelle afficher ce menu.

AIR-only getItemAt()méthode 
public function getItemAt(index:int):NativeMenuItem

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0

Obtient l'option de menu à l'index spécifié.

Paramètres

index:int — Position (basée sur zéro) dans l'option à renvoyer.

Valeur renvoyée
NativeMenuItem — Objet NativeMenuItem à la position spécifiée dans le menu.

Valeur émise
RangeError — Si index est situé hors des limites du tableau items du menu.
AIR-only getItemByName()méthode 
public function getItemByName(name:String):NativeMenuItem

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0

Obtient l'option de menu avec le nom spécifié.

Remarque : la propriété name des options de menu n'est pas attribuée par défaut.

Paramètres

name:String — Chaîne à rechercher.

Valeur renvoyée
NativeMenuItem — Objet NativeMenuItem avec le nom spécifié ou null, si aucune option n'existe dans le menu.
AIR-only getItemIndex()méthode 
public function getItemIndex(item:NativeMenuItem):int

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0

Obtient la position de l'option spécifiée.

Paramètres

item:NativeMenuItem — Objet NativeMenuItem à rechercher.

Valeur renvoyée
int — Position (basée sur zéro) de l'élément spécifié dans ce menu ou null, si l'élément n'est pas dans ce menu.
AIR-only removeAllItems()méthode 
public function removeAllItems():void

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0

Supprime tous les éléments du menu.

AIR-only removeItem()méthode 
public function removeItem(item:NativeMenuItem):NativeMenuItem

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0

Supprime l'élément de menu spécifié.

Paramètres

item:NativeMenuItem — Objet NativeMenuItem à supprimer de ce menu.

Valeur renvoyée
NativeMenuItem

Valeur émise
RangeError — Si item n'est pas dans ce menu
AIR-only removeItemAt()méthode 
public function removeItemAt(index:int):NativeMenuItem

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0

Supprime et renvoie l'option de menu à l'index spécifié.

Paramètres

index:int — Position (basée sur zéro) de l'élément à supprimer.

Valeur renvoyée
NativeMenuItem — Objet NativeMenuItem supprimé.

Valeur émise
RangeError — Si index est situé hors des limites du tableau items de ce menu.
AIR-only setItemIndex()méthode 
public function setItemIndex(item:NativeMenuItem, index:int):void

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0

Déplace une option de menu vers la position spécifiée.

Paramètres

item:NativeMenuItem — Objet NativeMenuItem à déplacer.
 
index:int — Position (basée sur zéro) dans le menu vers lequel déplacer item.


Valeur émise
RangeError — Si index est situé hors des limites du tableau items du menu.
Détails de l'événement
AIR-only displaying Evénement
Type d'objet événement: flash.events.Event
propriété Event.type = flash.events.Event.DISPLAYING

Versions du moteur d'exécution: AIR 1.0

Distribué par cet objet NativeMenu immédiatement avant l'affichage du menu.

Ecoutez cet événement pour mettre à jour le menu avant son affichage. Les événements d'affichage sont distribués également par les options dans un menu.

La constante Event.DISPLAYING définit la valeur de la propriété type d'un objet événement displaying.

Remarque : cet événement ne passe pas par une « phase de capture » et est distribué directement à la cible, que cette dernière soit dans la liste d'affichage ou non.

Les propriétés de cet événement sont les suivantes :

PropriétéValeur
bubbles false
cancelable false
currentTarget L'objet qui traite activement l'objet Event avec un écouteur d'événements.
target Objet sur le point d'être affiché.
AIR-only select Evénement  
Type d'objet événement: flash.events.Event
propriété Event.type = flash.events.Event.SELECT

Versions du moteur d'exécution: AIR 1.0

Distribué par cet objet NativeMenu lorsque l'une de ses options de menu ou un élément dans l'un de ses sous-menus descendants est sélectionné.

Un événement select effectue une propagation vers le haut de cette option de menu vers le menu qu'il contient jusqu'à l'objet menu racine en passant par la chaîne de menu parent. La propriété target de l'objet event fait référence à l'objet NativeMenuItem sélectionné ; la propriété currentTarget fait référence à cet objet NativeMenu.

La constante Event.SELECT définit la valeur de la propriété type d'un objet événement select.

Les propriétés de cet événement sont les suivantes :

PropriétéValeur
bubbles false
cancelable false ; il n'existe aucun comportement par défaut à annuler.
currentTarget L'objet qui traite activement l'objet Event avec un écouteur d'événements.
target Objet sur lequel un élément a été sélectionné.



© 2004-2008 Adobe Systems Incorporated. All rights reserved.
Thu Jan 8 2009, 03:00 AM -08:00