Package org.eclipse.jface.wizard
Interface IWizardPage
-
- All Superinterfaces:
IDialogPage
- All Known Subinterfaces:
IScmUrlImportWizardPage,IWorkingSetPage
- All Known Implementing Classes:
AcceptLicensesWizardPage,RefactoringWizardPage,RenameResourceWizard.RenameResourceRefactoringConfigurationPage,UserInputWizardPage,WizardDataTransferPage,WizardExportPage,WizardExportResourcesPage,WizardExternalProjectImportPage,WizardImportPage,WizardNewFileCreationPage,WizardNewFolderMainPage,WizardNewLinkPage,WizardNewProjectCreationPage,WizardNewProjectReferencePage,WizardPage,WizardResourceImportPage,WizardSelectionPage
public interface IWizardPage extends IDialogPage
Interface for a wizard page.The class
WizardPageprovides an abstract implementation of this interface. However, clients are also free to implement this interface ifWizardPagedoes not suit their needs.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleancanFlipToNextPage()Returns whether the next page could be displayed.StringgetName()Returns this page's name.IWizardPagegetNextPage()Returns the wizard page that would to be shown if the user was to press the Next button.IWizardPagegetPreviousPage()Returns the wizard page that would to be shown if the user was to press the Back button.IWizardgetWizard()Returns the wizard that hosts this wizard page.booleanisPageComplete()Returns whether this page is complete or not.voidsetPreviousPage(IWizardPage page)Sets the wizard page that would typically be shown if the user was to press the Back button.voidsetWizard(IWizard newWizard)Sets the wizard that hosts this wizard page.-
Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage
createControl, dispose, getControl, getDescription, getErrorMessage, getImage, getMessage, getTitle, performHelp, setDescription, setImageDescriptor, setTitle, setVisible
-
-
-
-
Method Detail
-
canFlipToNextPage
boolean canFlipToNextPage()
Returns whether the next page could be displayed.- Returns:
trueif the next page could be displayed, andfalseotherwise
-
getName
String getName()
Returns this page's name.- Returns:
- the name of this page
-
getNextPage
IWizardPage getNextPage()
Returns the wizard page that would to be shown if the user was to press the Next button.- Returns:
- the next wizard page, or
nullif none
-
getPreviousPage
IWizardPage getPreviousPage()
Returns the wizard page that would to be shown if the user was to press the Back button.- Returns:
- the previous wizard page, or
nullif none
-
getWizard
IWizard getWizard()
Returns the wizard that hosts this wizard page.- Returns:
- the wizard, or
nullif this page has not been added to any wizard - See Also:
setWizard(org.eclipse.jface.wizard.IWizard)
-
isPageComplete
boolean isPageComplete()
Returns whether this page is complete or not.This information is typically used by the wizard to decide when it is okay to finish.
- Returns:
trueif this page is complete, andfalseotherwise
-
setPreviousPage
void setPreviousPage(IWizardPage page)
Sets the wizard page that would typically be shown if the user was to press the Back button.This method is called by the container.
- Parameters:
page- the previous wizard page
-
setWizard
void setWizard(IWizard newWizard)
Sets the wizard that hosts this wizard page. Once established, a page's wizard cannot be changed to a different wizard.- Parameters:
newWizard- the wizard- See Also:
getWizard()
-
-