Guide de référence ActionScript® 3.0 pour la plate-forme Adobe® Flash®
Accueil  |  Masquer la liste des packages et des classes |  Packages  |  Classes  |  Nouveautés  |  Index  |  Annexes  |  Pourquoi existe-t-il du contenu en anglais ?
Filtres : Récupération des données du serveur...
Récupération des données du serveur...
flash.ui 

ContextMenuItem  - AS3

Packageflash.ui
Classepublic final class ContextMenuItem
HéritageContextMenuItem Inheritance NativeMenuItem Inheritance EventDispatcher Inheritance Object

Version du langage: ActionScript 3.0
Versions du moteur d’exécution: AIR 1.0, Flash Player 9

La classe ContextMenuItem représente un élément dans le menu contextuel. Chaque objet ContextMenuItem est doté d’une légende (texte) qui s’affiche dans le menu contextuel. Pour intégrer un nouvel élément à un menu contextuel, il vous suffit de l’ajouter au tableau customItems d’un objet ContextMenu.

Les propriétés de la classe ContextMenuItem vous permettent d’activer ou de désactiver des éléments de menu, mais aussi de les afficher ou de les masquer.

Vous écrivez un gestionnaire d’événements destiné à l’événement menuItemSelect pour ajouter une fonctionnalité à l’élément de menu lorsque l’utilisateur le sélectionne.

Les éléments de menu personnalisés s’affichent dans la partie supérieure du menu contextuel, au-dessus des éléments intégrés. Une barre de séparation sépare toujours les éléments de menu personnalisés des éléments intégrés. Dans AIR, il n’existe aucun élément intégré et les restrictions suivantes ne s’appliquent pas au contenu du sandbox de l’application AIR.

Restrictions :

  • Vous ne pouvez pas ajouter plus de 15 éléments personnalisés à un menu contextuel.
  • Les légendes doivent comporter au moins un caractère visible.
  • Les caractères de contrôle, de nouvelle ligne et autres espaces blancs ne sont pas pris en compte.
  • Aucune légende ne peut comporter plus de 100 caractères.
  • Les éléments identiques à un élément de menu intégré, ou à un autre élément personnalisé, sont ignorés, que l’élément correspondant soit visible ou non. Les éléments de menu sont comparés aux éléments intégrés ou personnalisés existants sans respecter la casse, la ponctuation ou les espaces blancs.
  • Les légendes suivantes sont exclues, mais elles peuvent être utilisées en conjonction avec d’autres mots pour créer une légende personnalisée (ainsi, « Paste » (Coller) n’est pas autorisée, mais la légende « Paste tastes great » (Coller au texte) est permise) :
     Save
     Zoom In
     Zoom Out
     100%
     Show All
     Quality
     Play
     Loop
     Rewind
     Forward
     Back
     Movie not loaded
     About
     Print
     Show Redraw Regions
     Debugger
     Undo
     Cut
     Copy
     Paste
     Delete
     Select All
     Open
     Open in new window
     Copy link
     
  • Les termes suivants ne doivent en aucun cas apparaître dans une légende personnalisée, seuls ou avec d’autres mots :
     Adobe
     Macromedia
     Flash Player
     Settings
     

Remarque : lorsque le lecteur s’exécute sur un système qui n’est pas en anglais, les chaînes sont comparées à la liste anglaise et aux traductions équivalentes.

Consulter les exemples

Plus d’exemples

Eléments de l’API associés



Propriétés publiques
 PropriétéDéfini par
  caption : String
Spécifie la légende (texte) de l’élément de menu qui s’affiche dans le menu contextuel.
ContextMenuItem
 Inherited    checked : Boolean
Contrôle si cette option de menu affiche une case à cocher.
NativeMenuItem
 Inheritedconstructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.
Object
 Inherited    data : Object
Un objet de données arbitraire associé à cette option de menu.
NativeMenuItem
 Inherited    enabled : Boolean
Contrôle si cette option de menu est activée.
NativeMenuItem
 Inherited    isSeparator : Boolean
[lecture seule] Indique si cet élément est une ligne de démarcation de menu.
NativeMenuItem
 Inherited    keyEquivalent : String
L’équivalent de touche de cette option de menu.
NativeMenuItem
 Inherited    keyEquivalentModifiers : Array
Le tableau de codes de touche pour les modificateurs des équivalents de touche.
NativeMenuItem
 Inherited    label : String
La chaîne d’affichage de cette option de menu.
NativeMenuItem
 Inherited    menu : NativeMenu
[lecture seule] Le menu qui contient cette option.
NativeMenuItem
 Inherited    mnemonicIndex : int
La position du caractère mnémonique dans l’étiquette de l’option de menu.
NativeMenuItem
 Inherited    name : String
Le nom de cette option de menu.
NativeMenuItem
  separatorBefore : Boolean
Indique si une barre de séparation doit apparaître au-dessus de l’élément de menu spécifié.
ContextMenuItem
 Inherited    submenu : NativeMenu
Le sous-menu associé à cette option de menu.
NativeMenuItem
  visible : Boolean
Indique si l’élément de menu spécifié est visible lorsque le menu contextuel de Flash Player s’affiche.
ContextMenuItem
Méthodes publiques
 MéthodeDéfini par
  
ContextMenuItem(caption:String, separatorBefore:Boolean = false, enabled:Boolean = true, visible:Boolean = true)
Crée un objet ContextMenuItem pouvant être ajouté au tableau ContextMenu.customItems.
ContextMenuItem
 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
  
[override] Crée une copie de l’objet NativeMenuItem.
ContextMenuItem
 Inherited
Distribue un événement dans le flux d’événements.
EventDispatcher
 Inherited
Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement.
EventDispatcher
 Inherited
Indique si la propriété spécifiée d’un objet est définie.
Object
 Inherited
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
Indique si la propriété spécifiée existe et est énumérable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Supprime un écouteur de l’objet EventDispatcher.
EventDispatcher
 Inherited
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.
Object
  
[statique]
ContextMenuItem
  
[statique]
ContextMenuItem
  
[statique]
ContextMenuItem
  
[statique]
ContextMenuItem
  
[statique]
ContextMenuItem
  
[statique]
ContextMenuItem
  
[statique]
ContextMenuItem
 Inherited
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur.
Object
 Inherited
    toString():String
[override] Renvoie une chaîne répertoriant toutes les propriétés de l’objet NativeMenuItem.
NativeMenuItem
 Inherited
Renvoie la valeur primitive de l’objet spécifié.
Object
 Inherited
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[Evénement de diffusion] Distribué lorsque l’application Flash Player obtient le focus du système d’exploitation et devient active.EventDispatcher
 Inherited[Evénement de diffusion] Distribué lorsque l’application Flash Player ou AIR perd le focus du système d’exploitation et devient inactive.EventDispatcher
 Inherited
    displaying
Distribué par cet objet NativeMenuItem immédiatement avant l’affichage du menu contenant l’option.NativeMenuItem
  Distribué lorsqu’un utilisateur sélectionne un élément dans un menu contextuel.ContextMenuItem
 Inherited
    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
 Inherited
    select
Distribué chaque fois que l’utilisateur sélectionne une option de menu.NativeMenuItem
Détails de la propriété

caption

propriété
caption:String

Version du langage: ActionScript 3.0
Versions du moteur d’exécution: AIR 1.0, Flash Player 9

Spécifie la légende (texte) de l’élément de menu qui s’affiche dans le menu contextuel. Pour plus d’informations sur les restrictions liées à la valeur caption, voir la présentation de la classe ContextMenuItem.



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

separatorBefore

propriété 
separatorBefore:Boolean

Version du langage: ActionScript 3.0
Versions du moteur d’exécution: AIR 1.0, Flash Player 9

Indique si une barre de séparation doit apparaître au-dessus de l’élément de menu spécifié.

Remarque : une barre de séparation apparaît toujours entre les éléments de menu personnalisés et intégrés.

La valeur par défaut est false.



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

visible

propriété 
visible:Boolean

Version du langage: ActionScript 3.0
Versions du moteur d’exécution: AIR 1.0, Flash Player 9

Indique si l’élément de menu spécifié est visible lorsque le menu contextuel de Flash Player s’affiche.

La valeur par défaut est true.



Implémentation
    public function get visible():Boolean
    public function set visible(value:Boolean):void
Détails du constructeur

ContextMenuItem

()Constructeur
public function ContextMenuItem(caption:String, separatorBefore:Boolean = false, enabled:Boolean = true, visible:Boolean = true)

Version du langage: ActionScript 3.0
Versions du moteur d’exécution: AIR 1.0, Flash Player 9

Crée un objet ContextMenuItem pouvant être ajouté au tableau ContextMenu.customItems.

Paramètres
caption:String — Spécifie le texte associé à l’élément de menu. Pour plus d’informations sur les restrictions liées à la valeur caption, voir la présentation de la classe ContextMenuItem.
 
separatorBefore:Boolean (default = false) — Spécifie si une barre de séparation doit apparaître au-dessus de l’élément dans le menu contextuel. La valeur par défaut est false.
 
enabled:Boolean (default = true) — Indique si l’élément de menu est activé ou désactivé dans le menu contextuel. La valeur par défaut est true (activé). Ce paramètre est facultatif.
 
visible:Boolean (default = true) — Indique si l’élément de menu est visible ou invisible. La valeur par défaut est true (visible).
Détails de la méthode

clone

()méthode
override public function clone():NativeMenuItem

Crée une copie de l’objet NativeMenuItem.

Valeur renvoyée
NativeMenuItem

systemClearMenuItem

