com.lf.commons.wizard

Interface WizardPage

All Known Implementing Classes:

BackupCheckPage, BackupFormatPage, CheckBoxPage, ComboChooserPage, DatabaseChooserPage, DatabaseConnectorPage, DatabasePanelPage, DatabaseSetupPage, FileSystemPage, PGPExportPage, PGPGenKeyPage, PGPKeyChooserPage, PGPPassphrasePage, PGPRecipientPage, PGPSignerPage, RadioButtonPage, VFSPage

public interface WizardPage

Interface for configuring and displaying specialized pages of the wizard dialog.

Wizard pages are components to be displayed in the main region of the wizard dialog.

Since:

1.6

Version:

$Revision: 1.8 $, $Date: 2016/01/01 15:43:03 $

Author:

Axel Schwolow

Method Summary

Methods

Modifier and Type	Method and Description
java.awt.Component	getComponent() Provides the GUI component to be displayed.
Configuration	getConfiguration() Provides the current user settings specified by user interaction.
javax.swing.ImageIcon	getIcon() Provides the graphical icon of the page used for display.
WizardPage	getNextPage() Provides the next page to be displayed by the dialog.
java.lang.String	getOverviewText() Provides the text displayed by the overview (shorter than title).
WizardPage[]	getPossibleNextPages() Provides the set of pages that are possibly displayed next.
java.lang.String	getTitle() Provides the title of the page used for display.
void	pageAdded(WizardDialog parent) Informs the wizard page that it will soon be used by the wizard dialog.
void	pageBecomesHidden() Informs the wizard page that it will be made invisible by the dialog.
void	pageBecomesShown() Informs the wizard page that it will be made visible by the dialog.
void	pageIsHiding() Informs the wizard page that it was made invisible by the wizard.
void	pageIsShowing() Informs the wizard page that it was made visible by the dialog.
void	setNextPage(WizardPage page) Sets the next page to be displayed by the dialog.

Method Detail

getTitle

java.lang.String getTitle()

Provides the title of the page used for display.

Returns:

The page title

Since:

1.6

getOverviewText

java.lang.String getOverviewText()

Provides the text displayed by the overview (shorter than title).

Returns:

The overview text

Since:

1.6

getIcon

javax.swing.ImageIcon getIcon()

Provides the graphical icon of the page used for display.

Returns:

The page icon

Since:

1.6

getComponent

java.awt.Component getComponent()

Provides the GUI component to be displayed.

Returns:

The GUI component, normally the subclass itself

Since:

1.6

pageAdded

void pageAdded(WizardDialog parent)

Informs the wizard page that it will soon be used by the wizard dialog.

Parameters:

parent - The wizard dialog

Since:

1.6

pageBecomesShown

void pageBecomesShown()

Informs the wizard page that it will be made visible by the dialog.

Since:

1.6

pageBecomesHidden

void pageBecomesHidden()

Informs the wizard page that it will be made invisible by the dialog.

Since:

1.6

pageIsShowing

void pageIsShowing()

Informs the wizard page that it was made visible by the dialog.

This is the right time to setup the dialog buttons as required. The "Back" button is set automatically depending on the pages on the stack before this method is called. The page can override the setting here.

Since:

1.6

pageIsHiding

void pageIsHiding()

Informs the wizard page that it was made invisible by the wizard.

Since:

1.6

setNextPage

void setNextPage(WizardPage page)

Sets the next page to be displayed by the dialog.

Parameters:

page - The next page to be shown, null means last page

Since:

1.6

getNextPage

WizardPage getNextPage()

Provides the next page to be displayed by the dialog.

Returns:

The next page to be shown, null means last page

Since:

1.6

getPossibleNextPages

WizardPage[] getPossibleNextPages()

Provides the set of pages that are possibly displayed next.

The wizard class determines whether the page sequence is fixed or not. Fixed sequences allow the dialog to display the full overview containing all steps.

Returns:

The set of possible pages, null means last page

Since:

1.6

getConfiguration

Configuration getConfiguration()

Provides the current user settings specified by user interaction.

The wizard calling routines can then perform actions based on the user settings.

Returns:

The page settings

Since:

1.6