com.ozziefix.jlwizard
Interface WizardPage

All Known Implementing Classes:
AbstractWizardPage, DemoCommentsPage, DemoEmployeeDetailsPage, DemoGeneralPage, DemoOverviewPage, SimpleWizardPage

public interface WizardPage

The WizardPage constitutes (a part of) the view of a Wizard.

Version:
$Revision: 1.1 $
Author:
$author$

Method Summary
 java.lang.String getDescription()
           The description of the page.
 WizardAction getFinishAction()
           The action that should be executed when the finish button is clicked.
 WizardAction getHelpAction()
           The action that should be executed when the help button is clicked.
 javax.swing.Icon getIcon()
           The icon that represents this page.
 WizardAction getNextAction()
           The action that should be executed when the next button is clicked.
 javax.swing.JComponent getPageComponent()
           The JComponent that represents this page.
 WizardAction getPreviousAction()
           The action that should be executed when the previous button is clicked.
 java.lang.String getTitle()
           The title of this page.
 Wizard getWizard()
           Get the parent wizard
 void load(WizardModel model)
           load the data from the WizardModel in this page.
 void setWizard(Wizard wizard)
           This method should only be called by JLWizard, when adding a page to it.
 void store(WizardModel model)
           store the input from this page in the WizardModel.
 void validateInput()
           validate the input from this page.
 

Method Detail

getDescription

java.lang.String getDescription()

The description of the page. This could be used in a wizard title bar.

Returns:
The description

getFinishAction

WizardAction getFinishAction()

The action that should be executed when the finish button is clicked. If the finish button should be disabled on this page, then this must return null.

Returns:
The FinishAction

getHelpAction

WizardAction getHelpAction()

The action that should be executed when the help button is clicked. If the help button should be disabled on this page, then this must return null.

Returns:
The HelpAction

getIcon

javax.swing.Icon getIcon()

The icon that represents this page. This icon could be used is a wizard title bar. This should be an 64x64 icon.

Returns:
The icon

getNextAction

WizardAction getNextAction()

The action that should be executed when the next button is clicked. If the next button should be disabled on this page, then this must return null.

Returns:
The NextAction

getPageComponent

javax.swing.JComponent getPageComponent()

The JComponent that represents this page.

Returns:
the pageComponent

getPreviousAction

WizardAction getPreviousAction()

The action that should be executed when the previous button is clicked. If the previous button should be disabled on this page, then this must return null.

Returns:
the PreviousAction

getTitle

java.lang.String getTitle()

The title of this page. This could be used in the title bar of a wizard.

Returns:
the title

setWizard

void setWizard(Wizard wizard)

This method should only be called by JLWizard, when adding a page to it.

Parameters:
wizard - the wizard this page belongs to.

getWizard

Wizard getWizard()

Get the parent wizard

Returns:
the wizard this page belongs to

load

void load(WizardModel model)

load the data from the WizardModel in this page. This method is called just before the page is made visible.

Parameters:
model - the current WizardModel

store

void store(WizardModel model)

store the input from this page in the WizardModel. This method is called just before the page is made invisible, and after validateInput().

Parameters:
model - the current WizardModel

validateInput

void validateInput()
                   throws ValidationException

validate the input from this page. This method is called before the input is stored in the WizardModel.

Throws:
ValidationException - when the validation fails


Copyright © 2004 - 2005 by Jurgen Lust.