public interface IWizard
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.
Wizard
Modifier and Type | Method and Description |
---|---|
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.
|
void addPages()
This method is called just before the wizard becomes visible, to give the wizard the opportunity to add any lazily created pages.
boolean canFinish()
The result of this method is typically used by the wizard container to enable or disable the Finish button.
true
if the wizard could be finished,
and false
otherwisevoid createPageControls(Composite pageContainer)
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.
pageContainer
- the parent controlvoid dispose()
IWizardContainer getContainer()
null
if this
wizard has yet to be added to a containerImage getDefaultPageImage()
This image can be used for pages which do not supply their own image.
IDialogSettings getDialogSettings()
The dialog store is used to record state between wizard invocations (for example, radio button selections, last directory, etc.).
null
if noneIWizardPage getNextPage(IWizardPage page)
This method is typically called by a wizard page
page
- the pagenull
if noneIWizardPage getPage(String pageName)
pageName
- the name of the wizard pagenull
if noneint getPageCount()
IWizardPage[] getPages()
IWizardPage getPreviousPage(IWizardPage page)
This method is typically called by a wizard page
page
- the pagenull
if noneIWizardPage getStartingPage()
RGB getTitleBarColor()
String getWindowTitle()
null
for no titleboolean isHelpAvailable()
The result of this method is typically used by the container to show or hide a button labeled "Help".
Note: This wizard's container might be a TrayDialog
which provides
its own help support that is independent of this property.
Note 2: In the default WizardDialog
implementation, the "Help"
button only works when IDialogPage.performHelp()
is implemented.
true
if help is available, false
otherwiseTrayDialog.isHelpAvailable()
,
TrayDialog.setHelpAvailable(boolean)
boolean needsPreviousAndNextButtons()
The result of this method is typically used by the container.
true
if Previous and Next buttons are required,
and false
if none are neededboolean needsProgressMonitor()
The result of this method is typically used by the container.
true
if a progress monitor is required,
and false
if none is neededboolean performCancel()
true
to indicate the cancel request
was accepted, and false
to indicate
that the cancel request was refusedboolean performFinish()
true
to indicate the finish request
was accepted, and false
to indicate
that the finish request was refusedvoid setContainer(IWizardContainer wizardContainer)
wizardContainer
- the wizard container, or null
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.