| <!doctype html public "-//w3c//dtd html 4.0//en"> | |
| <html> | |
| <head> | |
| <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> | |
| <title>Eclipse Workbench Extension Point: Export Wizards</title> | |
| </head> | |
| <body link="#0000FF" vlink="#800080"> | |
| <center> | |
| <h1> | |
| Export Wizards</h1></center> | |
| <b><i>Identifier: </i></b>org.eclipse.ui.exportWizards | |
| <p><b><i>Description: </i></b>This extension point is used to register | |
| export wizard extensions. Export wizards appear as choices within the "Export | |
| Dialog", and are used to export resources from the workbench. | |
| <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><tt> <!ELEMENT wizard (description? selection*)></tt> | |
| <br><tt> <!ATTLIST wizard</tt> | |
| <br><tt> id CDATA | |
| #REQUIRED</tt> | |
| <br><tt> name CDATA #REQUIRED</tt> | |
| <br><tt> class | |
| CDATA #REQUIRED</tt> | |
| <br><tt> icon | |
| CDATA #IMPLIED</tt> | |
| <br><tt> ></tt> | |
| <br><tt> <!ELEMENT description (#PCDATA)></tt> | |
| <ul> | |
| <li> | |
| <b>id</b> - a unique name that will be used to identify this wizard.</li> | |
| <li> | |
| <b>name</b> - a translatable name that will be used in the dialog box to | |
| represent this wizard.</li> | |
| <li> | |
| <b>class</b> - a fully qualified name of the class that implements | |
| <tt>org.eclipse.ui.IExportWizard</tt>.</li> | |
| <li> | |
| <b>icon</b> - a relative name of the icon that will be used alongside the | |
| wizard name in the export engine listing.</li> | |
| <li> | |
| <b>description</b> - an optional subelement whose body represents a short | |
| description of the export engine functionality.</li> | |
| </ul> | |
| <tt> <!ELEMENT selection EMPTY></tt> | |
| <br><tt> <!ATTLIST selection</tt> | |
| <br><tt> class | |
| CDATA #REQUIRED</tt> | |
| <br><tt> name CDATA #OPTIONAL</tt> | |
| <br><tt> ></tt> | |
| <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> | |
| <p>The following is an example of an export extension definition: | |
| <p><tt> <extension</tt> | |
| <br><tt> point="org.eclipse.ui.exportWizards"></tt> | |
| <br><tt> <wizard</tt> | |
| <br><tt> id="com.xyz.ExportWizard1"</tt> | |
| <br><tt> name="XYZ Web | |
| Exporter"</tt> | |
| <br><tt> class="com.xyz.exports.ExportWizard1"</tt> | |
| <br><tt> icon="./icons/import1.gif"></tt> | |
| <br><tt> <description></tt> | |
| <br><tt> | |
| A simple engine that exports Web project</tt> | |
| <br><tt> </description></tt> | |
| <br><tt> <selection | |
| class="org.eclipse.core.resources.IProject"/></tt> | |
| <br><tt> </wizard></tt> | |
| <br><tt> </extension></tt> | |
| <p><b><i>API Information: </i></b>The value of the <tt>class</tt> attribute | |
| must be a name of the class that implements <tt>org.eclipse.ui.IExportWizard</tt>. | |
| <p><b><i>Supplied Implementation: </i></b>The workbench comes preloaded | |
| with basic export engines for files and directories. | |
| <p><a href="hglegal2002.htm"><img SRC="ngibmcpy2002.gif" ALT="Copyright IBM Corporation and others 2000, 2002." BORDER=0></a> | |
| </body> | |
| </html> |