Faceted Project Framework
Version 1.3

org.eclipse.wst.common.project.facet.ui
Class BasicFacetedProjectWizard

java.lang.Object
  extended by org.eclipse.jface.wizard.Wizard
      extended by org.eclipse.wst.common.project.facet.ui.ModifyFacetedProjectWizard
          extended by org.eclipse.wst.common.project.facet.ui.BasicFacetedProjectWizard
All Implemented Interfaces:
IWizard, INewWizard, IWorkbenchWizard

public class BasicFacetedProjectWizard
extends ModifyFacetedProjectWizard
implements INewWizard

A basic wizard for creating faceted projects. This wizard is available directly to the users as "Basic/Faceted Project" in the new project dialog, but can also be subclassed.

Author:
Konstantin Komissarchik

Field Summary
 
Fields inherited from class org.eclipse.jface.wizard.Wizard
DEFAULT_IMAGE
 
Constructor Summary
BasicFacetedProjectWizard()
           
 
Method Summary
 void addPages()
           
 boolean canFinish()
           
protected  IWizardPage createFirstPage()
          Creates the first wizard page.
 IWizardPage getFirstPage()
          Returns the wizard's first page.
 IWizardPage getNextPage(IWizardPage page)
           
 IWizardPage[] getPages()
           
protected  String getProjectName()
          Used by the wizard to retrieve the project name that the user specifies on the first page of the wizard.
 void init(IWorkbench workbench, IStructuredSelection selection)
           
 
Methods inherited from class org.eclipse.wst.common.project.facet.ui.ModifyFacetedProjectWizard
createPageControls, dispose, getFacetedProject, getFacetedProjectWorkingCopy, getPage, getPageCount, getPreviousPage, getShowFacetsSelectionPage, getStartingPage, performFinish, performFinish, setCategoryExpandedState, setFacetedProjectWorkingCopy, setShowFacetsSelectionPage, syncWithPresetsModel, syncWithPresetsModel, syncWithPresetsModel
 
Methods inherited from class org.eclipse.jface.wizard.Wizard
addPage, getContainer, getDefaultPageImage, getDialogSettings, getShell, 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
createPageControls, dispose, getContainer, getDefaultPageImage, getDialogSettings, getPage, getPageCount, getPreviousPage, getStartingPage, getTitleBarColor, getWindowTitle, isHelpAvailable, needsPreviousAndNextButtons, needsProgressMonitor, performCancel, performFinish, setContainer
 

Constructor Detail

BasicFacetedProjectWizard

public BasicFacetedProjectWizard()
Method Detail

getFirstPage

public IWizardPage getFirstPage()
Returns the wizard's first page.

Returns:
the wizard's first page

createFirstPage

protected IWizardPage createFirstPage()
Creates the first wizard page. Typically, this is where the user specifies the project name and location. The default implementation users a basic first page provided by the Eclipse Platform. Extenders can override this method in order to supply a custom page. Anyone overriding this page will probably also need to override the getProjectName() method.

Returns:
the first page that will be used by this wizard

getProjectName

protected String getProjectName()
Used by the wizard to retrieve the project name that the user specifies on the first page of the wizard. The default implementation works with any subclass of the WizardNewProjectCreationPage class. Extenders who override the createFirstPage() method will probably also need to override this method.

Returns:
the project name specified by the user

addPages

public void addPages()
Specified by:
addPages in interface IWizard
Overrides:
addPages in class ModifyFacetedProjectWizard

getPages

public IWizardPage[] getPages()
Specified by:
getPages in interface IWizard
Overrides:
getPages in class ModifyFacetedProjectWizard

getNextPage

public IWizardPage getNextPage(IWizardPage page)
Specified by:
getNextPage in interface IWizard
Overrides:
getNextPage in class ModifyFacetedProjectWizard

canFinish

public boolean canFinish()
Specified by:
canFinish in interface IWizard
Overrides:
canFinish in class ModifyFacetedProjectWizard

init

public void init(IWorkbench workbench,
                 IStructuredSelection selection)
Specified by:
init in interface IWorkbenchWizard

Faceted Project Framework
Version 1.3

Copyright (c) 2008 BEA Systems, Inc. and others. All rights reserved.