|
Eclipse Platform Release 3.0 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.eclipse.jface.wizard.Wizard
An abstract base implementation of a wizard. A typical client subclasses Wizard to implement a particular wizard.
Subclasses may call the following methods to configure the wizard:
Subclasses may override these methods if required:
Note that clients are free to implement IWizard from scratch instead of subclassing Wizard. Correct implementations of IWizard will work with any correct implementation of IWizardPage.
Field Summary | |
static String | DEFAULT_IMAGE
Image registry key of the default image for wizard pages (value "org.eclipse.jface.wizard.Wizard.pageImage"). |
Constructor Summary | |
protected | Wizard()
Creates a new empty wizard. |
Method Summary | |
void | addPage(IWizardPage page)
Adds a new page to this wizard. |
void | addPages()
The Wizard implementation of this IWizard method does nothing. |
boolean | canFinish()
Returns whether this wizard could be finished without further user interaction. |
void | createPageControls(Composite pageContainer)
The Wizard implementation of this IWizard method creates all the pages controls using IDialogPage.createControl. |
void | dispose()
The Wizard implementation of this IWizard method disposes all the pages controls using DialogPage.dispose. |
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 name)
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. |
Shell | getShell()
Returns the wizard's shell if the wizard is visible. |
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()
The Wizard implementation of this IWizard method does nothing and returns true. |
abstract boolean | performFinish()
Subclasses must implement this IWizard method to perform any special finish processing for their wizard. |
void | setContainer(IWizardContainer wizardContainer)
Sets or clears the container of this wizard. |
void | setDefaultPageImageDescriptor(ImageDescriptor imageDescriptor)
Sets the default page image descriptor for this wizard. |
void | setDialogSettings(IDialogSettings settings)
Sets the dialog settings for this wizard. |
void | setForcePreviousAndNextButtons(boolean b)
Controls whether the wizard needs Previous and Next buttons even if it currently contains only one page. |
void | setHelpAvailable(boolean b)
Sets whether help is available for this wizard. |
void | setNeedsProgressMonitor(boolean b)
Sets whether this wizard needs a progress monitor. |
void | setTitleBarColor(RGB color)
Sets the title bar color for this wizard. |
void | setWindowTitle(String newTitle)
Sets the window title for the container that hosts this page to the given string. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String DEFAULT_IMAGE
Constructor Detail |
protected Wizard()
Method Detail |
public void addPage(IWizardPage page)
public void addPages()
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)
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 name)
public int getPageCount()
public IWizardPage[] getPages()
public IWizardPage getPreviousPage(IWizardPage page)
This method is typically called by a wizard page
public Shell getShell()
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 abstract boolean performFinish()
public void setContainer(IWizardContainer wizardContainer)
public void setDefaultPageImageDescriptor(ImageDescriptor imageDescriptor)
This image descriptor will be used to generate an image for a page with no image of its own; the image will be computed once and cached.
public void setDialogSettings(IDialogSettings settings)
The dialog settings is used to record state between wizard invocations (for example, radio button selection, last import directory, etc.)
public void setForcePreviousAndNextButtons(boolean b)
This flag should be set on wizards where the first wizard page adds follow-on wizard pages based on user input.
public void setHelpAvailable(boolean b)
The result of this method is typically used by the container to show or hide the Help button.
public void setNeedsProgressMonitor(boolean b)
public void setTitleBarColor(RGB color)
public void setWindowTitle(String newTitle)
|
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.