net.sf.juife.wizard
Interface WizardModel

All Known Implementing Classes:

AbstractWizardModel, DefaultWizardModel

public interface WizardModel

This interface defines a suitable data model for a Wizard.

Method Summary

void	addActionListener(java.awt.event.ActionListener l) Registers the specified ActionListener to be notified when the current page is changed.
WizardPage	getCurrentPage() Gets the current page.
java.lang.String	getCurrentStep() Gets the current step in the wizard.
java.lang.String[]	getSteps() Gets a String array providing the current list of steps.
boolean	hasLast() Determines whether the last page is specified.
boolean	hasNext() Determines whether there is a next page in this wizard.
boolean	hasPrevious() Determines whether there is a previous page in this wizard.
WizardPage	last() Moves to the last page in the wizard.
WizardPage	next() Moves to the next page in the wizard.
WizardPage	previous() Moves to the previous page in the wizard.
void	removeActionListener(java.awt.event.ActionListener l) Removes the specified listener.

Method Detail

addActionListener

void addActionListener(java.awt.event.ActionListener l)

Registers the specified ActionListener to be notified when the current page is changed.

Parameters:

l - The ActionListener to register.

removeActionListener

void removeActionListener(java.awt.event.ActionListener l)

Removes the specified listener.

Parameters:

l - The ActionListener to remove.

hasNext

boolean hasNext()

Determines whether there is a next page in this wizard.

Returns:

true if there is a next page in this wizard, false otherwise.

See Also:

next()

next

WizardPage next()

Moves to the next page in the wizard.

Returns:

The next page in the wizard.

See Also:

hasNext()

hasPrevious

boolean hasPrevious()

Determines whether there is a previous page in this wizard.

Returns:

true if there is a previous page in this wizard, false otherwise.

See Also:

previous()

previous

WizardPage previous()

Moves to the previous page in the wizard.

Returns:

The previous page in the wizard.

See Also:

hasPrevious()

hasLast

boolean hasLast()

Determines whether the last page is specified. If the last page is specified the 'Last' button in the wizard will be enabled.

Returns:

true if last page is specified, false otherwise.

See Also:

last()

last

WizardPage last()

Moves to the last page in the wizard. Last page is the page which will be displayed when the user clicks the 'Last' button. Note that the last page in the wizard is not necessarily the last page in the model.

Returns:

The page specified as last in the wizard.

See Also:

hasLast()

getCurrentPage

WizardPage getCurrentPage()

Gets the current page.

Returns:

The current page or null if there isn't current page yet.

getSteps

java.lang.String[] getSteps()

Gets a String array providing the current list of steps.

Returns:

A String array providing the current list of steps or null if the list of steps is not available.

getCurrentStep

java.lang.String getCurrentStep()

Gets the current step in the wizard.

Returns:

The current step in the wizard or null if there is no current step.