com.plealog.wizard.model

Class WizardStepModel

java.lang.Object

com.plealog.wizard.model.WizardStepModel

public abstract class WizardStepModel
extends Object

Data model of a single wizard step.

Constructor Summary

Constructors

Constructor and Description
WizardStepModel()

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(WizardListener listener) Add a listener to the model.
void	cleanup() Clean up the data model.
abstract String	getDescription() Human readable description of this data model.
WizardModel	getModel() Get the global WizardModel
List<WizardStepModel>	getNextSteps()
abstract String	getShortDescription() Return a short description of this data model
String	getSummary() Return a summary of this step after validation.
abstract WizardStepView	getView() Get the view associated to this data model.
boolean	isCommitable() Figures out whether or not the data model is in a state compatible with Wizard step progression.
boolean	isCurrentStep() Returns whether or not this step is the current step of the wizard data model.
abstract WizardStepModel	next() Return the next step.
void	removeListener(WizardListener listener) Remove a listener from the model.
void	setModel(WizardModel paramWizardModel) Set the global wizard model.
void	setSummary(String summary) Set the summary of this step.
protected void	stepEntered() Method called when the step is entered.
protected void	stepExited() Method called when exit from the step

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WizardStepModel

public WizardStepModel()

Method Detail

getView

public abstract WizardStepView getView()

Get the view associated to this data model.

Returns:

a wizard step model

addListener

public final void addListener(WizardListener listener)

Add a listener to the model.

Parameters:

listener -

removeListener

public final void removeListener(WizardListener listener)

Remove a listener from the model.

Parameters:

listener -

isCommitable

public boolean isCommitable()

Figures out whether or not the data model is in a state compatible with Wizard step progression.

Returns:

true if model can be commited

cleanup

public void cleanup()

Clean up the data model.

getDescription

public abstract String getDescription()

Human readable description of this data model.

getShortDescription

public abstract String getShortDescription()

Return a short description of this data model

next

public abstract WizardStepModel next()

Return the next step.

Returns:

the next step or null if it is the last step.

isCurrentStep

public final boolean isCurrentStep()

Returns whether or not this step is the current step of the wizard data model.

stepEntered

protected void stepEntered()

Method called when the step is entered.

stepExited

protected void stepExited()

Method called when exit from the step

getModel

public final WizardModel getModel()

Get the global WizardModel

Returns:

the wizard model

setModel

public final void setModel(WizardModel paramWizardModel)

Set the global wizard model.

Parameters:

paramWizardModel -

getSummary

public String getSummary()

Return a summary of this step after validation.

setSummary

public void setSummary(String summary)

Set the summary of this step.

getNextSteps

public final List<WizardStepModel> getNextSteps()

Returns:

The next steps