com.plealog.wizard.model

Class WizardModel

java.lang.Object

com.plealog.wizard.model.WizardModel

public abstract class WizardModel
extends Object

This class describes the data model of a WizardDialog. It is actually made of one or more WizardStepModel(s).

Constructor Summary

Constructors

Constructor and Description
WizardModel(WizardStepModel firstStep) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(WizardListener wizardListener) Add a listener.
void	cancel() Method call when Wizard progress to cancel status.
boolean	canPrevious() Is it possible to progress to previous step.
void	cleanup() Clean the data model.
void	finish() Method call when Wizard progress to finish status.
protected void	fireCurrentStep(WizardStepModel oldStep, WizardStepModel newStep) Notify listeners that current step has changed.
protected void	fireFinishable(boolean finishable) Notify listeners that finish status has been selected or not.
protected void	fireNextable() Notify listeners of that next status has been selected.
protected void	firePreviousable() Notify listeners that previous status has been selected.
WizardStepModel	getCurrentStep()
abstract String	getDescription() Retruns a human readable description of this Wizard.
protected WizardStepModel	getFirstStep()
List<WizardStepModel>	getStepHistory()
boolean	isFinishable() Is it possible to progress to finish status.
abstract boolean	isFinishable(Stack<WizardStepModel> stack) Is it possible to finish ?
boolean	isMovingBackwards() Return true while executing commit on current step view during previousStep().
boolean	isNextable() Is it possible to progress to next step ?
WizardStepModel	next() Get the next step data model.
void	nextStep() Progress to next step.
WizardStepModel	previous() Get the previous step data model.
void	previousStep() Progress to previous step.
void	removeListener(WizardListener wizardListener) Remove a listener
protected void	setCurrentStep(WizardStepModel newStep, boolean oldStepAlreadyCommitted) Set a new step.
void	setFinishable(boolean finishable) Update the finish status.

Methods inherited from class java.lang.Object

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

Constructor Detail

WizardModel

public WizardModel(WizardStepModel firstStep)

Constructor.

Parameters:

firstStep - the data model of the first wizard's step

Method Detail

setCurrentStep

protected final void setCurrentStep(WizardStepModel newStep,
                  boolean oldStepAlreadyCommitted)

Set a new step.

Parameters:

newStep - the new step data model

oldStepAlreadyCommitted - true if previous step has been committed

fireCurrentStep

protected final void fireCurrentStep(WizardStepModel oldStep,
                   WizardStepModel newStep)

Notify listeners that current step has changed.

Parameters:

oldStep - previous step data model

newStep - new step data model

next

public final WizardStepModel next()

Get the next step data model.

Returns:

the next step

previous

public final WizardStepModel previous()

Get the previous step data model.

Returns:

the previous step

nextStep

public void nextStep()

Progress to next step.

fireNextable

protected void fireNextable()

Notify listeners of that next status has been selected.

isNextable

public boolean isNextable()

Is it possible to progress to next step ?

previousStep

public void previousStep()

Progress to previous step.

isMovingBackwards

public boolean isMovingBackwards()

Return true while executing commit on current step view during previousStep().

firePreviousable

protected final void firePreviousable()

Notify listeners that previous status has been selected.

canPrevious

public final boolean canPrevious()

Is it possible to progress to previous step.

isFinishable

public final boolean isFinishable()

Is it possible to progress to finish status.

isFinishable

public abstract boolean isFinishable(Stack<WizardStepModel> stack)

Is it possible to finish ?

Parameters:

stack - the step data models

Returns:

true if wizard can be closed, false otherwise.

fireFinishable

protected void fireFinishable(boolean finishable)

Notify listeners that finish status has been selected or not.

Parameters:

finishable -

setFinishable

public final void setFinishable(boolean finishable)

Update the finish status.

finish

public void finish()

Method call when Wizard progress to finish status.

cancel

public void cancel()

Method call when Wizard progress to cancel status.

getStepHistory

public List<WizardStepModel> getStepHistory()

Returns:

The history of data model steps.

getCurrentStep

public final WizardStepModel getCurrentStep()

Returns:

The current step.

getFirstStep

protected WizardStepModel getFirstStep()

Returns:

The first step.

getDescription

public abstract String getDescription()

Retruns a human readable description of this Wizard.

addListener

public final void addListener(WizardListener wizardListener)

Add a listener.

Parameters:

wizardListener -

cleanup

public void cleanup()

Clean the data model.

removeListener

public final void removeListener(WizardListener wizardListener)

Remove a listener

Parameters:

wizardListener -