Commandes

org.eclipse.ui.commands

2.1

Le point d'extension org.eclipse.ui.commands sert à déclarer des commandes et des catégories de commandes avec les éléments command et category. Il permet également d'affecter des séquences de touches à des commandes à l'aide de l'élément keyBinding. Les séquences de touches sont liées à des commandes en fonction des configurations et des contextes de touches déclarés ici à l'aide des éléments keyConfiguration et context.

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

<!ATTLIST extension

id    CDATA #IMPLIED

name  CDATA #IMPLIED

point CDATA #REQUIRED>


<!ELEMENT activeKeyConfiguration EMPTY>

<!ATTLIST activeKeyConfiguration

value              CDATA #IMPLIED

keyConfigurationId CDATA #IMPLIED>

Cet élément sert à définir la configuration de touche active initiale pour Eclipse. En présence de plusieurs éléments, seul le dernier déclaré (dans l'ordre de lecture du registre des plug-ins) est pris en compte.



<!ELEMENT category EMPTY>

<!ATTLIST category

description CDATA #IMPLIED

id          CDATA #REQUIRED

name         CDATA #REQUIRED>

Dans l'interface utilisateur, les commandes sont souvent organisées par catégories afin de les rendre plus accessibles. Cet élément permet de définir ces catégories. Une commande ne peut appartenir qu'à une catégorie. Si le même attribut id contient plusieurs de ces éléments, seul le dernier déclaré (dans l'ordre de lecture du registre des plug-ins) est pris en compte.



<!ELEMENT command EMPTY>

<!ATTLIST command

category    CDATA #IMPLIED

description CDATA #IMPLIED

id          CDATA #REQUIRED

name        CDATA #REQUIRED

categoryId  CDATA #IMPLIED>

Cet élément est employé pour définir des commandes. Une commande correspond à une demande de l'utilisateur pouvant être traitée par une action et dont la syntaxe doit être unique comparée à celle des autres commandes. Ne définissez pas une commande s'il en existe déjà une ayant le même objectif. Si le même attribut id contient plusieurs de ces éléments, seul le dernier déclaré (dans l'ordre de lecture du registre des plug-ins) est pris en compte. Pour comprendre comment les actions sont liées aux commandes, reportez-vous aux points d'extension org.eclipse.ui.actionSets et 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>

Cet élément permet d'assigner des séquences de touches à des commandes.



<!ELEMENT keyConfiguration EMPTY>

<!ATTLIST keyConfiguration

description CDATA #IMPLIED

id          CDATA #REQUIRED

name        CDATA #REQUIRED

parent      CDATA #IMPLIED

parentId    CDATA #IMPLIED>

Cet élément est employé pour définir des configurations de touches. Si le même attribut id contient plusieurs de ces éléments, seul le dernier déclaré (dans l'ordre de lecture du registre des plug-ins) est pris en compte.



<!ELEMENT context EMPTY>

<!ATTLIST context

description CDATA #IMPLIED

id          CDATA #REQUIRED

name        CDATA #REQUIRED

parent      CDATA #IMPLIED

parentId    CDATA #IMPLIED>

Cet élément est employé pour définir des contextes. Si le même attribut id contient plusieurs de ces éléments, seul le dernier déclaré (dans l'ordre de lecture du registre des plug-ins) est pris en compte.



<!ELEMENT handlerSubmission EMPTY>

<!ATTLIST handlerSubmission

commandId CDATA #REQUIRED

handler   CDATA #REQUIRED>

Cet élément déclare un gestionnaire pour une commande. Ce gestionnaire est ensuite associé à la commande avec les restrictions données. L'association a lieu au démarrage. L'association d'un gestionnaire ne signifie pas qu'il sera toujours celui choisi par le plan de travail. Le choix est en effet effectué en examinant l'état du plan de travail et en le comparant aux différentes soumissions de gestionnaires.

Cette API doit toujours être considérée expérimentale. Même si vous l'utilisez, vous devez accepter qu'elle peut changer totalement ou être entièrement supprimée à un moment donné. Merci de nous faire part de vos commentaires sur cette API à l'adresse platform-ui-dev@eclipse.org.



<!ELEMENT scope EMPTY>

<!ATTLIST scope

description CDATA #IMPLIED

id          CDATA #REQUIRED

name        CDATA #REQUIRED

parent      CDATA #IMPLIED>

Cet élément est employé pour définir des portées. Si le même attribut id contient plusieurs de ces éléments, seul le dernier déclaré (dans l'ordre de lecture du registre des plug-ins) est pris en compte. @déconseillé, utilisez le point d'extension "org.eclipse.ui.contexts" à la place.



Le fichier plugin.xml du plug-in org.eclipse.ui utilise de façon extensive le point d'extension org.eclipse.ui.commands.

Il n'existe pas d'API publiques de déclaration de commandes, catégories, liaison de touches, configurations de touches ou contextes hormis ce point d'extension. Les API publiques de requête et de définition de contextes, ainsi que d'enregistrement d'actions pour le traitement de commandes spécifiques se trouvent dans org.eclipse.ui.IKeyBindingService.