org.eclipse.jface.wizard
Interface IWizard

All Known Subinterfaces:

ICapabilityInstallWizard, ICapabilityUninstallWizard, ICapabilityWizard, IConfigurationWizard, IExportWizard, IImportWizard, INewWizard, IWorkbenchWizard

All Known Implementing Classes:

BasicNewResourceWizard, ExternalProjectImportWizard, FileSystemExportWizard, FileSystemImportWizard, Wizard, ZipFileExportWizard, ZipFileImportWizard

public interface IWizard

Interface for a wizard. A wizard maintains a list of wizard pages, stacked on top of each other in card layout fashion.

The class Wizard provides an abstract implementation of this interface. However, clients are also free to implement this interface if Wizard does not suit their needs.

See Also:

Wizard

Method Summary

void	addPages() Adds any last-minute pages to this wizard.
boolean	canFinish() Returns whether this wizard could be finished without further user interaction.
void	createPageControls(Composite pageContainer) Creates this wizard's controls in the given parent control.
void	dispose() Disposes of this wizard and frees all SWT resources.
IWizardContainer	getContainer() Returns the container of this wizard.
Image	getDefaultPageImage() Returns the default page image for this wizard.
IDialogSettings	getDialogSettings() Returns the dialog settings for this wizard.
IWizardPage	getNextPage(IWizardPage page) Returns the successor of the given page.
IWizardPage	getPage(String pageName) Returns the wizard page with the given name belonging to this wizard.
int	getPageCount() Returns the number of pages in this wizard.
IWizardPage[]	getPages() Returns all the pages in this wizard.
IWizardPage	getPreviousPage(IWizardPage page) Returns the predecessor of the given page.
IWizardPage	getStartingPage() Returns the first page to be shown in this wizard.
RGB	getTitleBarColor() Returns the title bar color for this wizard.
String	getWindowTitle() Returns the window title string for this wizard.
boolean	isHelpAvailable() Returns whether help is available for this wizard.
boolean	needsPreviousAndNextButtons() Returns whether this wizard needs Previous and Next buttons.
boolean	needsProgressMonitor() Returns whether this wizard needs a progress monitor.
boolean	performCancel() Performs any actions appropriate in response to the user having pressed the Cancel button, or refuse if canceling now is not permitted.
boolean	performFinish() Performs any actions appropriate in response to the user having pressed the Finish button, or refuse if finishing now is not permitted.
void	setContainer(IWizardContainer wizardContainer) Sets or clears the container of this wizard.

Method Detail

addPages

public void addPages()

Adds any last-minute pages to this wizard.

This method is called just before the wizard becomes visible, to give the wizard the opportunity to add any lazily created pages.

canFinish

public boolean canFinish()

Returns whether this wizard could be finished without further user interaction.

The result of this method is typically used by the wizard container to enable or disable the Finish button.

Returns:

true if the wizard could be finished, and false otherwise

createPageControls

public void createPageControls(Composite pageContainer)

Creates this wizard's controls in the given parent control.

The wizard container calls this method to create the controls for the wizard's pages before the wizard is opened. This allows the wizard to size correctly; otherwise a resize may occur when moving to a new page.

Parameters:

pageContainer - the parent control

dispose

public void dispose()

Disposes of this wizard and frees all SWT resources.

getContainer

public IWizardContainer getContainer()

Returns the container of this wizard.

Returns:

the wizard container, or null if this wizard has yet to be added to a container

getDefaultPageImage

public Image getDefaultPageImage()

Returns the default page image for this wizard.

This image can be used for pages which do not supply their own image.

Returns:

the default page image

getDialogSettings

public IDialogSettings getDialogSettings()

Returns the dialog settings for this wizard.

The dialog store is used to record state between wizard invocations (for example, radio button selections, last directory, etc.).

Returns:

the dialog settings, or null if none

getNextPage

public IWizardPage getNextPage(IWizardPage page)

Returns the successor of the given page.

This method is typically called by a wizard page

Parameters:

page - the page

Returns:

the next page, or null if none

getPage

public IWizardPage getPage(String pageName)

Returns the wizard page with the given name belonging to this wizard.

Parameters:

pageName - the name of the wizard page

Returns:

the wizard page with the given name, or null if none

getPageCount

public int getPageCount()

Returns the number of pages in this wizard.

Returns:

the number of wizard pages

getPages

public IWizardPage[] getPages()

Returns all the pages in this wizard.

Returns:

a list of pages

getPreviousPage

public IWizardPage getPreviousPage(IWizardPage page)

Returns the predecessor of the given page.

This method is typically called by a wizard page

Parameters:

page - the page

Returns:

the previous page, or null if none

getStartingPage

public IWizardPage getStartingPage()

Returns the first page to be shown in this wizard.

Returns:

the first wizard page

getTitleBarColor

public RGB getTitleBarColor()

Returns the title bar color for this wizard.

Returns:

the title bar color

getWindowTitle

public String getWindowTitle()

Returns the window title string for this wizard.

Returns:

the window title string, or null for no title

isHelpAvailable

public boolean isHelpAvailable()

Returns whether help is available for this wizard.

The result of this method is typically used by the container to show or hide the Help button.

Returns:

true if help is available, and false if this wizard is helpless

needsPreviousAndNextButtons

public boolean needsPreviousAndNextButtons()

Returns whether this wizard needs Previous and Next buttons.

The result of this method is typically used by the container.

Returns:

true if Previous and Next buttons are required, and false if none are needed

needsProgressMonitor

public boolean needsProgressMonitor()

Returns whether this wizard needs a progress monitor.

The result of this method is typically used by the container.

Returns:

true if a progress monitor is required, and false if none is needed

performCancel

public boolean performCancel()

Performs any actions appropriate in response to the user having pressed the Cancel button, or refuse if canceling now is not permitted.

Returns:

true to indicate the cancel request was accepted, and false to indicate that the cancel request was refused

performFinish

public boolean performFinish()

Performs any actions appropriate in response to the user having pressed the Finish button, or refuse if finishing now is not permitted. Normally this method is only called on the container's current wizard. However if the current wizard is a nested wizard this method will also be called on all wizards in its parent chain. Such parents may use this notification to save state etc. However, the value the parents return from this method is ignored.

Returns:

true to indicate the finish request was accepted, and false to indicate that the finish request was refused

setContainer

public void setContainer(IWizardContainer wizardContainer)

Sets or clears the container of this wizard.

Parameters:

wizardContainer - the wizard container, or null