()méthode 
public static function systemClearMenuItem():ContextMenuItem

Valeur renvoyée
ContextMenuItem

systemCopyLinkMenuItem

()méthode 
public static function systemCopyLinkMenuItem():ContextMenuItem

Valeur renvoyée
ContextMenuItem

systemCopyMenuItem

()méthode 
public static function systemCopyMenuItem():ContextMenuItem

Valeur renvoyée
ContextMenuItem

systemCutMenuItem

()méthode 
public static function systemCutMenuItem():ContextMenuItem

Valeur renvoyée
ContextMenuItem

systemOpenLinkMenuItem

()méthode 
public static function systemOpenLinkMenuItem():ContextMenuItem

Valeur renvoyée
ContextMenuItem

systemPasteMenuItem

()méthode 
public static function systemPasteMenuItem():ContextMenuItem

Valeur renvoyée
ContextMenuItem

systemSelectAllMenuItem

()méthode 
public static function systemSelectAllMenuItem():ContextMenuItem

Valeur renvoyée
ContextMenuItem
Détails de l’événement

menuItemSelect

Evénement
Type d’objet d’événement: flash.events.ContextMenuEvent
propriété ContextMenuEvent.type = flash.events.ContextMenuEvent.MENU_ITEM_SELECT

Version du langage: ActionScript 3.0
Versions du moteur d’exécution: AIR 1.0, Flash Player 9

Distribué lorsqu’un utilisateur sélectionne un élément dans un menu contextuel. L’utilisateur génère le menu contextuel en cliquant avec le bouton secondaire de son périphérique de pointage.

Définit la valeur de la propriété type d’un objet événement menuItemSelect.

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

PropriétéValeur
bubblesfalse
cancelablefalse ; il n’existe aucun comportement par défaut à annuler.
contextMenuOwnerObjet de la liste d’affichage auquel le menu est associé.
currentTargetL’objet qui traite activement l’objet Event avec un écouteur d’événements.
mouseTargetObjet de la liste d’affichage sur lequel l’utilisateur a cliqué du bouton droit de la souris pour afficher le menu contextuel.
targetObjet ContextMenuItem qui a été sélectionné. La cible ne correspond pas toujours à l’objet de la liste d’affichage qui est associé à l’écouteur d’événement. Utilisez la propriété currentTarget pour accéder à l’objet de la liste d’affichage qui traite actuellement l’événement.
ContextMenuItemExample.as

L’exemple suivant utilise la classe ContextMenuBuiltInItemsExample pour supprimer les éléments apparaissant par défaut dans le menu contextuel de la scène et ajouter un nouvel élément au menu. Cette opération s’accomplit de la façon suivante :
  1. Une propriété myContextMenu est déclarée, puis attribuée à un nouvel objet ContextMenu.
  2. La méthode removeDefaultItems() est appelée, ce qui supprime tous les éléments de menu contextuel intégrés sauf Print.
  3. La méthode addCustomMenuItems() est appelée, ce qui a pour effet de placer un élément de menu appelé Hello World dans le tableau customItems par le biais de la méthode push() de Array.
  4. L’élément Hello World est ensuite ajouté à la liste des éléments du menu contextuel de la scène.
  5. Un objet TextField contenant le texte « Right Click Here » (Cliquez ici du bouton droit) est ajouté à la scène.
package {
    import flash.ui.ContextMenu;
    import flash.ui.ContextMenuItem;
    import flash.ui.ContextMenuBuiltInItems;
    import flash.display.Sprite;
    import flash.text.TextField;

    public class ContextMenuItemExample extends Sprite {
        private var myContextMenu:ContextMenu;

        public function ContextMenuItemExample() {
            myContextMenu = new ContextMenu();
            removeDefaultItems();
            addCustomMenuItems();
            this.contextMenu = myContextMenu;
            addChild(createLabel());
        }

        private function removeDefaultItems():void {
            myContextMenu.hideBuiltInItems();

            var defaultItems:ContextMenuBuiltInItems = myContextMenu.builtInItems;
            defaultItems.print = true;
        }

        private function addCustomMenuItems():void {
            var item:ContextMenuItem = new ContextMenuItem("Hello World");
            myContextMenu.customItems.push(item);
        }
        
        private function createLabel():TextField {
            var txtField:TextField = new TextField();
            txtField.text = "Right Click Here";
            return txtField;
        }
    }
}




[ X ]Pourquoi existe-t-il du contenu en anglais ?
Certaines parties du Guide de référence ActionScript 3.0 sont en anglais

Tout le contenu du Guide de référence ActionScript 3.0 n’a pas été traduit dans toutes les langues. Si un élément de langage n’est pas traduit, il s’affiche en anglais. Par exemple, la classe ga.controls.HelpBox n’est traduite dans aucune langue. Ainsi, dans la version française du guide de référence, la classe ga.controls.HelpBox apparaît en anglais.