Erstellungsassistenten

Kennung: org.eclipse.ui.newWizards

Beschreibung: An diesem Erweiterungspunkt können Erweiterungen für Assistenten zur Ressourcenerstellung registriert werden. Erstellungsassistenten werden im Dialog "Neu" als Optionen angezeigt und in der Regel zum Erstellen neuer Projekte, Ordner und Dateien eingesetzt.

Im Dialog "Neu" sind die Assistenten in Kategorien aufgeteilt, die gewöhnlich eine bestimmte Aufgabendomäne darstellen. Beispielsweise könnte ein Java-orientiertes Plug-in eine Kategorie namens "Java" definieren, die für Assistenten zur Erstellung von Klassen oder Paketen geeignet ist. Auf die Kategorien, die durch ein Plug-in definiert werden, können andere Plug-ins über das Attribut 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 category EMPTY>
   <!ATTLIST category
      id             CDATA #REQUIRED
      name           CDATA #REQUIRED
      parentCategory CDATA #IMPLIED
   >

   <!ELEMENT wizard (description)?>
   <!ATTLIST wizard
      id                 CDATA #REQUIRED
      name               CDATA #REQUIRED
      icon               CDATA #IMPLIED
      category           CDATA #IMPLIED
      class              CDATA #REQUIRED
      project            (true | false) #IMPLIED
      finalPerspective   CDATA #OPTIONAL
   >
   <!ELEMENT description (#PCDATA)>    <!ELEMENT selection EMPTY>
   <!ATTLIST selection
      class  CDATA #REQUIRED
      name   CDATA #OPTIONAL
   > Beispiele:

Im Folgenden ist ein Beispiel für die Konfiguration eines Erstellungsassistenten dargestellt:

   <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>
      </wizard>
   </extension>

API-Informationen:Der Wert des Attributs class muss eine Klasse sein, die org.eclipse.ui.INewWizard implementiert. Wenn 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 (über das Menü "Datei > Neu" oder eine Schaltfläche in der Symbolleiste) gestartet wird, wird er als separates Dialogfenster eigenständig angezeigt.

Das Attribut finalPerspective gibt eine Perspektive an, die aktiviert werden soll, wenn die Erstellung der Ressource "IProject" in der Assistentenklasse fertig gestellt ist. Die Aktivierung dieser Perspektive sollte gemäß den Workbench-Benutzervorgaben interpretiert werden, die durch "IWorkbenchPreferenceConstants.PROJECT_OPEN_NEW_PERSPECTIVE" definiert sind. Dies kann bedeuten, dass die Perspektive in einem neuen Fenster, im aktuellen Fenster oder als Ersatz für die aktuelle Perspektive geöffnet oder aber keine Aktion ausgeführt wird. Dies ist zwar lediglich ein Hinweis, aber Entwickler sollten diesen Hinweis lesen oder aktivieren. Alternativ kann auch die API "BasicNewProjectResourceWizard#updatePerspective(IConfigurationElement)" aufgerufen werden, die diese Arbeit übernimmt.

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 IBM Corp. 2000, 2001. Alle Rechte vorbehalten.