flash.ui.ContextMenuItem (ActionScript 3.0)

Paket	flash.ui
Klasse	public final class ContextMenuItem
Vererbung	ContextMenuItem EventDispatcher Object

Sprachversion :

ActionScript 3.0

Player-Version :

Flash Player 9

Mit der ContextMenuItem-Klasse können Sie benutzerdefinierte Menüelemente erstellen, die im Flash Player-Kontextmenü angezeigt werden. 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 verbergen.

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

Benutzerdefinierte Menüelemente werden im jeweiligen Kontextmenü oben über den integrierten Elementen angezeigt und stets durch eine Trennlinie von integrierten Menüelementen getrennt.

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):

 Speichern
 Vergrößern
 Verkleinern
 100%
 Alles zeigen
 Qualität
 Abspielen
 Endlosschleife
 Zurückspulen
 Vorwärts
 Zurück
 Film nicht geladen
 Über
 Drucken
 Bildaktualisierungsbereiche anzeigen
 Debugger
 Rückgängig
 Ausschneiden
 Kopieren
 Einfügen
 Löschen
 Alles auswählen
 Öffnen
 In neuem
 Fenster öffnen
 Link kopieren

Die folgenden Begriffe dürfen in benutzerdefinierten Anzeigetexten weder alleinstehend noch in Zusammensetzungen verwendet werden:
```
 Adobe
 Macromedia
 Flash Player
 Einstellungen
 
```

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

Siehe auch

ContextMenu-Klasse
ContextMenuBuiltInItems-Klasse

	Eigenschaft	Definiert von
		caption : String Gibt den Anzeigetext des Menüelements an, der im Kontextmenü angezeigt wird.	ContextMenuItem
		constructor : Object Ein Verweis auf das Klassenobjekt oder die Konstruktorfunktion für eine angegebene Objektinstanz.	Object
		enabled : Boolean Gibt an, ob das angegebene Menüelement aktiviert oder deaktiviert ist.	ContextMenuItem
		prototype : Object [static] Ein Verweis auf das Prototypobjekt einer Klasse oder eines Funktionsobjekts.	Object
		separatorBefore : Boolean Gibt an, ob oberhalb des angegebenen Menüelements eine Trennlinie angezeigt wird.	ContextMenuItem
		visible : Boolean Gibt an, ob das angegebene Menüelement sichtbar ist, wenn das Flash Player-Kontextmenü angezeigt wird.	ContextMenuItem

	Methode	Definiert 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
		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
		clone():ContextMenuItem Erstellt eine Kopie des angegebenen ContextMenuItem-Objekts und gibt diese zurück.	ContextMenuItem
		dispatchEvent(event:Event):Boolean Sendet ein Ereignis in den Ereignisablauf.	EventDispatcher
		hasEventListener(type:String):Boolean Überprüft, ob das EventDispatcher-Objekt Listener für einen bestimmten Ereignistyp registriert hat.	EventDispatcher
		hasOwnProperty(name:String):Boolean Gibt an, ob für ein Objekt eine bestimmte Eigenschaft definiert wurde.	Object
		isPrototypeOf(theClass:Object):Boolean Gibt an, ob eine Instanz der Object-Klasse in der Prototypkette des Objekts vorhanden ist, das als Parameter angegeben wurde.	Object
		propertyIsEnumerable(name:String):Boolean Gibt an, ob die angegebene Eigenschaft vorhanden ist und durchlaufen werden kann.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Entfernt einen Listener aus dem EventDispatcher-Objekt.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Legt die Verfügbarkeit einer dynamischen Eigenschaft für Schleifenoperationen fest.	Object
		toString():String Gibt das angegebene Objekt als String zurück.	Object
		valueOf():Object Gibt den Grundwert des angegebenen Objekts zurück.	Object
		willTrigger(type:String):Boolean Überprüft, ob bei diesem EventDispatcher-Objekt oder bei einem seiner vorangegangenen Elementen ein Ereignis-Listener für einen bestimmten Ereignistyp registriert ist.	EventDispatcher

