|
Eclipse Platform Release 3.0 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
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 |
public void addPages()
This method is called just before the wizard becomes visible, to give the wizard the opportunity to add any lazily created pages.
public boolean canFinish()
The result of this method is typically used by the wizard container to enable or disable the Finish button.
public void 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.
public void dispose()
public IWizardContainer getContainer()
public Image getDefaultPageImage()
This image can be used for pages which do not supply their own image.
public IDialogSettings getDialogSettings()
The dialog store is used to record state between wizard invocations (for example, radio button selections, last directory, etc.).
public IWizardPage getNextPage(IWizardPage page)
This method is typically called by a wizard page
public IWizardPage getPage(String pageName)
public int getPageCount()
public IWizardPage[] getPages()
public IWizardPage getPreviousPage(IWizardPage page)
This method is typically called by a wizard page
public IWizardPage getStartingPage()
public RGB getTitleBarColor()
public String getWindowTitle()
public boolean isHelpAvailable()
The result of this method is typically used by the container to show or hide the Help button.
public boolean needsPreviousAndNextButtons()
The result of this method is typically used by the container.
public boolean needsProgressMonitor()
The result of this method is typically used by the container.
public boolean performCancel()
public boolean performFinish()
public void setContainer(IWizardContainer wizardContainer)
|
Eclipse Platform Release 3.0 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.