|
|||||||||
| Home >> All >> org >> eclipse >> jface >> [ wizard overview ] | PREV CLASS NEXT CLASS | ||||||||
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD |
DETAIL: FIELD | CONSTR | METHOD | ||||||||
org.eclipse.jface.wizard
Interface IWizard
- All Known Implementing Classes:
- Wizard
- public interface IWizard
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(org.eclipse.swt.widgets.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. |
org.eclipse.swt.graphics.Image |
getDefaultPageImage()
Returns the default page image for this wizard. |
org.eclipse.jface.dialogs.IDialogSettings |
getDialogSettings()
Returns the dialog settings for this wizard. |
IWizardPage |
getNextPage(IWizardPage page)
Returns the successor of the given page. |
IWizardPage |
getPage(java.lang.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. |
org.eclipse.swt.graphics.RGB |
getTitleBarColor()
Returns the title bar color for this wizard. |
java.lang.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 |
addPages
public void addPages()
- Adds any last-minute pages to this wizard.
This method is called just before the wizard becomes visible, to give the wizard the opportunity to add any lazily created pages.
canFinish
public boolean canFinish()
- Returns whether this wizard could be finished without further user
interaction.
The result of this method is typically used by the wizard container to enable or disable the Finish button.
createPageControls
public void createPageControls(org.eclipse.swt.widgets.Composite pageContainer)
- Creates this wizard's controls in the given parent control.
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.
dispose
public void dispose()
- Disposes of this wizard and frees all SWT resources.
getContainer
public IWizardContainer getContainer()
- Returns the container of this wizard.
getDefaultPageImage
public org.eclipse.swt.graphics.Image getDefaultPageImage()
- Returns the default page image for this wizard.
This image can be used for pages which do not supply their own image.
getDialogSettings
public org.eclipse.jface.dialogs.IDialogSettings getDialogSettings()
- Returns the dialog settings for this wizard.
The dialog store is used to record state between wizard invocations (for example, radio button selections, last directory, etc.).
getNextPage
public IWizardPage getNextPage(IWizardPage page)
- Returns the successor of the given page.
This method is typically called by a wizard page
getPage
public IWizardPage getPage(java.lang.String pageName)
- Returns the wizard page with the given name belonging to this wizard.
getPageCount
public int getPageCount()
- Returns the number of pages in this wizard.
getPages
public IWizardPage[] getPages()
- Returns all the pages in this wizard.
getPreviousPage
public IWizardPage getPreviousPage(IWizardPage page)
- Returns the predecessor of the given page.
This method is typically called by a wizard page
getStartingPage
public IWizardPage getStartingPage()
- Returns the first page to be shown in this wizard.
getTitleBarColor
public org.eclipse.swt.graphics.RGB getTitleBarColor()
- Returns the title bar color for this wizard.
getWindowTitle
public java.lang.String getWindowTitle()
- Returns the window title string for this wizard.
isHelpAvailable
public boolean isHelpAvailable()
- Returns whether help is available for this wizard.
The result of this method is typically used by the container to show or hide the Help button.
needsPreviousAndNextButtons
public boolean needsPreviousAndNextButtons()
- Returns whether this wizard needs Previous and Next buttons.
The result of this method is typically used by the container.
needsProgressMonitor
public boolean needsProgressMonitor()
- Returns whether this wizard needs a progress monitor.
The result of this method is typically used by the container.
performCancel
public boolean performCancel()
- Performs any actions appropriate in response to the user
having pressed the Cancel button, or refuse if canceling
now is not permitted.
performFinish
public boolean performFinish()
- Performs any actions appropriate in response to the user
having pressed the Finish button, or refuse if finishing
now is not permitted.
Normally this method is only called on the container's
current wizard. However if the current wizard is a nested wizard
this method will also be called on all wizards in its parent chain.
Such parents may use this notification to save state etc. However,
the value the parents return from this method is ignored.
setContainer
public void setContainer(IWizardContainer wizardContainer)
- Sets or clears the container of this wizard.
|
|||||||||
| Home >> All >> org >> eclipse >> jface >> [ wizard overview ] | PREV CLASS NEXT CLASS | ||||||||
|
SUMMARY: JAVADOC | SOURCE | DOWNLOAD | NESTED | FIELD | CONSTR | METHOD |
DETAIL: FIELD | CONSTR | METHOD | ||||||||