Packageflash.events
Classepublic class ContextMenuEvent
HéritageContextMenuEvent Inheritance Event Inheritance Object

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

Un objet InteractiveObject distribue un objet ContextMenuEvent lorsque l'utilisateur ouvre le menu contextuel ou interagit avec lui. Il existe deux types d'événements ContextMenuEvent :

Consulter les exemples

Voir aussi

Classe ContextMenu
Classe ContextMenuItem


Propriétés publiques
 PropriétéDéfini par
 Inheritedbubbles : Boolean
[lecture seule] Indique si un événement peut se propager vers le haut (bubbling).
Event
 Inheritedcancelable : Boolean
[lecture seule] Indique si le comportement associé à l'événement peut être annulé.
Event
 Inheritedconstructor : Object
Référence à l'objet de classe ou à la fonction constructeur d'une occurrence donnée d'un objet.
Object
  contextMenuOwner : InteractiveObject
Objet de la liste d'affichage auquel le menu est associé.
ContextMenuEvent
 InheritedcurrentTarget : Object
[lecture seule] L'objet qui traite activement l'objet Event avec un écouteur d'événements.
Event
 InheritedeventPhase : uint
[lecture seule] Phase actuelle du flux d'événements.
Event
  isMouseTargetInaccessible : Boolean
Indique si la propriété mouseTarget a été définie sur null pour des raisons de sécurité.
ContextMenuEvent
  mouseTarget : InteractiveObject
Objet de la liste d'affichage sur lequel l'utilisateur a cliqué du bouton droit de la souris pour afficher le menu contextuel.
ContextMenuEvent
 Inheritedprototype : Object
[statique] Référence à l'objet prototype d'un objet de classe ou fonction.
Object
 Inheritedtarget : Object
[lecture seule] Cible de l'événement.
Event
 Inheritedtype : String
[lecture seule] Type d'événement.
Event
Méthodes publiques
 MéthodeDéfini par
  
ContextMenuEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, mouseTarget:InteractiveObject = null, contextMenuOwner:InteractiveObject = null)
Crée un objet Event contenant des informations spécifiques sur les événements de menu.
ContextMenuEvent
  
Crée une copie de l'objet ContextMenuEvent et définit la valeur de chaque propriété de sorte qu'elle corresponde à la valeur d'origine.
ContextMenuEvent
 Inherited
formatToString(className:String, ... arguments):String
Fonction d'un utilitaire permettant d'implémenter la méthode toString() dans des classes Event ActionScript 3.0 personnalisées.
Event
 Inherited
Indique si la propriété spécifiée d'un objet est définie.
Object
 Inherited
Vérifie si la méthode preventDefault() a été appelée pour l'événement.
Event
 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
Annule le comportement par défaut d'un événement si cette opération est possible.
Event
 Inherited
Indique si la propriété spécifiée existe et est énumérable.
Object
 Inherited
Définit la disponibilité d'une propriété dynamique pour les opérations en boucle.
Object
 Inherited
Bloque le traitement des écouteurs d'événement dans le nœud actuel et les suivants dans le flux d'événements.
Event
 Inherited
Bloque le traitement des écouteurs d'événement dans les nœuds qui suivent le nœud actuel dans le flux d'événements.
Event
  
Renvoie une chaîne répertoriant toutes les propriétés de l'objet ContextMenuEvent.
ContextMenuEvent
 Inherited
Renvoie la valeur primitive de l'objet spécifié.
Object
Constantes publiques
 ConstanteDéfini par
 InheritedACTIVATE : String = "activate"
[statique] La constante ACTIVATE définit la valeur de la propriété type d'un objet événement activate.
Event
 InheritedADDED : String = "added"
[statique] La constante Event.ADDED définit la valeur de la propriété type d'un objet événement added.
Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[statique] La constante Event.ADDED_TO_STAGE définit la valeur de la propriété type d'un objet d'événement addedToStage.
Event
 InheritedCANCEL : String = "cancel"
[statique] La constante Event.CANCEL définit la valeur de la propriété type d'un objet événement cancel.
Event
 InheritedCHANGE : String = "change"
