NativeMenuItem

Package	flash.display
Classe	public class NativeMenuItem
Héritage	NativeMenuItem EventDispatcher Object
Sous-classes	ContextMenuItem

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

AIR 1.0

La classe NativeMenuItem représente une seule option dans un menu.

Une option de menu peut être une commande, un sous-menu ou une ligne de démarcation :

Pour créer un élément de commande, appelez le constructeur NativeMenuItem en transmettant une chaîne pour l’étiquette et false pour le paramètre isSeparator.
Pour créer un sous-menu, créez un élément de commande pour le menu parent et attribuez l’objet NativeMenu du sous-menu à la propriété submenu de l’élément. Vous pouvez également appeler la méthode addSubmenu() de l’objet NativeMenu parent pour créer l’élément et définir la propriété submenu en même temps.
Pour créer un séparateur, appelez le constructeur NativeMenuItem en transmettant une chaîne vide pour l’étiquette et true pour le paramètre isSeparator.

Ecoutez les événements select sur un élément ou un menu parent pour détecter le moment où une commande de menu est sélectionnée. Ni les sous-menus ni les séparateurs ne distribuent d’événements select. Ecoutez les événements preparing pour savoir quand une option de menu est sur le point d’être affichée ou activée par l’intermédiaire d’un équivalent de touche.

Plus d’exemples

Utilisation des menus

Eléments de l’API associés

flash.display.NativeMenu
flash.display.NativeMenu.addSubmenu()

Propriétés publiques

Masquer les propriétés publiques héritées

Afficher les propriétés publiques héritées

	Propriété		Défini par
		checked : Boolean Contrôle si cette option de menu affiche une case à cocher.	NativeMenuItem
		constructor : Object Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.	Object
		data : Object Un objet de données arbitraire associé à cette option de menu.	NativeMenuItem
		enabled : Boolean Contrôle si cette option de menu est activée.	NativeMenuItem
		isSeparator : Boolean [lecture seule] Indique si cet élément est une ligne de démarcation de menu.	NativeMenuItem
		keyEquivalent : String L’équivalent de touche de cette option de menu.	NativeMenuItem
		keyEquivalentModifiers : Array Le tableau de codes de touche pour les modificateurs des équivalents de touche.	NativeMenuItem
		label : String La chaîne d’affichage de cette option de menu.	NativeMenuItem
		menu : NativeMenu [lecture seule] Le menu qui contient cette option.	NativeMenuItem
		mnemonicIndex : int La position du caractère mnémonique dans l’étiquette de l’option de menu.	NativeMenuItem
		name : String Le nom de cette option de menu.	NativeMenuItem
		submenu : NativeMenu Le sous-menu associé à cette option de menu.	NativeMenuItem

Méthodes publiques

Masquer les méthodes publiques héritées

Afficher les méthodes publiques héritées

	Méthode		Défini par
		NativeMenuItem(label:String = "", isSeparator:Boolean = false) Crée un nouvel objet NativeMenuItem.	NativeMenuItem
		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
		clone():NativeMenuItem Crée une copie de l’objet NativeMenuItem.	NativeMenuItem
		dispatchEvent(event:Event):Boolean Distribue un événement dans le flux d’événements.	EventDispatcher
		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
		hasOwnProperty(name:String):Boolean Indique si la propriété spécifiée d’un objet est définie.	Object
		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
		propertyIsEnumerable(name:String):Boolean Indique si la propriété spécifiée existe et est énumérable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Supprime un écouteur de l’objet EventDispatcher.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.	Object
		toLocaleString():String Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur.	Object
		toString():String [override] Renvoie une chaîne répertoriant toutes les propriétés de l’objet NativeMenuItem.	NativeMenuItem
		valueOf():Object Renvoie la valeur primitive de l’objet spécifié.	Object
		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

Cliquez pour plus d’informations sur les événements

Masquer les événements hérités

Afficher les événements hérités

	Synthèse	Défini par
activate	[Evénement de diffusion] Distribué lorsque l’application Flash Player obtient le focus du système d’exploitation et devient active.	EventDispatcher
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
displaying	Distribué par cet objet NativeMenuItem immédiatement avant l’affichage du menu contenant l’option.	NativeMenuItem
preparing	Distribué par cet objet NativeMenuItem lorsque l’utilisateur appuie sur son équivalent de touche et immédiatement avant l’affichage du menu le contenant.	NativeMenuItem
select	Distribué chaque fois que l’utilisateur sélectionne une option de menu.	NativeMenuItem

