Plug-in Content Wizards

Identifier:

org.eclipse.pde.ui.pluginContent

Description:

This extension point provides for contributing wizards that create additional content of the PDE plug-in projects. After the plug-in manifest and key files have been created, these wizards can be used to add more files and extensions to the initial structure. A typical implementation of this wizard would add content based on a parametrized template customized based on the user choices in the wizard. The goal is to arrive at a plug-in that is does something useful right after the creation (e.g. contributes a view, an editor etc.).

Configuration Markup:

<!ELEMENT extension (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 wizard (description?)>

<!ATTLIST wizard

id         CDATA #REQUIRED

name       CDATA #REQUIRED

icon       CDATA #IMPLIED

class      CDATA #REQUIRED

category   CDATA #IMPLIED

ui-content (true | false) "true"

java       (true | false) "true">

• id - a unique name that will be used to identify this wizard.

• name - a translatable name that will be used in UI representation of this wizard.

• icon - a relative path of an icon that will be used to visually represent the wizard.

• class - a fully qualified name of a class which implements org.eclipse.pde.ui.IPluginContentWizard.

• category - an optional tag that can be used to associate content wizards with different target projects.

• ui-content - a flag that indicates if the wizard will contribute code with user interface content. This flag will affect which plug-in class will be picked since (UI plug-ins extend AbstractUIPlugin class, while non-UI plug-ins extends Plugin base class). Since many contributions to Eclipse have UI content, this attribute is true by default.

• java - a flag that indicates that the wizard will contribute Java content. Since most of the Eclipse plug-ins have Java code, the attribute is true by default. Set it to false if the plug-in will not have Java code (for example, documentation files only).

<!ELEMENT description (#CDATA)>

Short description of this wizard.

Examples:

The following is an example of this extension point:

   
   
<extension point=
"org.eclipse.pde.ui.pluginContent"
>
      
<wizard
         name=
"Example Plug-in Content Generator"

         icon=
"icons/content_wizard.gif"

         class=
"com.example.xyz.ContentGeneratorWizard"

         id=
"com.example.xyz.ExampleContentGenerator"
>
         
<description>
            Adds a view and a preference page.
         
</description>
      
</wizard>
   
</extension>

API Information:

Wizards that plug into this extension point must implement org.eclipse.pde.ui.IPluginContentWizard interface and is expected to extend org.eclipse.jface.wizard.Wizard.

Supplied Implementation:

PDE provides APIs for contributing content wizards based on customizable templates. A number of concrete wizards based on these templates is contributed by PDE UI itself.

Copyright (c) 2004 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.