org.springframework.richclient.wizard
Class AbstractWizardPage

Show UML class diagram

java.lang.Object
  org.springframework.richclient.application.support.ApplicationServicesAccessor
      org.springframework.richclient.core.LabeledObjectSupport
          org.springframework.richclient.dialog.AbstractDialogPage
              org.springframework.richclient.wizard.AbstractWizardPage

All Implemented Interfaces:

PropertyChangePublisher, CommandLabelConfigurable, DescribedElement, DescriptionConfigurable, Guarded, TitleConfigurable, VisualizedElement, DialogPage, Messagable, ControlFactory, IconConfigurable, ImageConfigurable, WizardPage

Direct Known Subclasses:

FormBackedWizardPage, SetupIntroWizardPage, SetupLicenseWizardPage

public abstract class AbstractWizardPage
extends AbstractDialogPage
implements WizardPage

Field Summary

Fields inherited from class org.springframework.richclient.core.LabeledObjectSupport

logger

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

Fields inherited from interface org.springframework.richclient.core.DescribedElement

CAPTION_PROPERTY, DESCRIPTION_PROPERTY, DISPLAY_NAME_PROPERTY

Constructor Summary

protected	AbstractWizardPage(String pageId) Creates a wizard page.
protected	AbstractWizardPage(String pageId, boolean autoConfigure) Creates a new wizard page.
protected	AbstractWizardPage(String pageId, boolean autoConfigure, String title) Creates a new wizard page with the given title.
protected	AbstractWizardPage(String pageId, boolean autoConfigure, String title, Image icon) Creates a new wizard page with the given title and image.

Method Summary

boolean	canFlipToNextPage() Returns whether the next page could be displayed.
protected WizardContainer	getContainer()
Image	getImage() Returns the image associated with the application component, or null.
String	getKey()
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.
protected boolean	isCurrentPage()
void	onAboutToShow()
void	setEnabled(boolean enabled) Sets the enabled state of the object.
void	setPreviousPage(WizardPage page) Sets the wizard page that would typically be shown if the user was to press the Back button.
void	setVisible(boolean visible) Sets the visibility of this dialog page.
void	setWizard(Wizard newWizard) Sets the wizard that hosts this wizard page.
String	toString()

Methods inherited from class org.springframework.richclient.dialog.AbstractDialogPage

createControl, getControl, getIcon, getId, getMessage, getParentWindowControl, getTitle, hasErrorMessage, hasInfoMessage, hasWarningMessage, isControlCreated, isEnabled, isPageComplete, isVisible, performHelp, setIcon, setId, setMessage, setPageComplete

Methods inherited from class org.springframework.richclient.core.LabeledObjectSupport

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, getAccelerator, getCaption, getDescription, getDisplayName, getLabel, getMnemonic, getMnemonicIndex, hasChanged, hasChanged, hasChanged, removePropertyChangeListener, removePropertyChangeListener, setCaption, setDescription, setImage, setLabelInfo, setTitle

Methods inherited from class org.springframework.richclient.application.support.ApplicationServicesAccessor

getActiveWindow, getApplication, getApplicationContext, getApplicationName, getApplicationServices, getCommandConfigurer, getComponentFactory, getConversionService, getIconSource, getImageSource, getMessage, getMessage, getMessage, getMessage, getMessages, getMessageSource, getObjectConfigurer, getService

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

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

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

Constructor Detail

AbstractWizardPage

protected AbstractWizardPage(String pageId)

Creates a wizard page. This titles of this dialog page will be configured using the default ObjectConfigurer.

Parameters:

pageId - the id of this wizard page. This will be used to configure the page.

AbstractWizardPage

protected AbstractWizardPage(String pageId,
                             boolean autoConfigure)

Creates a new wizard page.

Parameters:

pageId - the id of this wizard page

autoConfigure - whether or not to use an ObjectConfigurer to configure the titles of this dialog page using the given pageId

AbstractWizardPage

protected AbstractWizardPage(String pageId,
                             boolean autoConfigure,
                             String title)

Creates a new wizard page with the given title.

Parameters:

pageId - the id of this wizard page

autoConfigure - whether or not to use an ObjectConfigurer to configure the titles of this dialog page using the given pageId

title - the title of this wizard page, or null if none

AbstractWizardPage

protected AbstractWizardPage(String pageId,
                             boolean autoConfigure,
                             String title,
                             Image icon)

Creates a new wizard page with the given title and image.

Parameters:

pageId - the id of this wizard page

autoConfigure - whether or not to use an ObjectConfigurer to configure the titles of this wizard page using the given pageId

title - the title of this wizard page, or null if none

image - the image for this wizard page, or null if none

Method Detail

getKey

public String getKey()

getImage

public Image getImage()

Description copied from interface: VisualizedElement

Returns the image associated with the application component, or null.

Specified by:

getImage in interface VisualizedElement

Specified by:

getImage in interface DialogPage

Overrides:

getImage in class LabeledObjectSupport

Returns:

the image for this dialog page, or null if none

getNextPage

public WizardPage getNextPage()

Description copied from interface: WizardPage

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

Specified by:

getNextPage in interface WizardPage

Returns:

the next wizard page, or null if none

getPreviousPage

public WizardPage getPreviousPage()

Description copied from interface: WizardPage

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

Specified by:

getPreviousPage in interface WizardPage

Returns:

the previous wizard page, or null if none

canFlipToNextPage

public boolean canFlipToNextPage()

Description copied from interface: WizardPage

Returns whether the next page could be displayed.

Specified by:

canFlipToNextPage in interface WizardPage

Returns:

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

isCurrentPage

protected boolean isCurrentPage()

getContainer

protected WizardContainer getContainer()

getWizard

public Wizard getWizard()

Description copied from interface: WizardPage

Returns the wizard that hosts this wizard page.

Specified by:

getWizard in interface WizardPage

Returns:

the wizard, or null if this page has not been added to any wizard

See Also:

WizardPage.setWizard(org.springframework.richclient.wizard.Wizard)

setPreviousPage

public void setPreviousPage(WizardPage page)

Description copied from interface: WizardPage

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.

Specified by:

setPreviousPage in interface WizardPage

Parameters:

page - the previous wizard page

setVisible

public void setVisible(boolean visible)

Description copied from interface: DialogPage

Sets the visibility of this dialog page.

Specified by:

setVisible in interface DialogPage

Overrides:

setVisible in class AbstractDialogPage

Parameters:

visible - true to make this page visible, and false to hide it

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: Guarded

Sets the enabled state of the object.

Specified by:

setEnabled in interface Guarded

Overrides:

setEnabled in class AbstractDialogPage

Parameters:

enabled - true to enable the object, false to disable it.

setWizard

public void setWizard(Wizard newWizard)

Description copied from interface: WizardPage

Sets the wizard that hosts this wizard page. Once established, a page's wizard cannot be changed to a different wizard.

Specified by:

setWizard in interface WizardPage

Parameters:

newWizard - the wizard

See Also:

WizardPage.getWizard()

onAboutToShow

public void onAboutToShow()

Specified by:

onAboutToShow in interface WizardPage

toString

public String toString()

Overrides:

toString in class LabeledObjectSupport