Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Plug-in Content Wizards</title>
<style type="text/css">@import url("../../book.css");</style>
<style type="text/css">@import url("../../schema.css");</style>
</HEAD>
<BODY>
<H1 style="text-align:center">Plug-in Content Wizards</H1>
<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Identifier: </h6>org.eclipse.pde.ui.pluginContent<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Description: </h6>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.).<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Configuration Markup:</h6>
<p></p>
<p class="code SchemaDtd">&lt;!ELEMENT <a name="e.extension">extension</a> (<a href="#e.wizard">wizard</a>*)&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST extension</p>
<p class="code SchemaDtdAttlist">point&nbsp;CDATA #REQUIRED</p>
<p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p>
<p class="code SchemaDtdAttlist">name&nbsp;&nbsp;CDATA #IMPLIED&gt;</p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
<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>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.wizard">wizard</a> (<a href="#e.description">description</a>?)&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST wizard</p>
<p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;IDREF #REQUIRED</p>
<p class="code SchemaDtdAttlist">name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p>
<p class="code SchemaDtdAttlist">icon&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p>
<p class="code SchemaDtdAttlist">class&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p>
<p class="code SchemaDtdAttlist">category&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p>
<p class="code SchemaDtdAttlist">ui-content&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(true | false) "true"</p>
<p class="code SchemaDtdAttlist">java&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(true | false) "true"</p>
<p class="code SchemaDtdAttlist">rcp&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(true | false) "false"</p>
<p class="code SchemaDtdAttlist">pureOSGi&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(true | false) "false"</p>
<p class="code SchemaDtdAttlist">requiresActivator&nbsp;(true | false) "false"&gt;</p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
<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 UI representation
of this wizard.</li>
<li><b>icon</b> - a relative path of an icon that will be used to visually 
represent the wizard.</li>
<li><b>class</b> - a fully qualified name of a class which implements 
<samp>org.eclipse.pde.ui.IPluginContentWizard</samp> and extends from <samp>org.eclipse.jface.Wizard</samp>.</li>
<li><b>category</b> - an optional tag that can be used to associate content wizards with different target projects.</li>
<li><b>ui-content</b> - 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 <code>AbstractUIPlugin</code> class, while non-UI plug-ins extends <code>Plugin</code> base class). Since many contributions to Eclipse have UI content, this attribute is <code>true</code> by default.</li>
<li><b>java</b> - a flag that indicates that the wizard will contribute Java content. Since most of the Eclipse plug-ins have Java code, the attribute is <code>true</code> by default. Set it to <code>false</code> if the plug-in will not have Java code (for example, documentation files only).</li>
<li><b>rcp</b> - Since 3.1.  A boolean flag indicating whether the wizard contributes a standalone fully-functioning rich client application.  If set to <code>true</code>, the wizard will appear in the New Plug-in Project wizard only when the user chooses the Rich Client Application option.</li>
<li><b>pureOSGi</b> - Since 3.2.  A boolean flag indicating whether the wizard contributes a pure OSGi bundle.  If set to <code>true</code>, the wizard will appear in the New Plug-in Project wizard only when the user chooses to create a pure OSGi bundle.</li>
<li><b>requiresActivator</b> - Since 3.2.  A boolean flag indicating whether the wizard contributes an activator class.  If set to <code>true</code>, the wizard will appear in the New Plug-in Project wizard only when the user chooses to generate an activator to control the plug-in life cycle.</li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.description">description</a> (#PCDATA)&gt;</p>
<p></p>
<p class="ConfigMarkupElementDesc">
Short description of this wizard.</p>
<br><br>
<h6 class="CaptionFigColumn SchemaHeader">Examples: </h6>The following is an example of this extension point:
<pre class="Example"><span class="code SchemaTag">   
   &lt;extension point=</span><span class="code SchemaCstring">&quot;org.eclipse.pde.ui.pluginContent&quot;</span><span class="code SchemaTag">&gt;
      &lt;wizard
         name=</span><span class="code SchemaCstring">&quot;Example Plug-in Content Generator&quot;</span><span class="code SchemaTag">
         icon=</span><span class="code SchemaCstring">&quot;icons/content_wizard.png&quot;</span><span class="code SchemaTag">
         class=</span><span class="code SchemaCstring">&quot;com.example.xyz.ContentGeneratorWizard&quot;</span><span class="code SchemaTag">
         id=</span><span class="code SchemaCstring">&quot;com.example.xyz.ExampleContentGenerator&quot;</span><span class="code SchemaTag">&gt;
         &lt;description&gt;
            Adds a view and a preference page.
         &lt;/description&gt;
      &lt;/wizard&gt;
   &lt;/extension&gt;
</span></pre>
<p></p>

<h6 class="CaptionFigColumn SchemaHeader">API Information: </h6>Wizards that plug into this extension point must
implement <samp>org.eclipse.pde.ui.IPluginContentWizard</samp>
interface and is expected to extend <code>org.eclipse.jface.wizard.Wizard</code>.
<p></p>

<h6 class="CaptionFigColumn SchemaHeader">Supplied Implementation: </h6>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.
<p></p>

<br>
<p class="note SchemaCopyright">
Copyright (c) 2004, 2014 IBM Corporation and others.
<br>
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 
<a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>.

</p>
</BODY>
</HTML>
New to GrepCode? Check out our FAQ X