ActionScript® 3.0 Referenzhandbuch für die Adobe® Flash®-Plattform
Home  |  Liste der Pakete und Klassen ausblenden |  Pakete  |  Klassen  |  Neue Funktionen  |  Stichwortverzeichnis  |  Anhänge  |  Warum auf Englisch?
Filter: Daten werden vom Server abgerufen...
Daten werden vom Server abgerufen...
flash.ui 

ContextMenuItem  - AS3

Paketflash.ui
Klassepublic final class ContextMenuItem
VererbungContextMenuItem Inheritance NativeMenuItem Inheritance EventDispatcher Inheritance Object

Sprachversion: ActionScript 3.0
Laufzeitversionen: AIR 1.0, Flash Player 9

Die ContextMenuItem-Klasse stellt ein Element im Kontextmenü dar. Jedes ContextMenuItem-Objekt verfügt über einen Anzeigetext, der im Kontextmenü angezeigt wird. Wenn Sie einem Kontextmenü ein neues Element hinzufügen möchten, fügen Sie es dem customItems-Array eines ContextMenu-Objekts hinzu.

In den Eigenschaften der ContextMenuItem-Klasse können Sie bestimmte Menüeinträge aktivieren oder deaktivieren sowie einblenden oder ausblenden.

Um einem Menüeintrag bei Auswahl durch den Benutzer zusätzliche Funktionen hinzuzufügen, müssen Sie eine Ereignisprozedur für das menuItemSelect-Ereignis erstellen.

Benutzerdefinierte Menüelemente werden im jeweiligen Kontextmenü oben über den integrierten Elementen angezeigt und durch eine Trennlinie von integrierten Menüelementen getrennt. In AIR gibt es keine integrierten Elemente und die folgenden Einschränkungen gelten nicht für den Inhalt in der AIR-Anwendungs-Sandbox.

Einschränkungen:

  • Einem Kontextmenü können maximal 15 benutzerdefinierte Menüelemente hinzugefügt werden.
  • Jeder Anzeigetext muss mindestens ein sichtbares Zeichen enthalten.
  • Steuerzeichen, Zeilenvorschübe und andere Leerraumzeichen werden ignoriert.
  • Der Anzeigetext darf nicht mehr als 100 Zeichen lang sein.
  • Anzeigetexte mit demselben Text wie integrierte oder andere benutzerdefinierte Menüelemente werden ignoriert, unabhängig davon, ob das andere Element sichtbar ist. Beim Vergleich der Anzeigetexte mit dem Text integrierter oder vorhandener benutzerdefinierter Menüelemente werden Groß- und Kleinschreibung, Satzzeichen und Leerraumzeichen nicht berücksichtigt.
  • Die folgenden Anzeigetexte sind nicht zulässig, die einzelnen Wörter können jedoch in Zusammensetzungen mit anderen Wörtern verwendet werden (z. B. ist "100%" unzulässig, "100% Zufriedenheit" jedoch zulässig):
     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
     
  • Die folgenden Begriffe dürfen in benutzerdefinierten Anzeigetexten weder alleinstehend noch in Zusammensetzungen verwendet werden:
     Adobe
     Macromedia
     Flash Player
     Settings
     

Hinweis: Wenn der Player auf einem nicht englischsprachigen System ausgeführt wird, erfolgt der Vergleich der Anzeigetexte sowohl mit der englischen Liste als auch mit den lokalisierten Entsprechungen.

Beispiele anzeigen

Verwandte API-Elemente



Öffentliche Eigenschaften
 EigenschaftDefiniert von
  caption : String
Gibt den Anzeigetext des Menüelements an, der im Kontextmenü angezeigt wird.
ContextMenuItem
 Inherited    checked : Boolean
Steuert, ob für dieses Menüelement ein Häkchen angezeigt wird.
NativeMenuItem
 Inheritedconstructor : Object
Ein Verweis auf das Klassenobjekt oder die Konstruktorfunktion für eine angegebene Objektinstanz.
Object
 Inherited    data : Object