[statique] La constante Event.CHANGE définit la valeur de la propriété type de l'objet d'événement change.
Event
 InheritedCLEAR : String = "clear"
[statique] La constante Event.CLEAR définit la valeur de la propriété type d'un objet événement clear.
Event
 InheritedCLOSE : String = "close"
[statique] La constante Event.CLOSE définit la valeur de la propriété type d'un objet événement close.
Event
 InheritedAIR-only CLOSING : String = "closing"
[statique] La constante Event.CLOSING définit la valeur de la propriété type d'un objet événement closing.
Event
 InheritedCOMPLETE : String = "complete"
[statique] La constante Event.COMPLETE définit la valeur de la propriété type d'un objet événement complete.
Event
 InheritedCONNECT : String = "connect"
[statique] La constante Event.CONNECT définit la valeur de la propriété type d'un objet événement connect.
Event
 InheritedCOPY : String = "copy"
[statique] Définit la valeur de la propriété type d'un objet d'événement copy.
Event
 InheritedCUT : String = "cut"
[statique] Définit la valeur de la propriété type d'un objet d'événement cut.
Event
 InheritedDEACTIVATE : String = "deactivate"
[statique] La constante Event.DEACTIVATE définit la valeur de la propriété type d'un objet événement deactivate.
Event
 InheritedDISPLAYING : String = "displaying"
[statique] La constante Event.DISPLAYING définit la valeur de la propriété type d'un objet événement displaying.
Event
 InheritedENTER_FRAME : String = "enterFrame"
[statique] La constante Event.ENTER_FRAME définit la valeur de la propriété type d'un objet événement enterFrame.
Event
 InheritedEXIT_FRAME : String = "exitFrame"
[statique] La constante Event.EXIT_FRAME définit la valeur de la propriété type d'un objet événement exitFrame.
Event
 InheritedAIR-only EXITING : String = "exiting"
[statique] La constante Event.EXITING définit la valeur de la propriété type de l'objet d'événement exiting.
Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[statique] La constante Event.FRAME_CONSTRUCTED définit la valeur de la propriété type d'un objet événement frameConstructed.
Event
 InheritedFULLSCREEN : String = "fullScreen"
[statique] La constante Event.FULL_SCREEN définit la valeur de la propriété type d'un objet événement fullScreen.
Event
 InheritedAIR-only HTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[statique] La constante Event.HTML_BOUNDS_CHANGE définit la valeur de la propriété type d'un objet événement htmlBoundsChange.
Event
 InheritedAIR-only HTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[statique] La constante Event.HTML_DOM_INITIALIZE définit la valeur de la propriété type d'un objet événement htmlDOMInitialize.
Event
 InheritedAIR-only HTML_RENDER : String = "htmlRender"
[statique] La constante Event.HTML_RENDER définit la valeur de la propriété type d'un objet événement htmlRender.
Event
 InheritedID3 : String = "id3"
[statique] La constante Event.ID3 définit la valeur de la propriété type d'un objet événement id3.
Event
 InheritedINIT : String = "init"
[statique] La constante Event.INIT définit la valeur de la propriété type d'un objet événement init.
Event
 InheritedAIR-only LOCATION_CHANGE : String = "locationChange"
[statique] La constante Event.LOCATION_CHANGE définit la valeur de la propriété type d'un objet événement locationChange.
Event
  MENU_ITEM_SELECT : String = "menuItemSelect"
[statique] Définit la valeur de la propriété type d'un objet événement menuItemSelect.
ContextMenuEvent
  MENU_SELECT : String = "menuSelect"
[statique] Définit la valeur de la propriété type d'un objet événement menuSelect.
ContextMenuEvent
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[statique] La constante Event.MOUSE_LEAVE définit la valeur de la propriété type d'un objet événement mouseLeave.
Event
 InheritedAIR-only NETWORK_CHANGE : String = "networkChange"
[statique] La constante Event.NETWORK_CHANGE définit la valeur de la propriété type d'un objet événement networkChange.
Event
 InheritedOPEN : String = "open"
