public interface IWizardContainer extends IRunnableContext
getCurrentPage
returns the
current page; showPage
programmatically changes the
the current page. Note that the pages need not all belong
to the same wizard.
The class WizardDialog
provides a fully functional
implementation of this interface which will meet the needs of
most clients. However, clients are also free to implement this
interface if WizardDialog
does not suit their needs.
Implementors are responsible for disposing of their wizards.
IWizardContainer2
Modifier and Type | Method and Description |
---|---|
IWizardPage |
getCurrentPage()
Returns the current wizard page for this container.
|
Shell |
getShell()
Returns the shell for this wizard container.
|
void |
showPage(IWizardPage page)
Makes the given page visible.
|
void |
updateButtons()
Adjusts the enable state of the Back, Next, and Finish
buttons to reflect the state of the currently active
page in this container.
|
void |
updateMessage()
Updates the message (or error message) shown in the message line to
reflect the state of the currently active page in this container.
|
void |
updateTitleBar()
Updates the title bar (title, description, and image) to
reflect the state of the currently active page in this container.
|
void |
updateWindowTitle()
Updates the window title to reflect the state of the current wizard.
|
run
IWizardPage getCurrentPage()
null
if the container
is not yet showing the wizardshowPage(org.eclipse.jface.wizard.IWizardPage)
Shell getShell()
null
if this wizard
container does not have a shellvoid showPage(IWizardPage page)
This method should not be use for normal page sequencing (back, next) which is handled by the container itself. It may, however, be used to move to another page in response to some custom action such as double clicking in a list.
page
- the page to showgetCurrentPage()
void updateButtons()
This method is called by the container itself when its wizard page changes and may be called by the page at other times to force a button state update.
void updateMessage()
This method is called by the container itself when its wizard page changes and may be called by the page at other times to force a message update.
void updateTitleBar()
This method is called by the container itself when its wizard page changes and may be called by the page at other times to force a title bar update.
void updateWindowTitle()
This method is called by the container itself when its wizard changes and may be called by the wizard at other times to force a window title change.
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.