Erstellungsassistenten
Kennung:
org.eclipse.ui.newWizards
Beschreibung:
An diesem Erweiterungspunkt können Erweiterungen für Assistenten für Ressourcenerstellung registriert werden. Erstellungsassistenten werden im Dialog "Neu"
als Optionen
angezeigt und in der Regel zum Erstellen von Ordnern und
Dateien eingesetzt.
Im Dialog "Neu" sind die Assistenten in Kategorien zusammengefasst,
die in der Regel einen bestimmten Problembereich darstellen. Ein Java-orientiertes Plug-in könnte beispielsweise eine Kategorie
namens "Java" definieren, die für die Assistenten zur Erstellung von
Klassen oder Paketen dienen soll. Auf die Kategorien, die durch ein Plug-in definiert werden, können
andere Plug-ins unter Verwendung des Attributs "category" verweisen. Nicht kategorisierte Assistenten werden - ebenso wie Assistenten mit
ungültigen Kategoriepfaden - der Kategorie "Andere" zugeordnet.
Assistenten können optional ein Unterelement für eine Beschreibung
angeben, dessen Hauptteil einen kurzen Text
über den Assistenten enthalten sollte.
Konfigurationsbefehle:
<!ELEMENT extension (category | wizard | primaryWizard)*>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
- point - Vollständig qualifizierte ID des Zielerweiterungspunktes
- id - Optionale ID des Erweiterungsexemplars
- name - Optionaler Name des Erweiterungsexemplars
<!ELEMENT category EMPTY>
<!ATTLIST category
id CDATA #REQUIRED
name CDATA #REQUIRED
parentCategory CDATA #IMPLIED>
- id - Ein eindeutiger Name, mit dem diese Kategorie angegeben werden kann.
- name - Ein übersetzbarer Name der Kategorie, der im Dialogfenster verwendet wird.
- parentCategory - Ein Pfad zu einer anderen Kategorie, wenn diese Kategorie als untergeordnetes Element hinzugefügt werden soll.
<!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 - Ein eindeutiger Name, mit dem dieser Assistent angegeben werden kann.
- name - Ein übersetzbarer Name des Assistenten, der im
Dialogfenster verwendet wird.
- icon - Der relative Pfad eines Symbols, das zusammen mit
dem Namen zur Darstellung des Assistenten als eine der Auswahlmöglichkeiten im Dialogfenster für die Erstellung verwendet wird.
- category - Ein durch Schrägstrich (/) begrenzter Pfad aus
Kategorie-IDs. Jedes Token im Pfad muss eine gültige Kategorie-ID
darstellen, die zuvor durch dieses oder ein anderes Plug-in definiert
wurde. Wenn dieses Attribut übergangen wird, wird der Assistent zur
Kategorie "Andere" hinzugefügt.
- class - Der vollständig qualifizierte Name einer
Java-Klasse, die
org.eclipse.ui.INewWizard implementiert.
- project - Ein optionales Attribut, mit dem angegeben wird, dass
der Assistent eine Ressource des Typs "IProject" erstellt.
Es bewirkt außerdem, dass der Assistent im Dialog "Neues Projekt" als Option angezeigt wird.
- finalPerspective - Ein optionales Attribut, mit dem eine
Perspektive angegeben wird, die aktiviert werden soll, wenn die
Erstellung der Ressource "IProject" fertig gestellt ist.
- preferredPerspectives - Ein optionales Attribut, das eine
durch Kommata gegliederte Liste von Perspektiven-IDs enthält. Wenn die aktuelle Perspektive in dieser Liste enthalten ist, wird
nach der abgeschlossenen Erstellung einer Ressource "IProject" keine Perspektive aktiviert.
- helpHref - Eine Hilfe-URL, durch die dieser Assistent detailliert beschrieben werden kann.
Seit 3.0
- descriptionImage - Ein größeres Bild, das bei der Beschreibung dieses Assistenten behilflich sein kann.
Seit 3.0
- canFinishEarly - Zeigt an, ob der Assistent in der Lage ist, zu enden, ohne dem Benutzer Seiten angezeigt zu haben.
- hasPages - Zeigt an, ob der Assistent Seiten bereitstellt.
<!ELEMENT description (#PCDATA)>
Ein optionales Unterelement, dessen Hauptteil in einem kurzen Text beschreibt, was der Assistent ausführt, wenn er
gestartet wird.
<!ELEMENT selection EMPTY>
<!ATTLIST selection
class CDATA #REQUIRED
name CDATA #IMPLIED>
- class - Ein vollständig qualifizierter Klassenname. Wenn
alle Objekte in der Workbenchauswahl diese Schnittstelle
implementieren, wird die Auswahl an den Assistenten übergeben. Andernfalls wird eine leere Auswahl übergeben.
- name - Ein optionaler Namensfilter. Alle Objekte in der
Workbenchauswahl müssen mit dem Namensfilter übereinstimmen, damit die Auswahl an den Assistenten übergeben wird.
<!ELEMENT primaryWizard EMPTY>
<!ATTLIST primaryWizard
id CDATA #REQUIRED>
Ein Mittel um zu deklarieren, dass ein Assistent in der Benutzerschnittstelle "primär" ist. Ein primärer Assistent wird im Dialog 'Neuer Assistent' hervorgehoben. Bitte beachten Sie, dass dieses Element nicht für die Verwendung durch Plug-in-Entwickler vorgesehen ist! Dieses Element existiert nur, damit Produktmanager eine Reihe von Assistenten für ihre Produkte hervorheben können.
- id - Die ID eines Assistenten, der zu einem primären Assistenten gemacht werden sollte.
Beispiele:
Das folgende Beispiel stellt die Konfiguration eines
Erstellungsassistenten dar:
<extension point=
"org.eclipse.ui.newWizards"
>
<category
id=
"com.xyz.XYZ"
name=
"XYZ Wizards"
>
</category>
<category
id=
"com.xyz.XYZ.Web"
name=
"Web Wizards"
parentCategory=
"com.xyz.XYZ"
>
</category>
<wizard
id=
"com.xyz.wizard1"
name=
"XYZ artifact"
category=
"com.xyz.XYZ/com.xyz.XYZ.Web"
icon=
"./icons/XYZwizard1.gif"
class=
"com.xyz.XYZWizard1"
>
<description>
Create a simple XYZ artifact and set initial content
</description>
<selection class=
"org.eclipse.core.resources.IResource"
/>
</wizard>
</extension>
API-Information:
Der Wert des Attributs 'class' muss eine Klasse
darstellen, die org.eclipse.ui.INewWizard implementiert.
Falls der Assistent aus dem Assistenten für neue Ressourcen heraus
erstellt wird, wird er in den vorhandenen Assistenten eingefügt.
Wird der Assistent als Direktaufruf gestartet (über das Menü "Datei > Neu" oder eine Schaltfläche in der Symbolleiste), wird er
eigenständig in einem separaten Dialogfenster angezeigt.
Bereitgestellte Implementierung:
Bei der
Auslieferung enthält die Workbench bereits Assistenten für die Erstellung leerer Ressourcen der folgenden Typen: Projekt, Ordner
und Datei. Diese Assistenten werden mit demselben Mechanismus registriert, der
oben beschrieben wurde.
Abhängig von der speziellen Installation der Plattform können weitere
Assistenten hinzukommen.
Copyright (c) 2002, 2004 IBM Corporation and others.
Alle Rechte vorbehalten. Dieses Programm und sein Begleitmaterial werden gemäß den Bedingungen der "Eclipse Public License v1.0" zur Verfügung gestellt, die dieser Lieferung beiliegt und unter
http://www.eclipse.org/legal/epl-v10.html abgerufen werden kann.