[statique] La constante Event.OPEN définit la valeur de la propriété type d'un objet événement open.
Event
 InheritedPASTE : String = "paste"
[statique] La constante Event.PASTE définit la valeur de la propriété type d'un objet événement paste.
Event
 InheritedREMOVED : String = "removed"
[statique] La constante Event.REMOVED définit la valeur de la propriété type d'un objet événement removed.
Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[statique] La constante Event.REMOVED_FROM_STAGE définit la valeur de la propriété type d'un objet événement removedFromStage.
Event
 InheritedRENDER : String = "render"
[statique] La constante Event.RENDER définit la valeur de la propriété type d'un objet événement render.
Event
 InheritedRESIZE : String = "resize"
[statique] La constante Event.RESIZE définit la valeur de la propriété type d'un objet événement resize.
Event
 InheritedSCROLL : String = "scroll"
[statique] La constante Event.SCROLL définit la valeur de la propriété type d'un objet événement scroll.
Event
 InheritedSELECT : String = "select"
[statique] La constante Event.SELECT définit la valeur de la propriété type d'un objet événement select.
Event
 InheritedSELECT_ALL : String = "selectAll"
[statique] La constante Event.SELECT_ALL définit la valeur de la propriété type d'un objet événement selectAll.
Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[statique] La constante Event.SOUND_COMPLETE définit la valeur de la propriété type d'un objet événement soundComplete.
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[statique] La constante Event.TAB_CHILDREN_CHANGE définit la valeur de la propriété type d'un objet événement tabChildrenChange.
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[statique] La constante Event.TAB_ENABLED_CHANGE définit la valeur de la propriété type d'un objet événement tabEnabledChange.
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[statique] La constante Event.TAB_INDEX_CHANGE définit la valeur de la propriété type d'un objet événement tabIndexChange.
Event
 InheritedUNLOAD : String = "unload"
[statique] La constante Event.UNLOAD définit la valeur de la propriété type d'un objet événement unload.
Event
 InheritedAIR-only USER_IDLE : String = "userIdle"
[statique] La constante Event.USER_IDLE définit la valeur de la propriété type d'un objet événement userIdle.
Event
 InheritedAIR-only USER_PRESENT : String = "userPresent"
[statique] La constante Event.USER_PRESENT définit la valeur de la propriété type d'un objet événement userPresent.
Event
Détails de la propriété
contextMenuOwnerpropriété
contextMenuOwner:InteractiveObject  [lecture-écriture]

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

Objet de la liste d'affichage auquel le menu est associé. Il peut s'agir de la cible de la souris (mouseTarget) ou de l'un de ses ancêtres dans la liste d'affichage.



Implémentation
    public function get contextMenuOwner():InteractiveObject
    public function set contextMenuOwner(value:InteractiveObject):void
isMouseTargetInaccessiblepropriété 
isMouseTargetInaccessible:Boolean  [lecture-écriture]

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

Indique si la propriété mouseTarget a été définie sur null pour des raisons de sécurité. Si la valeur nominale de menuTarget est une référence à un DisplayObject se trouvant dans un autre sandbox de sécurité, menuTarget est défini sur null, à moins qu'il existe une autorisation dans les deux sens dans les limites de ce sandbox. L'autorisation est établie en appelant la méthode Security.allowDomain() à partir d'un fichier SWF ou en fournissant un fichier de régulation depuis le serveur d'un fichier image, puis en définissant l'indicateur LoaderContext.checkPolicyFile lors du chargement de l'image.



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

Voir aussi

mouseTargetpropriété 
mouseTarget:InteractiveObject  [lecture-écriture]

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

Objet de la liste d'affichage sur lequel l'utilisateur a cliqué du bouton droit de la souris pour afficher le menu contextuel. Il peut s'agir de l'objet de la liste d'affichage auquel le menu est associé (contextMenuOwner) ou de l'un de ses descendants dans la liste d'affichage.

