Commandes
Identificateur : org.eclipse.ui.commands
Depuis la
version 2.1
Description :
Le point d'extension
org.eclipse.ui.commands
déclare des commandes et des
catégories de commande à l'aide des é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 basées sur des
configurations et des portées de touches également déclarées ici à l'aide
des éléments keyConfiguration
et scope
.
Marques de configuration :
<!ELEMENT extension (activeKeyConfiguration , category , command , keyBinding , keyConfiguration , scope)>
<!ATTLIST extension
id CDATA #IMPLIED
name CDATA #IMPLIED
point CDATA #REQUIRED
>
- id - identificateur facultatif de l'instance d'extension.
- name - nom facultatif de l'instance d'extension.
- point - identificateur qualifié complet du point d'extension
cible.
<!ELEMENT activeKeyConfiguration EMPTY>
Cet élément définit la configuration de touches initiale
d'Eclipse. En présence de plusieurs éléments, seul le dernier déclaré
(dans l'ordre de lecture du registre des plug-in) est pris en compte.
<!ATTLIST activeKeyConfiguration
value CDATA #IMPLIED
>
- value - ID unique (
id
attribute) de l'élément
keyConfiguration qui doit être initialement actif.
<!ELEMENT category EMPTY>
Pour en faciliter la gestion, les commandes sont souvent
regroupées par catégories dans l'interface utilisateur. 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-in) est pris en compte.
<!ATTLIST category
description CDATA #IMPLIED
id CDATA
#REQUIRED
nom CDATA #REQUIRED
>
- description - description traduisible de la catégorie, qui
s'affiche dans l'interface utilisateur.
- id - identificateur unique de cette catégorie.
- name - nom traduisible de la catégorie, qui s'affiche dans
l'interface utilisateur.
<!ELEMENT command EMPTY>
Cet élément définit des commandes. Une commande correspond
à une demande de l'utilisateur pouvant être traitée par une action et don
tla 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-in) 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.
<!ATTLIST command
category CDATA #IMPLIED
description CDATA #IMPLIED
icon CDATA #IMPLIED
id CDATA
#REQUIRED
name CDATA #REQUIRED
>
- category - ID unique de la catégorie de cette commande. Si
cette commande ne précise pas de catégorie, elle apparaît dans toutes les
interface utilisateur, avec les autres commandes classées en catégories.
- description - description traduisible de la commande, qui
s'affiche dans l'interface utilisateur.
- icon -
- id - identificateur unique de cette commande.
- name - nom traduisible de la commande, qui s'affiche dans
l'interface utilisateur. L'intitulé d'une commande est généralement un
verbe.
<!ELEMENT keyBinding EMPTY>
Cet élément attribue des séquences de touches aux
commandes.
<!ATTLIST keyBinding
configuration CDATA #REQUIRED
command CDATA #IMPLIED
locale CDATA #IMPLIED
platform CDATA #IMPLIED
scope CDATA #REQUIRED
string CDATA #REQUIRED
>
- configuration - ID unique de la configuration de touches de
cette liaison de touches.
- command - identificateur unique de la commande à laquelle la
séquence de touche indiquée par cette liaison de touches est affectée. Si
la valeur de cet attribut est une chaîne vide, la séquence de touches
est affectée à une commande interne 'no operation'. Particulièrement
utilise pour les liaisons de touches 'undefining' de configurations et
portées de touches spécifiques retirées à leurs parents.
- locale - attribut facultatif indiquant que cette liaison de
touches n'est définie que pour l'environnement local spécifié. Les
environnements locaux sont spécifiés en fonction du format déclaré dans
java.util.Locale
.
- platform - attribut facultatif indiquant que cette liaison de
touches n'est définie que pour la plateforme spécifiée. Les valeurs
possibles de l'attribut
platform
sont celles renvoyées par
org.eclipse.swt.SWT.getPlatform()
.
- scope - ID unique de la portée de cette liaison de touches.
- string - séquence de touches à affecter à la commande. Les
séquences de touches se composent d'une ou plusieurs activation de touche,
correspondant à l'activation d'une touche du clavier éventuellement
associée à l'une des touches suivantes : Ctrl, Alt, Shift ou Command.
Les activations de touche sont séparées par un espace et les touches
associées par le caractère '+'.
<!ELEMENT keyConfiguration EMPTY>
Cet élément définit 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-in) est pris
en compte.
<!ATTLIST keyConfiguration
description CDATA #IMPLIED
id CDATA
#REQUIRED
name CDATA #REQUIRED
parent CDATA #IMPLIED
>
- description - description traduisible de cette configuration de
touches, qui s'affiche dans l'interface utilisateur.
- id - identificateur unique de cette configuration de touches.
- name - nom traduisible de cette configuration de touches, qui
s'affiche dans l'interface utilisateur. Si cette configuration de touches
a un parent, il est inutile d'ajouter "(extends ...)" au nom. Cet élément
est, au besoin, automatiquement ajouté par l'interface utilisateur.
- parent - ID unique du parent de cette configuration de touches.
Si la configuration de touches a un parent, elle emprunte toutes les
liaisons de touches de ce parent, en plus des liaisons définies dans sa
propre configuration de touches.
<!ELEMENT scope EMPTY>
Cet élément définit 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-in) est pris en
compte.
<!ATTLIST scope
description CDATA #IMPLIED
id CDATA
#REQUIRED
name CDATA #REQUIRED
parent CDATA #IMPLIED
>
- description - description traduisible de la portée, qui
s'affiche dans l'interface utilisateur.
- id - identificateur unique de cette portée.
- name - nom traduisible de la portée, qui s'affiche dans
l'interface utilisateur. Si cette portée a un parent, il est inutile
d'ajouter "(extends parent)" au nom. Cet élément est, au besoin,
automatiquement ajouté par l'interface utilisateur.
- parent - ID unique de la portée du parent. Si la portée a un
parent, elle emprunte toutes les liaisons de touches de ce parent, en plus
des liaisons définies dans sa propre portée.
Exemples :
Le fichier plugin.xml
du plug-in org.eclipse.ui
utilise extensivement le point d'extension
org.eclipse.ui.commands
.
Informations d'API:
Il n'existe pas d'API publiques de déclaration de commandes, catégories,
liaison de touches, configurations de touches ou portées hormis ce point
d'extension. Les API publiques de requête et de définition de portées,
ainsi que d'enregistrement d'actions pour le traitement de commandes
spécifiques se trouvent dans
org.eclipse.ui.IKeyBindingService
.
Copyright (c) 2000, 2003 IBM Corporation and others.
All rights reserved. Ce programme et les produits qui l'accompagnent sont
fournis sous licence v1.0 associée à cette distribution et disponibles à
l'adresse suivante :
http://www.eclipse.org/legal/cpl-v10.html