Import Wizards

Identifier:
org.eclipse.ui.importWizards

Description:
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.

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

Configuration Markup:

<!ELEMENT extension (category | wizard)*>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT keywordReference EMPTY>

<!ATTLIST keywordReference

id IDREF #REQUIRED>

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



<!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

category CDATA #IMPLIED

class    CDATA #REQUIRED

icon     CDATA #IMPLIED>

an element that will be used to create import wizard



<!ELEMENT description (#PCDATA)>

an optional subelement whose body should represent a short description of the import engine functionality.



<!ELEMENT selection EMPTY>

<!ATTLIST selection

name  CDATA #IMPLIED

class CDATA #REQUIRED>

an optional element that restricts the types and names of objects that can be selected when the wizard is invoked.



Examples:
The following is an example of an import extension definition:


   <extension 
       point="org.eclipse.ui.importWizards"> 
      <wizard 
         id="com.xyz.ImportWizard1" 
         name="XYZ Web Scraper" 
         class="com.xyz.imports.ImportWizard1" 
         icon="./icons/import1.png">
         <description> 
            A simple engine that searches the Web and imports files 
         </description> 
         <selection class="org.eclipse.core.resources.IResource"/> 
      </wizard> 
   </extension> 

API Information:
The value of the class attribute must represent a name of the class that implements org.eclipse.ui.IImportWizard.

Supplied Implementation:
The workbench comes preloaded with the basic import engines for files and directories.


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