La valeur de cette propriété peut être null dans deux cas : d'une part s'il n'existe aucune cible de la souris, notamment lorsque vous placez la souris sur un élément de l'arrière-plan ; d'autre part lorsqu'il existe une cible de la souris mais que celle-ci se trouve dans un sandbox de sécurité auquel vous n'avez pas accès. Pour savoir dans quel cas vous vous trouvez, utilisez la propriété isMouseTargetInaccessible().



Implémentation
    public function get mouseTarget():InteractiveObject
    public function set mouseTarget(value:InteractiveObject):void

Voir aussi

Détails du constructeur
ContextMenuEvent()Constructeur
public function ContextMenuEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, mouseTarget:InteractiveObject = null, contextMenuOwner:InteractiveObject = null)

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

Crée un objet Event contenant des informations spécifiques sur les événements de menu. Les objets Event sont transmis en tant que paramètres aux écouteurs d'événements.

Paramètres
type:String — Type de l'événement. Les valeurs possibles sont les suivantes :
  • ContextMenuEvent.MENU_ITEM_SELECT
  • ContextMenuEvent.MENU_SELECT
 
bubbles:Boolean (default = false) — Détermine si l'objet Event prend part à la phase de propagation vers le haut (bubbling) du flux d'événements. Les écouteurs d'événement peuvent accéder à cette information par le biais de la propriété bubbles héritée.
 
cancelable:Boolean (default = false) — Détermine si l'objet Event peut être annulé. Les écouteurs d'événement peuvent accéder à cette information par le biais de la propriété cancelable héritée.
 
mouseTarget:InteractiveObject (default = null) — Objet de la liste d'affichage sur lequel l'utilisateur a cliqué du bouton droit de la souris pour afficher le menu contextuel. Il peut s'agir de l'objet contextMenuOwner ou de l'un de ses descendants dans la liste d'affichage.
 
contextMenuOwner:InteractiveObject (default = null) — Objet de la liste d'affichage auquel le menu est associé. Il peut s'agir de l'objet mouseTarget ou de l'un de ses ancêtres dans la liste d'affichage.

Voir aussi

Détails de la méthode
clone()méthode
override public function clone():Event

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

Crée une copie de l'objet ContextMenuEvent et définit la valeur de chaque propriété de sorte qu'elle corresponde à la valeur d'origine.

Valeur renvoyée
Event — Nouvel objet ContextMenuEvent dont les propriétés ont la même valeur que celles de l'objet d'origine.
toString()méthode 
override public function toString():String

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

Renvoie une chaîne répertoriant toutes les propriétés de l'objet ContextMenuEvent. La chaîne est écrite au format suivant :

[ContextMenuEvent type=valeur bubbles=valeur cancelable=valeur... contextMenuOwner=valeur ]

Valeur renvoyée
String — Chaîne répertoriant toutes les propriétés de l'objet ContextMenuEvent.
Détails de la constante
MENU_ITEM_SELECTConstante
public static const MENU_ITEM_SELECT:String = "menuItemSelect"

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

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
bubbles false
cancelable false ; il n'existe aucun comportement par défaut à annuler.
contextMenuOwner Objet de la liste d'affichage auquel le menu est associé.
currentTarget L'objet qui traite activement l'objet Event avec un écouteur d'événements.
mouseTarget Objet de la liste d'affichage sur lequel l'utilisateur a cliqué du bouton droit de la souris pour afficher le menu contextuel.
target Objet 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.

Voir aussi

MENU_SELECTConstante 
public static const MENU_SELECT:String = "menuSelect"

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

Définit la valeur de la propriété type d'un objet événement menuSelect.

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.
contextMenuOwner Objet de la liste d'affichage auquel le menu est associé.
currentTarget L'objet qui traite activement l'objet Event avec un écouteur d'événements.
mouseTarget Objet de la liste d'affichage sur lequel l'utilisateur a cliqué du bouton droit de la souris pour afficher le menu contextuel.
target Objet ContextMenu sur le point d'être affiché. 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.

Voir aussi

Exemples Utilisation des exemples
ContextMenuEventExample.as

L'exemple suivant utilise la classe ContextMenuEventExample pour supprimer les éléments de menu contextuel par défaut de la scène et ajouter un nouvel élément de menu qui change la couleur d'un carré sur la scène. L'exemple exécute les tâches suivantes :
  1. La propriété myContextMenu est déclarée, puis affectée à un nouvel objet ContextMenu et la propriété redRectangle (de type Sprite) est déclarée.
  2. La méthode removeDefaultItems() est appelée. Cette méthode supprime tous les éléments de menu intégrés à l'exception de Print.
  3. La méthode addCustomMenuItems() est appelée. Cette méthode place un élément de menu Reverse Colors dans le tableau defaultItems à l'aide de la méthode push() de Array. Un écouteur d'événement menuItemSelect est ajouté à l'objet ContextMenuItem et la méthode associée est appelée menuItemSelectHandler(). Cette méthode imprime certaines instructions trace() chaque fois que l'initiateur sélectionne Reverse Colors dans le menu contextuel. Le carré rouge devient noir et le texte noir devient rouge.
  4. Dans le constructeur, un écouteur d'événement menuSelect est ajouté, de même que la méthode associée menuSelectHandler(), qui imprime simplement trois instructions trace() chaque fois qu'un élément du menu contextuel est sélectionné.
  5. Le constructeur appelle addChildren(), qui dessine un carré rouge et l'ajoute dans la liste d'affichage, cette dernière l'affichant immédiatement.
  6. Enfin, la propriété myContextMenu est affectée ou menu contextuel de la propriété redRectangle, de sorte que le menu contextuel personnalisé ne s'affiche que lorsque le pointeur de la souris survole le carré.
package {
    import flash.ui.ContextMenu;
    import flash.ui.ContextMenuItem;
    import flash.ui.ContextMenuBuiltInItems;
    import flash.events.ContextMenuEvent;
    import flash.display.Sprite;
    import flash.display.Shape;
    import flash.text.TextField;

    public class ContextMenuEventExample extends Sprite {
        private var myContextMenu:ContextMenu;
        private var menuLabel:String = "Reverse Colors";
        private var textLabel:String = "Right Click";
        private var redRectangle:Sprite;
        private var label:TextField;
        private var size:uint = 100;
        private var black:uint = 0x000000;
        private var red:uint = 0xFF0000;

        public function ContextMenuEventExample() {
            myContextMenu = new ContextMenu();
            removeDefaultItems();
            addCustomMenuItems();
            myContextMenu.addEventListener(ContextMenuEvent.MENU_SELECT, menuSelectHandler);

            addChildren();
            redRectangle.contextMenu = myContextMenu;
        }

        private function addChildren():void {
            redRectangle = new Sprite();
            redRectangle.graphics.beginFill(red);
            redRectangle.graphics.drawRect(0, 0, size, size);
            addChild(redRectangle);
            redRectangle.x = size;
            redRectangle.y = size;
            label = createLabel();
            redRectangle.addChild(label);
        }

        private function removeDefaultItems():void {
            myContextMenu.hideBuiltInItems();
            var defaultItems:ContextMenuBuiltInItems = myContextMenu.builtInItems;
            defaultItems.print = true;
        }

        private function addCustomMenuItems():void {
            var item:ContextMenuItem = new ContextMenuItem(menuLabel);
            myContextMenu.customItems.push(item);
            item.addEventListener(ContextMenuEvent.MENU_ITEM_SELECT, menuItemSelectHandler);
        }

        private function menuSelectHandler(event:ContextMenuEvent):void {
            trace("menuSelectHandler: " + event);
        }

        private function menuItemSelectHandler(event:ContextMenuEvent):void {
            trace("menuItemSelectHandler: " + event);
            var textColor:uint = (label.textColor == black) ? red : black;
            var bgColor:uint = (label.textColor == black) ? black : red;
            redRectangle.graphics.clear();
            redRectangle.graphics.beginFill(bgColor);
            redRectangle.graphics.drawRect(0, 0, size, size);
            label.textColor = textColor;
        }

        private function createLabel():TextField {
            var txtField:TextField = new TextField();
            txtField.text = textLabel;
            return txtField;
        }
    }
}