Package org.eclipse.jface.wizard
Class WizardSelectionPage
- java.lang.Object
-
- org.eclipse.jface.dialogs.DialogPage
-
- org.eclipse.jface.wizard.WizardPage
-
- org.eclipse.jface.wizard.WizardSelectionPage
-
- All Implemented Interfaces:
IDialogPage
,IMessageProvider
,IWizardPage
public abstract class WizardSelectionPage extends WizardPage
An abstract implementation of a wizard page that manages a set of embedded wizards.A wizard selection page should present a list of wizard nodes corresponding to other wizards. When the end user selects one of them from the list, the first page of the selected wizard becomes the next page. The only new methods introduced by this class are
getSelectedNode
andsetSelectedNode
. Otherwise, the subclass contract is the same asWizardPage
.
-
-
Field Summary
-
Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider
ERROR, INFORMATION, NONE, WARNING
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
WizardSelectionPage(String pageName)
Creates a new wizard selection page with the given name, and with no title or image.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
canFlipToNextPage()
TheWizardSelectionPage
implementation of thisIWizardPage
method returnstrue
if there is a selected node.void
dispose()
TheWizardSelectionPage
implementation of anIDialogPage
method disposes of all nested wizards.IWizardPage
getNextPage()
TheWizardSelectionPage
implementation of thisIWizardPage
method returns the first page of the currently selected wizard if there is one.IWizardNode
getSelectedNode()
Returns the currently selected wizard node within this page.protected void
setSelectedNode(IWizardNode node)
Sets or clears the currently selected wizard node within this page.-
Methods inherited from class org.eclipse.jface.wizard.WizardPage
getContainer, getDialogSettings, getImage, getName, getPreviousPage, getShell, getWizard, isCurrentPage, isPageComplete, setDescription, setErrorMessage, setImageDescriptor, setMessage, setPageComplete, setPreviousPage, setTitle, setWizard, toString
-
Methods inherited from class org.eclipse.jface.dialogs.DialogPage
convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, getControl, getDescription, getDialogFontName, getErrorMessage, getFont, getMessage, getMessageType, getTitle, getToolTipText, initializeDialogUnits, isControlCreated, performHelp, setButtonLayoutData, setControl, setMessage, setVisible
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage
createControl, getControl, getDescription, getErrorMessage, getMessage, getTitle, performHelp, setVisible
-
-
-
-
Constructor Detail
-
WizardSelectionPage
protected WizardSelectionPage(String pageName)
Creates a new wizard selection page with the given name, and with no title or image.- Parameters:
pageName
- the name of the page
-
-
Method Detail
-
canFlipToNextPage
public boolean canFlipToNextPage()
TheWizardSelectionPage
implementation of thisIWizardPage
method returnstrue
if there is a selected node.- Specified by:
canFlipToNextPage
in interfaceIWizardPage
- Overrides:
canFlipToNextPage
in classWizardPage
- Returns:
true
if the next page could be displayed, andfalse
otherwise- See Also:
WizardPage.getNextPage()
,WizardPage.isPageComplete()
-
dispose
public void dispose()
TheWizardSelectionPage
implementation of anIDialogPage
method disposes of all nested wizards. Subclasses may extend.- Specified by:
dispose
in interfaceIDialogPage
- Overrides:
dispose
in classDialogPage
-
getNextPage
public IWizardPage getNextPage()
TheWizardSelectionPage
implementation of thisIWizardPage
method returns the first page of the currently selected wizard if there is one.- Specified by:
getNextPage
in interfaceIWizardPage
- Overrides:
getNextPage
in classWizardPage
- Returns:
- the next wizard page, or
null
if none
-
getSelectedNode
public IWizardNode getSelectedNode()
Returns the currently selected wizard node within this page.- Returns:
- the wizard node, or
null
if no node is selected
-
setSelectedNode
protected void setSelectedNode(IWizardNode node)
Sets or clears the currently selected wizard node within this page.- Parameters:
node
- the wizard node, ornull
to clear
-
-