public interface IPluginContentWizard extends IBasePluginWizard
org.eclipse.pde.ui.pluginContent. The expectation is that classes also extend JFace Wizard class. The role of this wizard is to provide additional plug-in content after the project and the critical plug-in project files have been created. The wizard is nested in the overall 'New' wizard and can contribute one or more pages that allow users to configure how this content will be generated. A typical implementation of this interface would be a template wizard that populates the plug-in project with content that can be useful right away (for example, a view or an editor extension).
Due to the call order of the method
performFinish in nested
wizards, classes that implement this interface should not place the code that
generates new content in the implementation of the abstract method
Wizard.performFinish(). Instead, they should simply return
true and have all the real code in
defined in this interface. This version of the method passes all the context
required for the content generation and is called AFTER the project and vital
plug-in files have been already created.
|Modifier and Type||Method and Description|
Returns new dependencies that are required by this wizard.
The wizard is required to return an array of new file and folder names that are generated by it for the purpose of inclusion in
Initializes the wizard with the data collected from the parent wizard pages.
Executes the wizard when 'Finish' button has been pressed.
addPages, canFinish, createPageControls, dispose, getContainer, getDefaultPageImage, getDialogSettings, getNextPage, getPage, getPageCount, getPages, getPreviousPage, getStartingPage, getTitleBarColor, getWindowTitle, isHelpAvailable, needsPreviousAndNextButtons, needsProgressMonitor, performCancel, performFinish, setContainer
void init(IFieldData data)
data- all the information collected in the parent wizard that can be used in configuring the generated content
IPluginReference getDependencies(String schemaVersion)
schemaVersion- version of the plug-in manifest, or null if older manifest (prior to 3.0) has been created. Depending on the manifest version, the list of dependencies may vary.
build.propertiesfile. All files and folders that must be part of the binary build must be listed in
bin.includesvariable. Since the tokens obtained by this method will be passed to the variable as-is, it is legal to use all wild cards also legal in
build.properties, such as "*.gif".
boolean performFinish(IProject project, IPluginModelBase model, IProgressMonitor monitor)
project- the newly created plug-in project handle
model- the model of the plug-in manifest that can be used to add extension markup
monitor- the progress monitor to track progress of the content generation
trueif the content has been generated successfully,
falseotherwise. In case of failure, the wizard dialog will stay open.
Copyright (c) 2000, 2013 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.