Commandes
Identificateur :
org.eclipse.ui.commands
Depuis :
2.1
Description :
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
.
Marques de configuration :
<!ELEMENT extension (activeKeyConfiguration , category , command , keyBinding , keyConfiguration , context)>
<!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>
<!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.
- value - ID unique (
id
attribute) de l'élément
keyConfiguration qui doit être initialement actif.
- keyConfigurationId - ID unique (
id
attribute)
de l'élément keyConfiguration que vous souhaitez actif à
l'origine.
<!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.
- 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>
<!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.
- 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.
@déconseillé, utilisez "categoryId" à la place.
- description - description traduisible de la commande, qui
s'affiche dans l'interface utilisateur.
- 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.
- categoryId - ID unique de la catégorie pour 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.
<!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.
- configuration - ID unique de la configuration de touches de
cette liaison de touches.
@déconseillé, utilisez keyConfigurationId à la place.
- 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 contextes de touches spécifiques retirés à leurs parents.
@déconseillé,
utilisez "commandId" à la place.
- 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()
.
- contextId - ID unique du contexte 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, Maj ou Commande. Les activations de touche sont séparées par un espace et les touches
associées par le caractère '+'.
@déconseillé, utilisez "keySequence" à la place.
- scope - ID unique du contexte de cette liaison de
touches.
@déconseillé, utilisez "contextId" à la place.
- keyConfigurationId - ID unique de la configuration de
touche de cette liaison de touches.
- commandId - identificateur unique de la commande à
laquelle la séquence de touches indiquée par cette liaison de
touches est assigné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 contextes de touches spécifiques retirés à leurs parents.
- keySequence - séquence de touches à assigner à 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, Maj ou Commande. Les activations de touche sont séparées par un espace et les touches
associées par le caractère '+'.
<!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.
- 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.
- parentId - ID unique de la configuration de touches
parent. 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 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.
- description - brève description traduisible de ce contexte
pour affichage dans l'interface utilisateur.
- id - identificateur unique de ce contexte.
- name - nom traduisible de ce contexte pour
affichage dans l'interface utilisateur. Si ce contexte possède 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 du contexte parent. Si ce contexte
possède un parent, il emprunte toutes les liaisons de touches de ce
parent en plus de celles définies dans son propre contexte.
@déconseillé,
utilisez "parentId" à la place.
- parentId - ID unique du contexte parent. Si ce contexte
possède un parent, il emprunte toutes les liaisons de touches de ce
parent en plus de celles définies dans son propre contexte.
<!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.
- commandId - identificateur de la commande à laquelle le
gestionnaire doit être associé.
- handler - nom de la classe du gestionnaire. Si la classe
est une implémentation de IExecutableExtension, il est possible de
transmettre des données dans l'objet. Ce gestionnaire servira de
proxy tant qu'il n'est pas sollicité pour des informations. A ce
moment-là, la classe est chargée et une instance est créée.
<!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.
- description - description traduisible de la portée, qui
s'affiche dans l'interface utilisateur.
@déconseillé, utilisez le point d'extension "org.eclipse.ui.contexts"
à la place.
- id - identificateur unique de cette portée.
@déconseillé, utilisez le point d'extension "org.eclipse.ui.contexts"
à la place.
- 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.
@déconseillé, utilisez le point d'extension "org.eclipse.ui.contexts"
à la place.
- 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.
@déconseillé, utilisez le point d'extension "org.eclipse.ui.contexts"
à la place.
Exemples :
Le fichier plugin.xml
du plug-in org.eclipse.ui
utilise de façon extensive 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 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
.
Copyright (c) 2000, 2004 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