Assistants de création
Identificateur :
org.eclipse.ui.newWizards
Description :
Ce point
d'extension sert à enregistrer des extensions de l'assistant de
création de ressources. Les
assistants de création apparaissent en tant qu'options dans la boîte
de dialogue Nouveau et sont généralement utilisés pour créer des
projets et des fichiers.
Dans la boîte de dialogue Nouveau, les assistants sont organisés en
catégories qui reflètent généralement un domaine de problème particulier. Par exemple, un plug-in Java peut définir une catégorie appelée "Java",
appropriée aux assistants de création de classe ou de package. Les
catégories définies par un plug-in peuvent être référencées par d'autres
plug-ins à l'aide de l'attribut catégorie. Les assistants sans catégorie,
ainsi que ceux dotés de chemins d'accès à une catégorie incorrecte,
finissent dans une catégorie "Autre".
En option, les assistants peuvent spécifier un sous-élément de description dont le corps doit contenir un court texte sur l'assistant.
Marques de configuration :
<!ELEMENT extension (category | wizard | primaryWizard)*>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
- point - identificateur qualifié complet du point d'extension
cible.
- id - identificateur facultatif de l'instance d'extension.
- name - nom facultatif de l'instance d'extension.
<!ELEMENT
category EMPTY>
<!ATTLIST category
id CDATA #REQUIRED
name CDATA #REQUIRED
parentCategory CDATA #IMPLIED>
- id - un nom unique pouvant être utilisé pour identifier cette
catégorie.
- name - nom traduisible de la catégorie qui sera utilisé dans la
boîte de dialogue.
- parentCategory - chemin à une autre catégorie si cette
catégorie doit être ajoutée en tant qu'enfant.
<!ELEMENT wizard (description? , selection*)>
<!ATTLIST wizard
id CDATA #REQUIRED
name CDATA #REQUIRED
icon CDATA #IMPLIED
category CDATA #IMPLIED
class CDATA #REQUIRED
project (true | false)
finalPerspective CDATA #IMPLIED
preferredPerspectives CDATA #IMPLIED
helpHref CDATA #IMPLIED
descriptionImage CDATA #IMPLIED
canFinishEarly (true | false)
hasPages (true | false) >
- id - nom unique pouvant être utilisé pour identifier cet
assistant.
- name - un nom traduisible de l'assistant qui sera utilisé dans
la boîte de dialogue.
- icon - chemin d'accès relatif d'une icône utilisée avec le nom
pour représenter l'assistant comme l'une des options dans la boîte de
dialogue de création.
- category - chemin d'accès délimité par des barres
obliques (/) d'ID de catégorie. Chaque jeton du chemin d'accès doit représenter un ID catégorie valide, défini précédemment par ce plug-in ou par un autre. S'il n'est pas indiqué, l'assistant sera ajouté à la catégorie "Autre".
- classest le nom complet qualifié de la classe Java qui implémente
org.eclipse.ui.INewWizard.
- project - attribut facultatif indiquant que
l'assistant va créer une ressource IProject.
Entraîne également l'apparition de l'assistant comme option dans la boîte
de dialogue Nouveau projet.
- finalPerspective - attribut facultatif qui identifie une perspective à activer lorsque la création de la ressource IProject est terminée.
- preferredPerspectives - attribut facultatif désignant une liste
d'ID de perspective séparés par des virgules. Si la perspective courante
figure dans cette liste, aucune perspective n'est activée lorsque la
création de la ressource IProject est terminée.
- helpHref - URL d'aide pouvant décrire cet assistant en
détail.
Depuis 3.0
- descriptionImage - image plus grande pouvant décrire
cet assistant.
Depuis 3.0
- canFinishEarly - selon que l'assistant est capable de finir sans jamais montrer les pages à l'utilisateur ou non.
- hasPages - selon que l'assistant fournit des pages ou non.
<!ELEMENT description (#PCDATA)>
un sous-élément facultatif dont le corps contient une brève
description de ce que l'assistant fera au démarrage.
<!ELEMENT
selection EMPTY>
<!ATTLIST selection
class CDATA #REQUIRED
name CDATA #IMPLIED>
- class - nom complet qualifié de classe. Si chaque objet de la
sélection du plan de travail implémente cette interface, la sélection est
transmise à l'assistant. Sinon, une sélection vide est transmise.
- name - filtre de nom facultatif. Chaque objet de la sélection
du plan de travail doit correspondre au filtre de nom pour être transmis à
l'assistant.
<!ELEMENT primaryWizard EMPTY>
<!ATTLIST primaryWizard
id CDATA #REQUIRED>
un moyen de déclarer qu'un assistant est "primaire" dans l'interface
utilisateur. Un assistant primaire est mis en évidence dans la
nouvelle boîte de dialogue d'assistant. Cet élément n'est pas conçu
pour être utilisé par des développeurs de plug-ins. Il est fourni
pour que les gestionnaires du produit puissent mettre en évidence une
série d'assistants pour leurs produits.
- id - ID d'un assistant devant être primaire.
Exemples :
L'exemple
ci-dessous illustre la configuration d'un assistant de création :
<extension point=
"org.eclipse.ui.newWizards"
>
<category
id=
"com.xyz.XYZ"
name=
"Assistant XYZ"
>
</category>
<category
id=
"com.xyz.XYZ.Web"
name=
"Assistants Web"
parentCategory=
"com.xyz.XYZ"
>
</category>
<wizard
id=
"com.xyz.wizard1"
name=
"Artefact XYZ"
category=
"com.xyz.XYZ/com.xyz.XYZ.Web"
icon=
"./icons/XYZwizard1.gif"
class=
"com.xyz.XYZWizard1"
>
<description>
Créer un artefact XYZ et définir le contenu initial
</description>
<selection class=
"org.eclipse.core.resources.IResource"
/>
</wizard>
</extension>
Informations d'API :
La
valeur de l'attribut class doit correspondre à la classe implémentant
org.eclipse.ui.INewWizard.
Si l'assistant est créé à partir de Nouveaux assistants, il sera inséré
dans l'assistant existant.
S'il est lancé comme raccourci (à partir du menu Assistant Nouveau fichier
ou d'un bouton de la barre d'outils), il apparaît de manière autonome dans
une boîte de dialogue distincte.
Implémentation fournie :
Le
plan de travail est fourni avec des assistants pour créer des
ressources vides de type projet, dossier et fichier. Ces assistants sont enregistrés à l'aide d'un mécanisme identique à celui décrit ci-dessus.
D'autres assistants peuvent également apparaître, en fonction de l'installation d'une plateforme particulière.
Copyright (c) 2002, 2004 IBM Corporation and others.
All rights reserved. Ce programme et les produits associés sont distribués sous licence Eclipse v1.0 et disponibles à l'adresse suivante :http://www.eclipse.org/legal/epl-v10.html