Ein beliebiges Datenobjekt, das zu diesem Menüelement gehört.
NativeMenuItem
 Inherited    enabled : Boolean
Steuert, ob dieses Menüelement aktiviert ist.
NativeMenuItem
 Inherited    isSeparator : Boolean
[schreibgeschützt] Gibt an, ob es sich bei diesem Element um eine Menütrennlinie handelt.
NativeMenuItem
 Inherited    keyEquivalent : String
Der Tastaturbefehl für dieses Menüelement.
NativeMenuItem
 Inherited    keyEquivalentModifiers : Array
Das Tastencode-Array für die Zusatztasten des Tastaturbefehls.
NativeMenuItem
 Inherited    label : String
Der Anzeigestring dieses Menüelements.
NativeMenuItem
 Inherited    menu : NativeMenu
[schreibgeschützt] Das Menü, das dieses Element enthält.
NativeMenuItem
 Inherited    mnemonicIndex : int
Die Position des Zugriffszeichens in der Bezeichnung des Menüelements.
NativeMenuItem
 Inherited    name : String
Der Name dieses Menüelements.
NativeMenuItem
  separatorBefore : Boolean
Gibt an, ob oberhalb des angegebenen Menüelements eine Trennlinie angezeigt wird.
ContextMenuItem
 Inherited    submenu : NativeMenu
Das Untermenü, das zu diesem Menüelement gehört.
NativeMenuItem
  visible : Boolean
Gibt an, ob das angegebene Menüelement sichtbar ist, wenn das Flash Player-Kontextmenü angezeigt wird.
ContextMenuItem
Öffentliche Methoden
 MethodeDefiniert von
  
ContextMenuItem(caption:String, separatorBefore:Boolean = false, enabled:Boolean = true, visible:Boolean = true)
Erstellt ein neues ContextMenuItem-Objekt, das dem Array „ContextMenu.customItems“ hinzugefügt werden kann.
ContextMenuItem
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registriert ein Ereignis-Listener-Objekt bei einem EventDispatcher-Objekt, sodass der Listener über ein Ereignis benachrichtigt wird.
EventDispatcher
  
[override] Erstellt eine Kopie des NativeMenuItem-Objekts.
ContextMenuItem
 Inherited
Sendet ein Ereignis in den Ereignisablauf.
EventDispatcher
 Inherited
Überprüft, ob das EventDispatcher-Objekt Listener für einen bestimmten Ereignistyp registriert hat.
EventDispatcher
 Inherited
Gibt an, ob für ein Objekt eine bestimmte Eigenschaft definiert wurde.
Object
 Inherited
Gibt an, ob eine Instanz der Object-Klasse in der Prototypkette des Objekts vorhanden ist, das als Parameter angegeben wurde.
Object
 Inherited
Gibt an, ob die angegebene Eigenschaft vorhanden ist und durchlaufen werden kann.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Entfernt einen Listener aus dem EventDispatcher-Objekt.
EventDispatcher
 Inherited
Legt die Verfügbarkeit einer dynamischen Eigenschaft für Schleifenoperationen fest.
Object
  
[statisch]
ContextMenuItem
  
[statisch]
ContextMenuItem
  
[statisch]
ContextMenuItem
  
[statisch]
ContextMenuItem
  
[statisch]
ContextMenuItem
  
[statisch]
ContextMenuItem
  
[statisch]
ContextMenuItem
 Inherited
Gibt die Stringdarstellung dieses Objekts zurück, formatiert entsprechend den Konventionen des Gebietsschemas.
Object
 Inherited
    toString():String
[override] Gibt einen String zurück, der alle Eigenschaften des NativeMenuItem-Objekts enthält.
NativeMenuItem
 Inherited
Gibt den Grundwert des angegebenen Objekts zurück.
Object
 Inherited
