Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 

Eclipse Plug-in Developer Guide
Previous Page Home Next Page

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

>

  • point - a fully qualified identifier of the target extension point
  • id - an optional identifier of the extension instance
  • name - an optional name of the extension instance

<!ELEMENT category EMPTY>

<!ATTLIST category

id             CDATA #REQUIRED

name           CDATA #REQUIRED

parentCategory IDREF #IMPLIED

>

  • id - a unique name that can be used to identify this category
  • name - a translatable name of the category that will be used in the dialog box
  • parentCategory - a path to another category if this category should be added as a child

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

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


  • id - a unique name that will be used to identify this wizard
  • name - a translatable name that will be used in the dialog box to represent this wizard
  • category - 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.
  • class - a fully qualified name of the class that implements org.eclipse.ui.IImportWizard interface
  • icon - a relative name of the icon that will be used alongside the wizard name in the import engine listing.

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


  • name - an optional name filter. Each object in the workbench selection must match the name filter to be passed to the wizard.
  • class - 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.

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.gif"
> 
         <description> 
            A simple engine that searches the Web and imports files 
         </description> 
         <selection class=
"org.eclipse.core.resources.IResource"
/> 
      </wizard> 
   </extension> 

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 https://www.eclipse.org/legal/epl-v10.html


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire