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 IWizard

All Known Subinterfaces:
IConfigurationWizard, IExportWizard, IImportWizard, INewWizard, IWorkbenchWizard, IWorkingSetEditWizard, IWorkingSetNewWizard
All Known Implementing Classes:
BasicNewFileResourceWizard, BasicNewFolderResourceWizard, BasicNewProjectResourceWizard, BasicNewResourceWizard, DeleteResourcesWizard, ExternalProjectImportWizard, FileSystemExportWizard, FileSystemImportWizard, ModelParticipantWizard, MoveResourcesWizard, ParticipantSynchronizeWizard, RefactoringHistoryWizard, RefactoringWizard, RenameResourceWizard, SubscriberParticipantWizard, Wizard, ZipFileExportWizard, ZipFileImportWizard

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.

See Also:
Wizard

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 ( 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.
  Image getDefaultPageImage ()
          Returns the default page image for this wizard.
  IDialogSettings getDialogSettings ()
          Returns the dialog settings for this wizard.
  IWizardPage getNextPage ( IWizardPage page)
          Returns the successor of the given page.
  IWizardPage getPage ( 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.
  RGB getTitleBarColor ()
          Returns the title bar color for this wizard.
  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

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

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.

Returns:
true if the wizard could be finished, and false otherwise

createPageControls

void createPageControls(
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.

Parameters:
pageContainer - the parent control

dispose

void dispose()
Disposes of this wizard and frees all SWT resources.


getContainer

IWizardContainer getContainer()
Returns the container of this wizard.

Returns:
the wizard container, or null if this wizard has yet to be added to a container

getDefaultPageImage

Image getDefaultPageImage()
Returns the default page image for this wizard.

This image can be used for pages which do not supply their own image.

Returns:
the default page image

getDialogSettings

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

Returns:
the dialog settings, or null if none

getNextPage

IWizardPage getNextPage(
IWizardPage page)
Returns the successor of the given page.

This method is typically called by a wizard page

Parameters:
page - the page
Returns:
the next page, or null if none

getPage

IWizardPage getPage(
String pageName)
Returns the wizard page with the given name belonging to this wizard.

Parameters:
pageName - the name of the wizard page
Returns:
the wizard page with the given name, or null if none

getPageCount

int getPageCount()
Returns the number of pages in this wizard.

Returns:
the number of wizard pages

getPages

IWizardPage[] getPages()
Returns all the pages in this wizard.

Returns:
a list of pages

getPreviousPage

IWizardPage getPreviousPage(
IWizardPage page)
Returns the predecessor of the given page.

This method is typically called by a wizard page

Parameters:
page - the page
Returns:
the previous page, or null if none

getStartingPage

IWizardPage getStartingPage()
Returns the first page to be shown in this wizard.

Returns:
the first wizard page

getTitleBarColor

RGB getTitleBarColor()
Returns the title bar color for this wizard.

Returns:
the title bar color

getWindowTitle

String getWindowTitle()
Returns the window title string for this wizard.

Returns:
the window title string, or null for no title

isHelpAvailable

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.

Returns:
true if help is available, and false if this wizard is helpless

needsPreviousAndNextButtons

boolean needsPreviousAndNextButtons()
Returns whether this wizard needs Previous and Next buttons.

The result of this method is typically used by the container.

Returns:
true if Previous and Next buttons are required, and false if none are needed

needsProgressMonitor

boolean needsProgressMonitor()
Returns whether this wizard needs a progress monitor.

The result of this method is typically used by the container.

Returns:
true if a progress monitor is required, and false if none is needed

performCancel

boolean performCancel()
Performs any actions appropriate in response to the user having pressed the Cancel button, or refuse if canceling now is not permitted.

Returns:
true to indicate the cancel request was accepted, and false to indicate that the cancel request was refused

performFinish

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.

Returns:
true to indicate the finish request was accepted, and false to indicate that the finish request was refused

setContainer

void setContainer(
IWizardContainer wizardContainer)
Sets or clears the container of this wizard.

Parameters:
wizardContainer - the wizard container, or null

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