Überprüft, ob bei diesem EventDispatcher-Objekt oder bei einem seiner Vorgänger ein Ereignis-Listener für einen bestimmten Ereignistyp registriert ist.
EventDispatcher
Ereignisse
 Ereignis Übersicht Definiert von
 Inherited[broadcast event] Wird ausgelöst, wenn Flash Player oder eine AIR-Anwendung den Betriebssystemfokus erhält und aktiv wird.EventDispatcher
 Inherited[broadcast event] Wird ausgelöst, wenn Flash Player- oder die AIR-Anwendung den Fokus verliert und inaktiv wird.EventDispatcher
 Inherited
    displaying
Wird von diesem NativeMenuItem-Objekt ausgelöst, unmittelbar bevor das Menü, das das Element enthält, angezeigt wird.NativeMenuItem
  Wird ausgelöst, wenn ein Benutzer ein Element in einem Kontextmenü auswählt.ContextMenuItem
 Inherited
    preparing
Wird von diesem NativeMenuItem-Objekt abgesetzt, wenn die Tastenentsprechung gedrückt wird, und kurz bevor das entsprechende Menü eingeblendet wird.NativeMenuItem
 Inherited
    select
Wird immer ausgelöst, wenn der Benutzer ein Menüelement auswählt.NativeMenuItem
Eigenschaftendetails

caption

Eigenschaft
caption:String

Sprachversion: ActionScript 3.0
Laufzeitversionen: AIR 1.0, Flash Player 9

Gibt den Anzeigetext des Menüelements an, der im Kontextmenü angezeigt wird. Einschränkungen für den caption-Wert finden Sie in der Übersicht zur ContextMenuItem-Klasse.



Implementierung
    public function get caption():String
    public function set caption(value:String):void

separatorBefore

Eigenschaft 
separatorBefore:Boolean

Sprachversion: ActionScript 3.0
Laufzeitversionen: AIR 1.0, Flash Player 9

Gibt an, ob oberhalb des angegebenen Menüelements eine Trennlinie angezeigt wird.

Hinweis: Zwischen benutzerdefinierten und integrierten Menüelementen wird immer eine Trennlinie angezeigt.

Der Standardwert ist false.



Implementierung
    public function get separatorBefore():Boolean
    public function set separatorBefore(value:Boolean):void

visible

Eigenschaft 
visible:Boolean

Sprachversion: ActionScript 3.0
Laufzeitversionen: AIR 1.0, Flash Player 9

Gibt an, ob das angegebene Menüelement sichtbar ist, wenn das Flash Player-Kontextmenü angezeigt wird.

Der Standardwert ist true.



Implementierung
    public function get visible():Boolean
    public function set visible(value:Boolean):void
Konstruktordetails

ContextMenuItem

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

Sprachversion: ActionScript 3.0
Laufzeitversionen: AIR 1.0, Flash Player 9

Erstellt ein neues ContextMenuItem-Objekt, das dem Array ContextMenu.customItems hinzugefügt werden kann.

Parameter
caption:String — Gibt den Text an, der mit dem Menüelement verknüpft ist. Einschränkungen für den caption-Wert finden Sie in der Übersicht zur ContextMenuItem-Klasse.
 
separatorBefore:Boolean (default = false) — Gibt an, ob im Kontextmenü über dem Menüeintrag eine Trennlinie angezeigt wird. Der Standardwert ist false.
 
enabled:Boolean (default = true) — Gibt an, ob das Menüelement im Kontextmenü aktiviert oder deaktiviert ist. Der Standardwert ist true (aktiviert). Dieser Parameter ist optional.
 
visible:Boolean (default = true) — Gibt an, ob das Menüelement sichtbar oder unsichtbar ist. Der Standardwert ist true (sichtbar).
Methodendetails

clone

()Methode
override public function clone():NativeMenuItem

Erstellt eine Kopie des NativeMenuItem-Objekts.

Rückgabewerte
NativeMenuItem

systemClearMenuItem

()Methode 
public static function systemClearMenuItem():ContextMenuItem

Rückgabewerte
ContextMenuItem

systemCopyLinkMenuItem

()Methode 
public static function systemCopyLinkMenuItem():ContextMenuItem

Rückgabewerte
ContextMenuItem

systemCopyMenuItem

()Methode 
public static function systemCopyMenuItem():ContextMenuItem

Rückgabewerte
ContextMenuItem

systemCutMenuItem

()Methode 
public static function systemCutMenuItem():ContextMenuItem

Rückgabewerte
ContextMenuItem

systemOpenLinkMenuItem

()Methode 
public static function systemOpenLinkMenuItem():ContextMenuItem

Rückgabewerte
ContextMenuItem

systemPasteMenuItem

()Methode 
public static function systemPasteMenuItem():ContextMenuItem

Rückgabewerte
ContextMenuItem

systemSelectAllMenuItem

()Methode 
public static function systemSelectAllMenuItem():ContextMenuItem

Rückgabewerte
ContextMenuItem
Ereignisdetails

menuItemSelect

Ereignis
Ereignisobjekttyp: flash.events.ContextMenuEvent
Eigenschaft ContextMenuEvent.type = flash.events.ContextMenuEvent.MENU_ITEM_SELECT

Sprachversion: ActionScript 3.0
Laufzeitversionen: AIR 1.0, Flash Player 9

Wird ausgelöst, wenn ein Benutzer ein Element in einem Kontextmenü auswählt. Der Benutzer erzeugt das Kontextmenü durch Klicken der sekundären Taste auf dem Zeigegerät.

Definiert den Wert der Eigenschaft type eines menuItemSelect-Ereignisobjekts.

Dieses Ereignis verfügt über die folgenden Eigenschaften:

EigenschaftWert
bubblesfalse
cancelablefalse. Es gibt kein Standardverhalten, das abgebrochen werden kann.
contextMenuOwnerDas Anzeigelistenobjekt, dem das Menü zugeordnet ist.
currentTargetDas Objekt, welches das Ereignisobjekt aktiv mit einem Ereignis-Listener verarbeitet.
mouseTargetDas Anzeigelistenobjekt, auf das der Benutzer mit rechts geklickt hat, um das Kontextmenü anzuzeigen.
targetDas ausgewählte ContextMenuItem-Objekt. Das Ziel ist nicht immer das Objekt in der Anzeigeliste, in der der Ereignis-Listener registriert wurde. Mit der Eigenschaft currentTarget können Sie auf das Objekt in der Anzeigeliste zugreifen, das das Ereignis derzeit verarbeitet.
ContextMenuItemExample.as

Im folgenden Beispiel wird die Klasse ContextMenuBuiltInItemsExample verwendet, um die Standardelemente des Kontextmenüs von der Bühne zu entfernen und ein neues Menüelement hinzuzufügen. Dies wird in den folgenden Schritten erreicht:
  1. Die Eigenschaft myContextMenu wird deklariert und dann einem neuen ContextMenu-Objekt zugewiesen.
  2. Die removeDefaultItems()-Methode wird aufgerufen, bei der alle integrierten Kontextmenüelemente mit Ausnahme der Option zum Drucken entfernt werden.
  3. Die addCustomMenuItems()-Methode wird aufgerufen, bei der ein Menüelement mit der Bezeichnung Hello World im customItems-Array platziert wird, indem die push()-Methode des Arrays verwendet wird.
  4. Das Hello World-Kontextmenüelement wird den Elementen des Kontextmenüs der Bühne hinzugefügt.
  5. Ein TextField-Objekt mit dem Text „Hier mit der rechten Maustaste klicken“ wird der Bühne hinzugefügt.
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 ]Warum auf Englisch?
Inhalt des ActionScript 3.0-Referenzhandbuchs wird in englischer Sprache angezeigt

Nicht alle Teile des ActionScript 3.0-Referenzhandbuchs wurden in alle Sprachen übersetzt. Wenn der Text zu einem Sprachelement nicht übersetzt wurde, wird er auf Englisch angezeigt. Zum Beispiel wurden die Informationen zur ga.controls.HelpBox-Klasse nicht in andere Sprachen übersetzt. In der deutschen Version des Referenzhandbuchs erscheint der Abschnitt zur ga.controls.HelpBox-Klasse deshalb auf Englisch.