org.apache.wicket.extensions.wizard

Interface IWizardStep

All Superinterfaces:

IClusterable, Serializable

All Known Subinterfaces:

IDynamicWizardStep

All Known Implementing Classes:

DynamicWizardStep, StaticContentStep, WizardStep

public interface IWizardStep
extends IClusterable

Models one step in a wizard, and is the equivalent of one panel in a wizard from an end-user's perspective.

Typically, you would extend panel based wizard steps and provide a custom panel for the step instead of directly implementing this interface.

Swing Wizard Framework served as a valuable source of inspiration.

Author:

Eelco Hillenius

Method Summary

Modifier and Type	Method and Description
void	applyState() This method is called whenever the wizard proceeds from this step to another step.
Component	getHeader(String id, Component parent, IWizard wizard) Gets the header component for this step.
Component	getView(String id, Component parent, IWizard wizard) Returns the current view this step is displaying.
void	init(IWizardModel wizardModel) Initializes this step with the model it will belong to.
boolean	isComplete() Checks if this step is complete.

Method Detail

init

void init(IWizardModel wizardModel)

Initializes this step with the model it will belong to.

This method is called at least once before this step becomes the actual step.

Parameters:

wizardModel - the owning wizard model

getHeader

Component getHeader(String id,
                    Component parent,
                    IWizard wizard)

Gets the header component for this step. This component is displayed in a special section of the wizard.

This method is called every time this step becomes the active step of the wizard.

Parameters:

id - The id that the component should be created with

parent - The parent component (for post 1.2)

wizard - The wizard component the header will be placed on

Returns:

The header component

getView

Component getView(String id,
                  Component parent,
                  IWizard wizard)

Returns the current view this step is displaying. This component will be displayed in the main section of the wizard.

This method is called every time this step becomes the active step of the wizard.

Parameters:

id - The id that the component should be created with

parent - The parent component (for post 1.2)

wizard - The wizard component the header will be placed on

Returns:

The current view of the step.

applyState

void applyState()

This method is called whenever the wizard proceeds from this step to another step. It is not called when returning to a previous step.

See Also:

IWizardModel.next(), IWizardModel.last(), IWizardModel.finish()

isComplete

boolean isComplete()

Checks if this step is complete. This method should return true if the wizard can proceed to the next step.

Returns:

true if the wizard can proceed from this step, false otherwise.

See Also:

IWizardModel.next(), IWizardModel.last(), IWizardModel.finish()