Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.jface.wizard
Interface IWizardPage

All Superinterfaces:
IDialogPage
All Known Subinterfaces:
IWorkingSetPage
All Known Implementing Classes:
RefactoringWizardPage, 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 WizardPage provides an abstract implementation of this interface. However, clients are also free to implement this interface if WizardPage does not suit their needs.


Method Summary
 boolean canFlipToNextPage ()
          Returns whether the next page could be displayed.
  String getName ()
          Returns this page's name.
  IWizardPage getNextPage ()
          Returns the wizard page that would to be shown if the user was to press the Next button.
  IWizardPage getPreviousPage ()
          Returns the wizard page that would to be shown if the user was to press the Back button.
  IWizard getWizard ()
          Returns the wizard that hosts this wizard page.
 boolean isPageComplete ()
          Returns whether this page is complete or not.
 void setPreviousPage ( IWizardPage page)
          Sets the wizard page that would typically be shown if the user was to press the Back button.
 void setWizard ( 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:
true if the next page could be displayed, and false otherwise

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 null if 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 null if none

getWizard

IWizard getWizard()
Returns the wizard that hosts this wizard page.

Returns:
the wizard, or null if 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:
true if this page is complete, and false otherwise

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()

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire