| <!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>Import Wizards</CENTER></H1> |
| <b><i>Identifier: </i></b>org.eclipse.ui.importWizards<p> |
| <b><i>Description: </i></b>This extension point is used to register import wizard extensions. Import wizards appear as choices within the "Import Dialog" and are used to import resources into 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> |
| <p><samp> <!ELEMENT extension (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 wizard (description? , selection*)></samp> |
| <p> an element that will be used to create import wizard</p> |
| <p></p> |
| <samp> <!ATTLIST wizard</samp> |
| <br><samp> id CDATA #REQUIRED</samp> |
| <br><samp> name CDATA #REQUIRED</samp> |
| <br><samp> class CDATA #REQUIRED</samp> |
| <br><samp> icon CDATA #IMPLIED</samp> |
| <br><samp> ></samp> |
| <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 <samp>org.eclipse.ui.IImportWizard</samp> interface</li><li><b>icon</b> - a relative name of the icon that will be used alongside the wizard name in the import engine listing.</li></ul> |
| <p><samp> <!ELEMENT description (#CDATA)></samp> |
| <p> an optional subelement whose body should represent a short description of the import engine functionality.</p> |
| <p><samp> <!ELEMENT selection EMPTY></samp> |
| <p> an optional element that restricts the types and names of objects that can be selected when the wizard is invoked.</p> |
| <p></p> |
| <samp> <!ATTLIST selection</samp> |
| <br><samp> name CDATA #IMPLIED</samp> |
| <br><samp> class CDATA #REQUIRED</samp> |
| <br><samp> ></samp> |
| <ul> |
| <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><li><b>class</b> - 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></ul> |
| <b><i>Examples: </i></b>The following is an example of an import extension definition: |
| <p> |
| <pre> |
| <extension |
| point="org.eclipse.ui.importWizards"> |
| <wizard |
| id="com.xyz.ImportWizard1" |
| name="XYZ Web Scraper" |
| class="com.xyz.imports.ImportWizard1" |
| icon="./icons/import1.gif"> |
| <description> |
| A simple engine that searches the Web and imports files |
| </description> |
| <selection class="org.eclipse.core.resources.IResource"/> |
| </wizard> |
| </extension> |
| </pre> |
| </p><p> |
| <b><i>API Information: </i></b>The value of the <samp>class</samp> attribute must represent a name of the class that implements |
| <samp>org.eclipse.ui.IImportWizard</samp>.<p> |
| <b><i>Supplied Implementation: </i></b>The workbench comes preloaded with the basic import engines for files and directories.<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> |
