Creation Wizards

Identifier:
org.eclipse.ui.newWizards

Description:
This extension point is used to register resource creation wizard extensions. Creation wizards appear as choices within the "New Dialog", and are typically used to create folders and files.

In the "New Dialog", wizards are organized into categories which usually reflect a particular problem domain. For instance, a Java oriented plugin may define a category called "Java" which is appropriate for "Class" or "Package" creation wizards. The categories defined by one plug-in can be referenced by other plug-ins using the category attribute. Uncategorized wizards, as well as wizards with invalid category paths, will end up in an "Other" category.

Wizards may optionally specify a description subelement whose body should contain short text about the wizard.

Configuration Markup:

<!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 IDREF #IMPLIED>


<!ELEMENT wizard (description? , selection* , keywordReference*)>

<!ATTLIST wizard

id                    CDATA #REQUIRED

name                  CDATA #REQUIRED

icon                  CDATA #IMPLIED

category              CDATA #IMPLIED

class                 CDATA #REQUIRED

project               (true | false)

finalPerspective      IDREF #IMPLIED

preferredPerspectives CDATA #IMPLIED

helpHref              CDATA #IMPLIED

descriptionImage      CDATA #IMPLIED

canFinishEarly        (true | false)

hasPages              (true | false) >


<!ELEMENT description (#PCDATA)>

an optional subelement whose body contains a short text describing what the wizard will do when started



<!ELEMENT selection EMPTY>

<!ATTLIST selection

class CDATA #REQUIRED

name  CDATA #IMPLIED>


<!ELEMENT primaryWizard EMPTY>

<!ATTLIST primaryWizard

id IDREF #REQUIRED>

a means of declaring that a wizard is "primary" in the UI. A primary wizard is emphasized in the new wizard dialog. Please note that this element is not intended to be used by plug in developers! This element exists so that product managers may emphasize a set of wizards for their products.



<!ELEMENT keywordReference EMPTY>

<!ATTLIST keywordReference

id IDREF #REQUIRED>

A reference by a New Wizard to a keyword. See the keywords extension point.



Examples:
Following is an example of creation wizard configuration:


   <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.png"
          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:
The value of the class attribute must represent a class that implements org.eclipse.ui.INewWizard. If the wizard is created from within the New Wizard it will be inserted into the existing wizard. If the wizard is launched as a shortcut (from the File New menu or a toolbar button) it will appear standalone as a separate dialog box.

Supplied Implementation:
The workbench comes with wizards for creating empty resources of the following types: project, folder and file. These wizards are registered using the same mechanism as described above. Additional wizards may also appear, subject to particular platform installation.


Copyright (c) 2002, 2005 IBM Corporation and others.
All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html