|
Eclipse PDE Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Classes that implement this interface are contributed via the extension point
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 performFinish
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.
Method Summary | |
---|---|
IPluginReference[] |
getDependencies(String schemaVersion)
Returns new dependencies that are required by this wizard. |
String[] |
getNewFiles()
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 build.properties file. |
void |
init(IFieldData data)
Initializes the wizard with the data collected from the parent wizard pages. |
boolean |
performFinish(IProject project,
IPluginModelBase model,
IProgressMonitor monitor)
Executes the wizard when 'Finish' button has been pressed. |
Methods inherited from interface org.eclipse.jface.wizard.IWizard |
---|
addPages, canFinish, createPageControls, dispose, getContainer, getDefaultPageImage, getDialogSettings, getNextPage, getPage, getPageCount, getPages, getPreviousPage, getStartingPage, getTitleBarColor, getWindowTitle, isHelpAvailable, needsPreviousAndNextButtons, needsProgressMonitor, performCancel, performFinish, setContainer |
Method Detail |
public void init(IFieldData data)
data
- all the information collected in the parent wizard that can be
used in configuring the generated contentpublic 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.
public String[] getNewFiles()
build.properties
file. All files and folders that must be
part of the binary build must be listed in bin.includes
variable. 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".
- Returns:
- an array of new file and folder names
public boolean performFinish(IProject project, IPluginModelBase model, IProgressMonitor monitor)
project
- the newly created plug-in project handlemodel
- the model of the plug-in manifest that can be used to add
extension markupmonitor
- the progress monitor to track progress of the content
generation
true
if the content has been generated
successfully, false
otherwise. In case of failure,
the wizard dialog will stay open.
|
Eclipse PDE Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |