Erstellungsassistenten

org.eclipse.ui.newWizards

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.

<!ELEMENT extension (category | wizard | primaryWizard)*>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT category EMPTY>

<!ATTLIST category

id             CDATA #REQUIRED

name           CDATA #REQUIRED

parentCategory CDATA #IMPLIED>


<!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) >


<!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>


<!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.



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>

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.

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.