org.springframework.richclient.wizard
Interface WizardPage

Show UML class diagram

All Superinterfaces:

ControlFactory, DialogPage, Guarded, Messagable, PropertyChangePublisher

All Known Implementing Classes:

AbstractWizardPage, FormBackedWizardPage, SetupIntroWizardPage, SetupLicenseWizardPage

public interface WizardPage
extends DialogPage, Guarded

Field Summary

Fields inherited from interface org.springframework.richclient.dialog.DialogPage

DESCRIPTION_PROPERTY, PAGE_COMPLETE_PROPERTY

Fields inherited from interface org.springframework.richclient.dialog.Messagable

MESSAGE_PROPERTY

Method Summary

boolean	canFlipToNextPage() Returns whether the next page could be displayed.
WizardPage	getNextPage() Returns the wizard page that would to be shown if the user was to press the Next button.
WizardPage	getPreviousPage() Returns the wizard page that would to be shown if the user was to press the Back button.
Wizard	getWizard() Returns the wizard that hosts this wizard page.
void	onAboutToShow()
void	setPreviousPage(WizardPage page) Sets the wizard page that would typically be shown if the user was to press the Back button.
void	setWizard(Wizard newWizard) Sets the wizard that hosts this wizard page.

Methods inherited from interface org.springframework.richclient.dialog.DialogPage

getDescription, getIcon, getId, getImage, getMessage, getTitle, isPageComplete, isVisible, performHelp, setVisible

Methods inherited from interface org.springframework.richclient.factory.ControlFactory

getControl

Methods inherited from interface org.springframework.richclient.dialog.Messagable

setMessage

Methods inherited from interface org.springframework.binding.value.PropertyChangePublisher

addPropertyChangeListener, addPropertyChangeListener, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from interface org.springframework.richclient.core.Guarded

isEnabled, setEnabled

Method Detail

getNextPage

WizardPage 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

WizardPage 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

setPreviousPage

void setPreviousPage(WizardPage 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

getWizard

Wizard 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.springframework.richclient.wizard.Wizard)

canFlipToNextPage

boolean canFlipToNextPage()

Returns whether the next page could be displayed.

Returns:

true if the next page could be displayed, and false otherwise

setWizard

void setWizard(Wizard 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()

onAboutToShow

void onAboutToShow()