Détails de la propriété

checked

propriété

checked:Boolean

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

AIR 1.0

Contrôle si cette option de menu affiche une case à cocher.

Implémentation
public function get checked():Boolean
public function set checked(value:Boolean):void

data

propriété

data:Object

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

AIR 1.0

Un objet de données arbitraire associé à cette option de menu.

Vous pouvez attribuer n’importe quel objet à cette propriété. L’objet affecté n’est pas utilisé par le système de menu mais est disponible pour le code de gestion des événements (via la propriété target de l’objet event). Par défaut, la valeur de cette propriété est null.

Implémentation
public function get data():Object
public function set data(value:Object):void

enabled

propriété

enabled:Boolean

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

AIR 1.0

Contrôle si cette option de menu est activée.

Implémentation
public function get enabled():Boolean
public function set enabled(value:Boolean):void

isSeparator

propriété

isSeparator:Boolean [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

AIR 1.0

Indique si cet élément est une ligne de démarcation de menu.

Créez une ligne de démarcation en définissant le paramètre isSeparator dans le constructeur NativeMenuItem sur true.

Implémentation
public function get isSeparator():Boolean

keyEquivalent

propriété

keyEquivalent:String

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

AIR 1.0

L’équivalent de touche de cette option de menu.

Définissez keyEquivalent avec une minuscule pour affecter un raccourci sans touche de modification Maj. Définissez une lettre majuscule pour affecter un raccourci avec la touche de modification Maj.

Par défaut, un modificateur d’équivalent de touche (Ctrl sous Windows ou Linux et Commande sous Mac OS X) est inclus dans l’équivalent de touche. Si vous souhaitez que l’équivalent de touche soit une touche sans modificateur, définissez la propriété keyEquivalentModifiers sur un tableau vide.

Implémentation
public function get keyEquivalent():String
public function set keyEquivalent(value:String):void

keyEquivalentModifiers

propriété

keyEquivalentModifiers:Array

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

AIR 1.0

Le tableau de codes de touche pour les modificateurs des équivalents de touche.

Utilisez les constantes définies dans la classe Keyboard pour spécifier les codes de touche de modificateur. Les touches de modificateur valides comprennent :

Keyboard.ALTERNATE
Keyboard.COMMAND
Keyboard.CONTROL

Si vous n’affectez aucun modificateur, la touche Keyboard.CONTROL est affectée par défaut sous Windows ou Linux et la touche Keyboard.COMMAND est affectée sous Mac OS X. Si vous ne souhaitez pas que l’équivalent de touche comprenne ces modificateurs, définissez cette propriété sur un tableau vide.

Si vous affectez une lettre majuscule à la propriété keyEquivalent, la touche Maj est automatiquement utilisée comme modificateur. La définition de keyEquivalentModifier sur un tableau vide ne supprime pas la touche Maj comme modificateur.

Implémentation
public function get keyEquivalentModifiers():Array
public function set keyEquivalentModifiers(value:Array):void

Eléments de l’API associés

flash.ui.Keyboard

label

propriété

label:String

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

AIR 1.0

La chaîne d’affichage de cette option de menu.

Implémentation
public function get label():String
public function set label(value:String):void

mnemonicIndex

propriété

mnemonicIndex:int

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

AIR 1.0

La position du caractère mnémonique dans l’étiquette de l’option de menu.

Le caractère à la position spécifiée devient le caractère mnémonique pour l’option de menu. L’index est de base zéro, donc le premier caractère a un index de 0.

Cette propriété est ignorée sur les systèmes d’exploitation qui n’utilisent pas de mnémoniques de menu.

Implémentation
public function get mnemonicIndex():int
public function set mnemonicIndex(value:int):void

name

propriété

name:String

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

AIR 1.0

Le nom de cette option de menu.

La valeur de nom n’est pas affichée et peut être utilisée comme identifiant indépendant des paramètres régionaux. Le nom n’est pas affecté automatiquement.

Implémentation
public function get name():String
public function set name(value:String):void

submenu

propriété

submenu:NativeMenu

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

AIR 1.0

Le sous-menu associé à cette option de menu.

L’attribution d’un objet NativeMenu à cette propriété change l’aspect et le comportement de l’option de menu. Un élément de sous-menu affiche l’icône du sous-menu et ne déclenche plus d’événements select.

Remarque : l’ajout d’un menu comme sous-menu de lui-même (dans une référence circulaire) peut provoquer l’arrêt intempestif d’une application.

Implémentation
public function get submenu():NativeMenu
public function set submenu(value:NativeMenu):void

Eléments de l’API associés

flash.display.NativeMenu.addSubmenu()

Détails du constructeur

()

Constructeur

public function NativeMenuItem(label:String = "", isSeparator:Boolean = false)

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

AIR 1.0

Crée un nouvel objet NativeMenuItem.

Pour créer une commande de menu, définissez le paramètre label sur une chaîne contenant l’étiquette d’affichage et définissez isSeparator sur false.

Pour créer une commande de sous-menu, créez un élément de commande, puis affectez l’objet NativeMenu du sous-menu à la propriété submenu de cet élément. Ajoutez l’élément au menu parent.

Pour créer un séparateur, définissez le paramètre label sur une chaîne vide et définissez isSeparator sur true.

Ajoutez et supprimez des éléments d’un menu à l’aide des méthodes NativeMenu addItem() et removeItem().

Paramètres

	`label:String` (default = "") — L’étiquette d’affichage pour l’élément ou une chaîne vide pour des séparateurs.

	`isSeparator:Boolean` (default = `false`) — Réglez sur `true` pour créer un séparateur ; autrement, réglez sur `false`.

Eléments de l’API associés

flash.display.NativeMenu.addSubmenu()

Détails de la méthode

clone

()

méthode

public function clone():NativeMenuItem

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

AIR 1.0

Crée une copie de l’objet NativeMenuItem.

Valeur renvoyée

NativeMenuItem

toString

()

méthode

override public function toString():String

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

AIR 1.0

Renvoie une chaîne répertoriant toutes les propriétés de l’objet NativeMenuItem.

Valeur renvoyée

String — Chaîne répertoriant toutes les propriétés de l’objet Event.

Détails de l’événement

displaying

Evénement

Type d’objet d’événement: flash.events.Event
propriété Event.type = flash.events.Event.DISPLAYING

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

AIR 1.0

Distribué par cet objet NativeMenuItem immédiatement avant l’affichage du menu contenant l’option.

L’événement preparing prime sur l’événement displaying et offre des fonctionnalités supplémentaires. Ecoutez soit l’événement preparing soit l’événement displaying, mais pas les deux.

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é.

preparing

Evénement

Type d’objet d’événement: flash.events.Event
propriété Event.type = flash.events.Event.PREPARING

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

AIR 2.6

Distribué par cet objet NativeMenuItem lorsque l’utilisateur appuie sur son équivalent de touche et immédiatement avant l’affichage du menu le contenant.

Ecoutez cet événement pour mettre à jour l’option avant l’affichage du menu la contenant ou lorsque l’utilisateur appuie sur son équivalent de touche. L’événement preparing est distribué avant l’évaluation complète de l’équivalent de touche. Vous pouvez activer, désactiver ou supprimer l’option du menu dans le gestionnaire de l’événement preparing ; ces modifications prendront effet lors du traitement de l’équivalent de touche. Par exemple, si vous supprimez ou désactiver cette option de menu, la séquence d’événements est effectivement annulée et aucun événement select n’est distribué. Un événement preparing est également distribué par les autres options d’un menu.

La constante Event.PREPARING définit la valeur de la propriété type d’un objet d’événement preparing.

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`	Objet ayant distribué l’événement this.
`target`	Objet ayant distribué l’événement this.

select

Evénement

Type d’objet d’événement: flash.events.Event
propriété Event.type = flash.events.Event.SELECT

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

AIR 1.0

Distribué chaque fois que l’utilisateur sélectionne une option de menu.

Un événement select effectue une propagationt de cet élément 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 à cet objet NativeMenuItem ; la propriété currentTarget fait référence à l’objet dispatching (cet objet NativeMenuItem ou un ancien objet NativeMenu).

Remarque : si la fenêtre contenant le menu est en mode plein écran (stage.displayState == StageDisplayState.FULL_SCREEN), l’objet NativeMenuItem ne distribue pas d’événement select lorsque l’utilisateur entre un équivalent clavier pour une option de menu.

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é.

Informations juridiques | Politique de confidentialité en ligne

NativeMenuItem - AS3

Packagesx

Eléments du langage

Annexes

Package flash.display

checked

data

enabled

isSeparator

keyEquivalent

keyEquivalentModifiers

label

menu

mnemonicIndex

name

submenu

NativeMenuItem

clone

toString

displaying

preparing

select