IWizardPage

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> eclipse >> jface >> [ wizard overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.eclipse.jface.wizard.IWizardPage

SOURCE |

Download org.eclipse.jface.wizard.IWizardPage

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.jface.wizard
Interface IWizardPage

All Superinterfaces:: org.eclipse.jface.dialogs.IDialogPage

All Known Implementing Classes:: WizardPage

public interface IWizardPage
extends org.eclipse.jface.dialogs.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.

java.lang.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

public boolean canFlipToNextPage()

Returns whether the next page could be displayed.

getName

public java.lang.String getName()

Returns this page's name.

getNextPage

public IWizardPage getNextPage()

Returns the wizard page that would to be shown if the user was to press the Next button.

getPreviousPage

public IWizardPage getPreviousPage()

Returns the wizard page that would to be shown if the user was to press the Back button.

getWizard

public IWizard getWizard()

Returns the wizard that hosts this wizard page.

isPageComplete

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

setPreviousPage

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

setWizard

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