Befehle

org.eclipse.ui.commands

2.1

Am Erweiterungspunkt org.eclipse.ui.commands werden unter Verwendung der Elemente command und category Befehle und Befehlskategorien deklariert. Ein Befehl ist eine Kurzdarstellung eines semantischen Verhaltens, jedoch nicht seine eigentliche Implementierung. Dadurch können verschiedene Entwickler ein spezifisches verhalten für ihre individuellen Abschnitte beisteuern. Es kann zum Beispiel einen Befehl "Einfügen" mit einer Implementierung in einem Editor und einer anderen Implementierung in einem Explorer-Fensterobjekt geben. Diese Implementierungen werden Steuerroutinen genannt.

<!ELEMENT extension (activeKeyConfiguration , category , command , keyBinding , keyConfiguration , context , scope)>

<!ATTLIST extension

id    CDATA #IMPLIED

name  CDATA #IMPLIED

point CDATA #REQUIRED>


<!ELEMENT activeKeyConfiguration EMPTY>

<!ATTLIST activeKeyConfiguration

value              CDATA #IMPLIED

keyConfigurationId CDATA #IMPLIED>

Dieses Element definiert die anfänglich aktive Tastenkonfiguration für Eclipse. Wenn mehrere solcher Elemente vorhanden sind, wird nur das als letztes deklarierte Element (in der Reihenfolge, in der die Plug-in-Registrierung gelesen wird) als gültig betrachtet.

Dieses Element wurde durch eine Benutzervorgabe ersetzt. Wenn Ihre Anwendung die standardmäßige Tastenkonfiguration ändern muss, geben Sie Folgendes in Ihrer Datei plugin_customization.ini an: org.eclipse.ui/KEY_CONFIGURATION_ID=your.default.key.configuration.id.



<!ELEMENT category EMPTY>

<!ATTLIST category

description CDATA #IMPLIED

id          CDATA #REQUIRED

name        CDATA #REQUIRED>

In der Benutzerschnittstelle werden Befehle häufig in Kategorien angeordnet, um ihre Verwaltung zu vereinfachen. Dieses Element dient zum Definieren solcher Kategorien. Befehle können sich selbst zu höchstens einer Kategorie zuordnen. Wenn mehrere solcher Elemente mit demselben Attribut id vorhanden sind, wird nur das als letztes deklarierte Element (in der Reihenfolge, in der die Plug-in-Registrierung gelesen wird) als gültig betrachtet.



<!ELEMENT command (commandParameter | defaultHandler?)>

<!ATTLIST command

category       CDATA #IMPLIED

description    CDATA #IMPLIED

id             CDATA #REQUIRED

name           CDATA #REQUIRED

categoryId     CDATA #IMPLIED

defaultHandler CDATA #IMPLIED>

Mit diesem Element werden Befehle definiert. Ein Befehl stellt eine Anforderung vom Benutzer dar, der durch eine Aktion verarbeitet werden kann, und sollte im Vergleich zu anderen Befehlen semantisch eindeutig sein. Definieren Sie keinen Befehl, wenn es bereits einen Befehl gibt, der mit derselben Bedeutung definiert wurde. Wenn mehrere solcher Elemente mit demselben Attribut id vorhanden sind, wird nur das als letztes deklarierte Element (in der Reihenfolge, in der die Plug-in-Registrierung gelesen wird) als gültig betrachtet. Informationen dazu, wie Aktionen mit Befehlen verbunden werden, finden Sie in den Angaben zu den Erweiterungspunktenorg.eclipse.ui.actionSets und org.eclipse.ui.editorActions.



<!ELEMENT keyBinding EMPTY>

<!ATTLIST keyBinding

configuration      CDATA #IMPLIED

command            CDATA #IMPLIED

locale             CDATA #IMPLIED

platform           CDATA #IMPLIED

contextId          CDATA #IMPLIED

string             CDATA #IMPLIED

scope              CDATA #IMPLIED

keyConfigurationId CDATA #IMPLIED

commandId          CDATA #IMPLIED

keySequence        CDATA #IMPLIED>

