|
Eclipse PDE Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jface.wizard.Wizard
org.eclipse.pde.ui.templates.AbstractNewPluginTemplateWizard
This class is used as a common base for plug-in content wizards that are implemented using PDE template support. The assumption is that one or more templates will be used to generate plug-in content. Dependencies, new files and wizard pages are all computed based on the templates.
Field Summary |
Fields inherited from class org.eclipse.jface.wizard.Wizard |
DEFAULT_IMAGE |
Constructor Summary | |
AbstractNewPluginTemplateWizard()
Creates a new template wizard. |
Method Summary | |
protected abstract void |
addAdditionalPages()
This wizard adds a mandatory first page. |
void |
addPages()
Implements wizard method. |
IFieldData |
getData()
Returns the field data passed to the wizard during the initialization. |
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. |
abstract ITemplateSection[] |
getTemplateSections()
Returns the template sections used in this wizard. |
void |
init(IFieldData data)
Initializes the wizard with the data collected from the parent wizard pages. |
boolean |
performFinish()
|
boolean |
performFinish(IProject project,
IPluginModelBase model,
IProgressMonitor monitor)
Implements the interface method by looping through template sections and executing them sequentially. |
Methods inherited from class org.eclipse.jface.wizard.Wizard |
addPage, canFinish, createPageControls, dispose, getContainer, getDefaultPageImage, getDialogSettings, getNextPage, getPage, getPageCount, getPages, getPreviousPage, getShell, getStartingPage, getTitleBarColor, getWindowTitle, isHelpAvailable, needsPreviousAndNextButtons, needsProgressMonitor, performCancel, setContainer, setDefaultPageImageDescriptor, setDialogSettings, setForcePreviousAndNextButtons, setHelpAvailable, setNeedsProgressMonitor, setTitleBarColor, setWindowTitle |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.eclipse.jface.wizard.IWizard |
canFinish, createPageControls, dispose, getContainer, getDefaultPageImage, getDialogSettings, getNextPage, getPage, getPageCount, getPages, getPreviousPage, getStartingPage, getTitleBarColor, getWindowTitle, isHelpAvailable, needsPreviousAndNextButtons, needsProgressMonitor, performCancel, setContainer |
Constructor Detail |
public AbstractNewPluginTemplateWizard()
Method Detail |
public void init(IFieldData data)
IPluginContentWizard
init
in interface IPluginContentWizard
data
- all the information collected in the parent wizard that can be
used in configuring the generated contentIPluginContentWizard.init(IFieldData)
public IFieldData getData()
protected abstract void addAdditionalPages()
public final void addPages()
addPages
in interface IWizard
public boolean performFinish()
performFinish
in interface IWizard
Wizard.performFinish()
public boolean performFinish(IProject project, IPluginModelBase model, IProgressMonitor monitor)
performFinish
in interface IPluginContentWizard
project
- the projectmodel
- the plug-in modelmonitor
- the progress monitor to track the execution progress as part
of the overall new project creation operation
true
if the wizard completed the operation with
success, false
otherwise.public abstract ITemplateSection[] getTemplateSections()
public IPluginReference[] getDependencies(String schemaVersion)
IPluginContentWizard
getDependencies
in interface IPluginContentWizard
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.
IPluginContentWizard.getDependencies(String)
public String[] getNewFiles()
IPluginContentWizard
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".
- Specified by:
getNewFiles
in interface IPluginContentWizard
- Returns:
- See Also:
IPluginContentWizard.getNewFiles()
|
Eclipse PDE Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |