| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| </HEAD> |
| <HTML> |
| <BODY> |
| <H1><CENTER>Creation Wizards</CENTER></H1> |
| <b><i>Identifier: </i></b>org.eclipse.ui.newWizards<p> |
| <b><i>Description: </i></b>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. |
| <p> |
| 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. |
| <p> |
| Wizards may optionally specify a description subelement whose body should contain short text about the wizard.<p><b><i>Configuration Markup:</i></b><p> |
| <p><samp> <!ELEMENT extension (category | wizard)*></samp> |
| <br><br><samp> <!ATTLIST extension</samp> |
| <br><samp> point CDATA #REQUIRED</samp> |
| <br><samp> id CDATA #IMPLIED</samp> |
| <br><samp> name CDATA #IMPLIED</samp> |
| <br><samp> ></samp> |
| <ul> |
| <li><b>point</b> - a fully qualified identifier of the target extension point</li><li><b>id</b> - an optional identifier of the extension instance</li><li><b>name</b> - an optional name of the extension instance</li></ul> |
| <p><samp> <!ELEMENT category EMPTY></samp> |
| <br><br><samp> <!ATTLIST category</samp> |
| <br><samp> id CDATA #REQUIRED</samp> |
| <br><samp> name CDATA #REQUIRED</samp> |
| <br><samp> parentCategory CDATA #IMPLIED</samp> |
| <br><samp> ></samp> |
| <ul> |
| <li><b>id</b> - a unique name that can be used to identify this category</li><li><b>name</b> - a translatable name of the category that will be used in the dialog box</li><li><b>parentCategory</b> - a path to another category if this category should be added as a child</li></ul> |
| <p><samp> <!ELEMENT wizard (description? , selection*)></samp> |
| <br><br><samp> <!ATTLIST wizard</samp> |
| <br><samp> id CDATA #REQUIRED</samp> |
| <br><samp> name CDATA #REQUIRED</samp> |
| <br><samp> icon CDATA #IMPLIED</samp> |
| <br><samp> category CDATA #IMPLIED</samp> |
| <br><samp> class CDATA #REQUIRED</samp> |
| <br><samp> finalPerspective CDATA #IMPLIED</samp> |
| <br><samp> project (true | false) "false"#IMPLIED</samp> |
| <br><samp> ></samp> |
| <ul> |
| <li><b>id</b> - a unique name that can be used to identify this wizard</li><li><b>name</b> - a translatable name of the wizard that will be used in the dialog box</li><li><b>icon</b> - a relative path of an icon that will be used together with the name to represent the wizard |
| as one of the choices in the creation dialog box.</li><li><b>category</b> - a slash-delimited path ('/') of category IDs. Each token in the |
| path must represent a valid category ID previously defined |
| by this or some other plug-in. If omitted, the wizard will be |
| added to the "Other" category.</li><li><b>class</b> - a fully qualified name of the Java class implementing <samp>org.eclipse.ui.INewWizard</samp>.</li><li><b>finalPerspective</b> - an optional attribute which identifies a perspective to activate when IProject resource creation is finished.</li><li><b>project</b> - an optional attribute indicating the wizard will create an IProject resource. |
| Also cause the wizard to appear as a choice within the "New Project Dialog".</li></ul> |
| <p><samp> <!ELEMENT description (#CDATA)></samp> |
| <p> an optional subelement whose body contains a short text describing what the wizard will do when started</p> |
| <p><samp> <!ELEMENT selection EMPTY></samp> |
| <br><br><samp> <!ATTLIST selection</samp> |
| <br><samp> class CDATA #REQUIRED</samp> |
| <br><samp> name CDATA #IMPLIED</samp> |
| <br><samp> ></samp> |
| <ul> |
| <li><b>class</b> - a fully qualified class name. If each object in the workbench selection implements this interface the selection will be passed to the wizard. Otherwise, an empty selection is passed</li><li><b>name</b> - an optional name filter. Each object in the workbench selection must match the name filter to be passed to the wizard</li></ul> |
| <b><i>Examples: </i></b>Following is an example of creation wizard configuration: |
| <p> |
| <pre> |
| <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> |
| </pre> |
| </p><p> |
| <b><i>API Information: </i></b>The value of the class attribute must represent a class |
| that implements <samp>org.eclipse.ui.INewWizard</samp>. |
| 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.<p> |
| <b><i>Supplied Implementation: </i></b>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.<p> |
| Copyright (c) 2002, 2003 IBM Corporation and others. |
| All rights reserved. This program and the accompanying materials are made available under the terms of the Common Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/cpl-v10.html<p> |
| </BODY> |
| </HTML> |
