org.apache.wicket.extensions.wizard.dynamic

Interface IDynamicWizardStep

All Superinterfaces:

org.apache.wicket.util.io.IClusterable, IWizardStep, Serializable

All Known Implementing Classes:

DynamicWizardStep

public interface IDynamicWizardStep
extends IWizardStep

Wizard step that is intelligent enough to know how to navigate to the next and previous steps. Using such steps, you can build wizard that consists of steps that are linked on the fly rather than in a static, pre-determined fashion. The basic idea here is that the wizard step takes over much of what otherwise would be done by the wizard model. You trade simplicity for flexibility.

Warning: only use these steps with the DynamicWizardModel.

Author:

eelcohillenius

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isLastAvailable() Checks if the last button should be enabled.
boolean	isLastStep() Gets whether this is the last step in the wizard.
boolean	isNextAvailable() Gets whether the next button should be enabled.
boolean	isPreviousAvailable() Gets whether the previous button should be enabled.
IDynamicWizardStep	last() Gets the next wizard step from here.
IDynamicWizardStep	next() Gets the next wizard step from here.
IDynamicWizardStep	previous() Gets the previous wizard step from here.

Methods inherited from interface org.apache.wicket.extensions.wizard.IWizardStep

applyState, getHeader, getView, init, isComplete

Method Detail

isLastAvailable

boolean isLastAvailable()

Checks if the last button should be enabled.

Returns:

true if the last button should be enabled, false otherwise.

See Also:

IWizardModel.isLastVisible()

isLastStep

boolean isLastStep()

Gets whether this is the last step in the wizard.

Returns:

True if its the final step in the wizard, false< otherwise.

See Also:

IWizardModel.isLastStep(IWizardStep)

isNextAvailable

boolean isNextAvailable()

Gets whether the next button should be enabled.

Returns:

True if the next button should be enabled, false otherwise.

See Also:

IWizardModel.isNextAvailable()

isPreviousAvailable

boolean isPreviousAvailable()

Gets whether the previous button should be enabled.

Returns:

True if the previous button should be enabled, false otherwise.

See Also:

IWizardModel.isPreviousAvailable()

last

IDynamicWizardStep last()

Gets the next wizard step from here. Can only be called when DynamicWizardModel.isLastAvailable() returns true.

Returns:

The next wizard step. May not be null.

next

IDynamicWizardStep next()

Gets the next wizard step from here. Can only be called when isNextAvailable() returns true.

Returns:

The next wizard step. May not be null unless this is the last step ( isLastStep() returns true).

previous

IDynamicWizardStep previous()

Gets the previous wizard step from here. Can only be called when isPreviousAvailable() returns true.

Returns:

The next wizard step. May not be null unless this is the first step (in which case it should never be called).