Übersicht	Definiert von
activate	Wird ausgelöst, wenn Flash Player den Betriebssystemfokus erhält und aktiv wird.	EventDispatcher
deactivate	Wird ausgelöst, wenn Flash Player den Betriebssystemfokus verliert und inaktiv wird.	EventDispatcher
menuItemSelect	Wird ausgelöst, wenn ein Benutzer ein Element in einem Kontextmenü auswählt.	ContextMenuItem

Eigenschaftsdetail

caption

Eigenschaft

caption:String [read-write]

Sprachversion :

ActionScript 3.0

Player-Version :

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

enabled

Eigenschaft

enabled:Boolean [read-write]

Sprachversion :

ActionScript 3.0

Player-Version :

Flash Player 9

Gibt an, ob das angegebene Menüelement aktiviert oder deaktiviert ist.

Der Standardwert lautet true.

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

separatorBefore

Eigenschaft

separatorBefore:Boolean [read-write]

Sprachversion :

ActionScript 3.0

Player-Version :

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 lautet false.

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

visible

Eigenschaft

visible:Boolean [read-write]

Sprachversion :

ActionScript 3.0

Player-Version :

Flash Player 9

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

Der Standardwert lautet true.

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

Konstruktordetail

ContextMenuItem

()

Konstruktor

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

Sprachversion :

ActionScript 3.0

Player-Version :

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 dem Menüelement zugeordnet 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 lautet `false`.

	`enabled:Boolean` (default = `true`) — Gibt an, ob das Menüelement im Kontextmenü aktiviert oder deaktiviert ist. Der Standardwert lautet `true` (aktiviert). Dieser Parameter ist optional.

	`visible:Boolean` (default = `true`) — Gibt an, ob das Menüelement sichtbar oder unsichtbar ist. Der Standardwert lautet `true` (sichtbar).

Methodendetail

clone

()

Methode

public function clone():ContextMenuItem

Sprachversion :

ActionScript 3.0

Player-Version :

Flash Player 9

Erstellt eine Kopie des angegebenen ContextMenuItem-Objekts und gibt diese zurück. Die Kopie enthält alle Eigenschaften des ursprünglichen Objekts.

Rückgabewerte

ContextMenuItem — Ein ContextMenuItem-Objekt mit allen Eigenschaften des Originalobjekts.

Ereignisdetail

menuItemSelect

Ereignis

Ereignisobjekttyp: flash.events.ContextMenuEvent
ContextMenuEvent.type property = flash.events.ContextMenuEvent.MENU_ITEM_SELECT

Sprachversion :

ActionScript 3.0

Player-Version :

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:

Eigenschaft	Wert
`bubbles`	`false`
`cancelable`	`false`. Es gibt kein Standardverhalten, das abgebrochen werden kann.
`contextMenuOwner`	Das Anzeigelistenobjekt, dem das Menü zugeordnet ist.
`currentTarget`	Das Objekt, welches das Ereignisobjekt aktiv mit einem Ereignis-Listener verarbeitet.
`mouseTarget`	Das Anzeigelistenobjekt, auf das der Benutzer mit rechts geklickt hat, um das Kontextmenü anzuzeigen.
`target`	Das 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.

Beispiele Verwendung von Beispielen

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:

Die Eigenschaft myContextMenu wird deklariert und dann einem neuen ContextMenu-Objekt zugewiesen.
Die Methode removeDefaultItems() wird aufgerufen, bei der alle integrierten Kontextmenüelemente mit Ausnahme der Option zum Drucken entfernt werden.
Die Methode addCustomMenuItems() wird aufgerufen, bei der ein Menüelement mit der Bezeichnung Hello World mithilfe der Methode push() des Arrays im customItems-Array positioniert wird.
Das Kontextmenüelement Hello World wird den Elementen des Kontextmenüs der Bühne hinzugefügt.
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;
        }
    }
}

Aktuelle Seite: http://livedocs.adobe.com/flash/9.0_de/ActionScriptLangRefV3/flash/ui/ContextMenuItem.html

Komponenten-Referenzhandbuch für ActionScript 3.0		Alle Pakete \| Alle Klassen \| Sprachelemente \| Stichwortverzeichnis \| Anhänge \| Konventionen \| Frames Keine Frames
ContextMenuItem	Eigenschaften \| Methoden \| Ereignisse \| Beispiele