org.eclipse.jface.wizard
Interface IWizardContainer
-
All Superinterfaces:
-
IRunnableContext
-
All Known Subinterfaces:
-
IWizardContainer2
-
All Known Implementing Classes:
-
WizardDialog
-
public interface IWizardContainer
- extends
IRunnableContext
Interface for containers that can host a wizard. It displays
wizard pages, at most one of which is considered
the current page. 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.
-
See Also:
-
IWizardContainer2
Method Summary
|
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. |
getCurrentPage
IWizardPage getCurrentPage()
- Returns the current wizard page for this container.
-
-
-
Returns:
- the current wizard page, or
null
if the container
is not yet showing the wizard -
See Also:
-
showPage(org.eclipse.jface.wizard.IWizardPage)
getShell
Shell getShell()
- Returns the shell for this wizard container.
-
-
-
Returns:
- the shell, or
null
if this wizard
container does not have a shell
showPage
void showPage(
IWizardPage page)
- Makes the given page visible.
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.
-
-
-
Parameters:
-
page
- the page to show -
See Also:
-
getCurrentPage()
updateButtons
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.
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.
-
-
updateMessage
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.
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.
-
-
updateTitleBar
void updateTitleBar()
- Updates the title bar (title, description, and image) to
reflect the state of the currently active page in this container.
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.
-
-
updateWindowTitle
void updateWindowTitle()
- Updates the window title to reflect the state of the current wizard.
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.
-
-
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.