Befehle
Kennung:
org.eclipse.ui.commands
Seit:
2.1
Beschreibung:
Am Erweiterungspunkt org.eclipse.ui.commands
werden unter Verwendung der Elemente command
und category
Befehle und Befehlskategorien deklariert. Über diesen Erweiterungspunkt können außerdem unter Verwendung des Elements keyBinding
Tastenkombinationen zu Befehlen zugeordnet werden. Tastenfolgen sind an Befehle gebunden, die auf Tastenkonfigurationen und Kontexten basieren, die hier ebenfalls durch Verwendung der Elemente keyConfiguration
und context
deklariert werden.
Konfigurationsbefehle:
<!ELEMENT extension (activeKeyConfiguration , category , command , keyBinding , keyConfiguration , context)>
<!ATTLIST extension
id CDATA #IMPLIED
name CDATA #IMPLIED
point CDATA #REQUIRED>
- id - Optionale ID des Erweiterungsexemplars.
- name - Optionaler Name des Erweiterungsexemplars.
- point - Vollständig qualifizierte ID des Zielerweiterungspunkts.
<!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.
- value - Die eindeutige ID (Attribut
id
) des Elements "keyConfiguration", das anfänglich aktiv sein soll.
- keyConfigurationId - Die eindeutige ID (
id
attribute) des Elements 'keyConfiguration', die anfänglich aktiv sein sollte.
<!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.
- description - Eine übersetzbare kurze Beschreibung dieser Kategorie, die in der Benutzerschnittstelle angezeigt wird.
- id - Die eindeutige Kennung dieser Kategorie.
- name - Der übersetzbare Name dieser Kategorie, der in der Benutzerschnittstelle angezeigt wird.
<!ELEMENT command EMPTY>
<!ATTLIST command
category CDATA #IMPLIED
description CDATA #IMPLIED
id CDATA #REQUIRED
name CDATA #REQUIRED
categoryId 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.
- category - Die eindeutige ID für die Kategorie dieses Befehls. Wenn dieser Befehl keine Kategorie angibt, wird er trotzdem in allen Benutzerschnittstellen angezeigt, zusammen mit anderen speziell kategorisierten Befehlen.
@deprecated Please use "categoryId" instead.
- description - Eine übersetzbare kurze Beschreibung dieses Befehls, die in der Benutzerschnittstelle angezeigt wird.
- id - Die eindeutige Kennung dieses Befehls.
- name - Der übersetzbare Name dieses Befehls, der in der Benutzerschnittstelle angezeigt wird. Befehle werden normalerweise mit dem Infinitiv eines Verbs benannt.
- categoryId - The unique id of the category for this command. Wenn dieser Befehl keine Kategorie angibt, wird er trotzdem in allen Benutzerschnittstellen angezeigt, zusammen mit anderen speziell kategorisierten Befehlen.
<!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.
- configuration - Die eindeutige ID der Tastenkonfiguration für diese Tastenbelegung.
@veraltet Bitte benutzen Sie stattdessen 'keyConfigurationId'.
- command - Die eindeutige Kennung des Befehls, zu dem die Tastenkombination, die durch diese Tastenbelegung angegeben ist, zugeordnet wird. Wenn der Wert dieses Attributs eine leere Zeichenfolge ist, wird die Tastenkombination einem internen Befehl "no operation" zugeordnet. Dies ist hilfreich, um die Definition von Tastenbelegungen in spezifischen Tastenkonfigurationen und Kontexte rückgängig zu machen, die möglicherweise von ihren übergeordneten Elementen übernommen wurden.
@veraltet Bitte benutzen Sie stattdessen "commandId".
- locale - Ein optionales Attribut, mit dem angegeben wird, dass diese Tastenbelegung nur für die angegebene Ländereinstellung definiert wird. Ländereinstellungen werden gemäß dem Format angegeben, das in
java.util.Locale
deklariert ist.
- platform - Ein optionales Attribut, mit dem angegeben wird, dass diese Tastenbelegung nur für die angegebene Plattform definiert wird. Die gültigen Wert für das Attribut
platform
sind die gültigen Werte, die durch org.eclipse.swt.SWT.getPlatform()
zurückgegeben werden.
- contextId - Die eindeutige ID des Kontextes dieser Tastenbelegung.
- string - Die Tastenkombination, die dem Befehl zugeordnet werden soll. Tastenkombinationen bestehen aus einem oder mehreren Tastenanschlägen (ein Tastenanschlag gilt für eine Taste auf der Tastatur), die optional in Kombination mit einer oder mehreren der Änderungstasten Strg, Alt, Umschalttaste und Befehlstaste gedrückt werden. Tastenanschläge werden durch Leerzeichen, Änderungstasten werden durch das Pluszeichen (+) voneinander getrennt.
@veraltet Bitte benutzen Sie stattdessen "keySequence".
- scope - Die eindeutige ID des Kontextes dieser Tastenbelegung.
@veraltet Bitte benutzen Sie stattdessen "contextId".
- keyConfigurationId - Die eindeutige ID der Tastenkombination dieser Tastenbelegung.
- commandId - Die eindeutige Kennung des Befehls, zu dem die Tastenfolge, die durch diese Tastenbelegung angegeben ist, zugeordnet wird. Wenn der Wert dieses Attributs eine leere Zeichenfolge ist, wird die Tastenkombination einem internen Befehl "no operation" zugeordnet. Dies ist hilfreich, um die Definition von Tastenbelegungen in spezifischen Tastenkonfigurationen und Kontexte rückgängig zu machen, die möglicherweise von ihren übergeordneten Elementen übernommen wurden.
- keySequence - Die tastenfolgem die dem Befehl zugeorddnet werden soll. Tastenkombinationen bestehen aus einem oder mehreren Tastenanschlägen (ein Tastenanschlag gilt für eine Taste auf der Tastatur), die optional in Kombination mit einer oder mehreren der Änderungstasten Strg, Alt, Umschalttaste und Befehlstaste gedrückt werden. Tastenanschläge werden durch Leerzeichen, Änderungstasten werden durch das Pluszeichen (+) voneinander getrennt.
<!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.
- description - Eine übersetzbare kurze Beschreibung dieser Tastenkonfiguration, die in der Benutzerschnittstelle angezeigt wird.
- id - Die eindeutige Kennung dieser Tastenkonfiguration.
- name - Der übersetzbare Name dieser Tastenkonfiguration, der in der Benutzerschnittstelle angezeigt wird. Wenn es für diese Tastenkonfiguration ein übergeordnetes Element gibt, ist es nicht erforderlich, die Angabe"(extends ...)" zum Namen hinzuzufügen. Dies wird bei Bedarf von der Benutzerschnittstelle automatisch ausgeführt.
- parent - Die eindeutige ID der übergeordneten Tastenkonfiguration. Wenn es für diese Tastenkonfiguration ein übergeordnetes Element gibt, übernimmt sie, zusätzlich zu den Tastenbelegungen, die in ihrer eigenen Tastenkonfiguration definiert sind, alle Tastenbelegungen aus ihrem übergeordneten Element.
- parentId - Die eindeutige ID der übergeordneten Tastenkonfiguration. Wenn es für diese Tastenkonfiguration ein übergeordnetes Element gibt, übernimmt sie, zusätzlich zu den Tastenbelegungen, die in ihrer eigenen Tastenkonfiguration definiert sind, alle Tastenbelegungen aus ihrem übergeordneten Element.
<!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.
- description - Eine übersetzbare kurze Beschreibung dieses Kontextes, die in der Benutzerschnittstelle angezeigt wird.
- id - Die eindeutige Kennung dieses Kontextes.
- name - Der übersetzbare Name dieses Kontextes, der in der Benutzerschnittstelle angezeigt wird. Wenn es für diesen Kontext ein übergeordnetes Element gibt, ist es nicht erforderlich, die ANgabe "(extends parent)" zum Namen hinzuzufügen. Dies wird bei Bedarf von der Benutzerschnittstelle automatisch ausgeführt.
- parent - Die eindeutige ID des übergeordneten Kontextes. Wenn es für diesen Kontext ein übergeordnetes Element gibt, übernimmt er, zusätzlich zu den Tastenbelegungen, die in seinem eigenen Kontext definiert sind, alle Tastenbelegungen aus seinem übergeordneten Element.
@veraltet Bitte benutzen Sie stattdessen "parentId".
- parentId - Die eindeutige Kennung des übergeordneten Kontextes. Wenn es für diesen Kontext ein übergeordnetes Element gibt, übernimmt er, zusätzlich zu den Tastenbelegungen, die in seinem eigenen Kontext definiert sind, alle Tastenbelegungen aus seinem übergeordneten Element.
<!ELEMENT handlerSubmission EMPTY>
<!ATTLIST handlerSubmission
commandId CDATA #REQUIRED
handler CDATA #REQUIRED>
Mit diesem Element werden Steuerroutinen für einen Befehl deklariert. Diese Steuerroutine wird dann dem Befehl mit den angegebenen Einschränkungen zugeordnet. Diese Zuordnung erfolgt beim Systemstart. Die Zuordnung einer Steuerroutine bedeutet nicht, dass diese Steuerroutine immer von der Workbench ausgewählt wird; die eigentliche Auswahl erfolgt durch Untersuchung des Workbench-Status und durch Vergleich mit den verschiedenen Steuerroutine-Vorlagen.
Diese bestimmte API sollte weiterhin als experimentell betrachtet werden. Während Sie sie benutzen können, müssen Sie bereit sein, zu akzeptieren, dass sich diese API entscheidend ändern kann oder zu einem bestimmten Zeitpunkt in der Zukunft komplett entfernt wird. Wir schätzen ein Feedback zu dieser API zu platform-ui-dev@eclipse.org.
- commandId - Die Kennung des Befehls, dem diese Steuerroutine zugeordnet werden sollte.
- handler - Der Name der Klasse der Steuerroutine. Wenn die Klasse eine Implementierung von IExecutableExtension ist, dann ist die Übergabe von Daten in das Objekt möglich. Diese Steuerroutine wird mit einem Proxy versehen, wenn die Steuerroutine nach Informationen abgefragt wird -- bei welchem Punkt die Klasse geladen wird und ein Exemplar erstellt wird.
<!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".
- description - Eine übersetzbare kurze Beschreibung dieses Geltungsbereichs, die in der Benutzerschnittstelle angezeigt wird.
@veraltet Bitte benutzen Sie stattdessen den Erweiterungspunkt "org.eclipse.ui.contexts".
- id - Die eindeutige Kennung dieses Geltungsbereichs.
@veraltet Bitte benutzen Sie stattdessen den Erweiterungspunkt "org.eclipse.ui.contexts".
- name - Der übersetzbare Name dieses Geltungsbereichs, der in der Benutzerschnittstelle angezeigt wird. Wenn es für diesen Geltungsbereich ein übergeordnetes Element gibt, ist es nicht erforderlich, die Angabe "(extends parent)" zum Namen hinzuzufügen. Dies wird bei Bedarf von der Benutzerschnittstelle automatisch ausgeführt.
@veraltet Bitte benutzen Sie stattdessen den Erweiterungspunkt "org.eclipse.ui.contexts".
- parent - Die eindeutige Kennung des übergeordneten Geltungsbereichs. Wenn es für diesen Geltungsbereich ein übergeordnetes Element gibt, übernimmt er, zusätzlich zu den Tastenbelegungen, die in seinem eigenen Geltungsbereich definiert sind, alle Tastenbelegungen aus seinem übergeordneten Element.
@veraltet Bitte benutzen Sie stattdessen den Erweiterungspunkt "org.eclipse.ui.contexts".
Beispiele:
Die Datei plugin.xml
im Plug-in org.eclipse.ui
setzt den Erweiterungspunkt org.eclipse.ui.commands
intensiv ein.
API-Information:
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
.
Copyright (c) 2000, 2004 IBM Corporation und Andere.
Alle Rechte vorbehalten. Dieses Programm und sein Begleitmaterial werden gemäß
den Bedingungen der 'Common Public License v1.0' zur Verfügung gestellt, die diese Verteilung begleitet und
unter http://www.eclipse.org/legal/cpl-v10.html abgerufen
werden kann.