Mit diesem Element können Tastenfolgen zu Befehlen zugeordnet werden. Bitte verwenden Sie stattdessen das Element key in dem Erweiterungspunkt "org.eclipse.ui.bindings".



<!ELEMENT keyConfiguration EMPTY>

<!ATTLIST keyConfiguration

description CDATA #IMPLIED

id          CDATA #REQUIRED

name        CDATA #REQUIRED

parent      CDATA #IMPLIED

parentId    CDATA #IMPLIED>

Mit diesem Element werden Tastenkonfigurationen definiert. Wenn mehrere solcher Elemente mit demselben Attribut id vorhanden sind, wird nur das als letztes deklarierte Element (in der Reihenfolge, in der die Plug-in-Registrierung gelesen wird) als gültig betrachtet. Bitte verwenden Sie statt dessen den Erweiterungspunkt "org.eclipse.ui.bindings".



<!ELEMENT context EMPTY>

<!ATTLIST context

description CDATA #IMPLIED

id          CDATA #REQUIRED

name        CDATA #REQUIRED

parent      CDATA #IMPLIED

parentId    CDATA #IMPLIED>

Mit diesem Element werden Kontexte definiert. Wenn mehrere solcher Elemente mit demselben Attribut id vorhanden sind, wird nur das als letztes deklarierte Element (in der Reihenfolge, in der die Plug-in-Registrierung gelesen wird) als gültig betrachtet. Bitte verwenden Sie stattdessen den Erweiterungspunkt org.eclipse.ui.contexts.



<!ELEMENT scope EMPTY>

<!ATTLIST scope

description CDATA #IMPLIED

id          CDATA #REQUIRED

name        CDATA #REQUIRED

parent      CDATA #IMPLIED>

Mit diesem Element werden Bereiche definiert. Wenn mehrere solcher Elemente mit demselben Attribut id vorhanden sind, wird nur das als letztes deklarierte Element (in der Reihenfolge, in der die Plug-in-Registrierung gelesen wird) als gültig betrachtet. @veraltet Bitte benutzen Sie stattdessen den Erweiterungspunkt "org.eclipse.ui.contexts".



<!ELEMENT commandParameter (values)>

<!ATTLIST commandParameter

id       CDATA #REQUIRED

name     CDATA #REQUIRED

values   CDATA #IMPLIED

optional (true | false) "true">

Definiert einen Parameter, den ein befehl verstehen sollte. Ein Parameter ist eine Methode, einer Steuerroutine während der Ausführung weitere Informationen zur Verfügung zu stellen. Zum Beispiel könnte ein Befehl "Sicht anzeigen" eine Ansicht als Parameter nehmen. Steuerroutinen sollten in der Lage sein, diese Parameter zu verstehen, sie sollten also wie API behandelt werden.



<!ELEMENT values (parameter)>

<!ATTLIST values

class CDATA #REQUIRED>

Die ausführlichere Version des Attribut values zu commandParameter.



<!ELEMENT parameter EMPTY>

<!ATTLIST parameter

name  CDATA #REQUIRED

value CDATA #REQUIRED>

Ein möglicher Wert für einen Parameter.



<!ELEMENT defaultHandler (parameter)>

<!ATTLIST defaultHandler

class CDATA #REQUIRED>

Die standardmäßige Steuerroutine für diesen Befehl. Wenn keine andere Steuerroutine aktiv ist, wird diese Steuerroutine aktiv sein. Diese Steuerroutine wird anderen Steuerroutinendefinitionen, die keine activeWhen-Bedingungen angeben, widersprechen. Wenn Sie keine IExecutableExtension erstellen, können Sie stattdessen das Attribut defaultHandler verwenden.



Die Datei plugin.xml im Plug-in org.eclipse.ui setzt den Erweiterungspunkt org.eclipse.ui.commands intensiv ein.

Dies ist keine öffentliche API zum Deklarieren von Befehlen, Kategorien, Tastenbelegungen, Tastenkonfigurationen oder Kontexten, mit Ausnahme dieses Erweiterungspunktes. Öffentliche API zur Abfrage und Einstellung von Kontexten sowie Registrierung von Aktionen zur Abwicklung spezifischer Befehle finden Sie in org.eclipse.ui.IKeyBindingService.