org.tbee.swing.wizard
Interface WizardModel

All Known Implementing Classes:

WizardModelDefault

public interface WizardModel

This model manages the steps in a wizard. The prepare method of the first step is not called, since it should not return any errors. Assumed is that the last step is the actual executing step, where processing is done in the prepare method of the last step. If the prepare of the last step succeed, the wizard will return exit status SUCCESS otherwise FAILED. The validate method of the last step is never called, since all processing should be finished by then. Finish immediately jumps to the last step by executing the prepares and validates of all intermediate steps. If an error occurs along the way, it will stop there (of course this should not happen). The prepare of the last step is finally executed and the last step is shown. Having a manual execute can be achieved by placing a button in the wizard step instead of using the wizard's buttons. You can IDEAS: we could add a "transaction controller" with begin, commit and rollback that showStep will call correspondingly

Version:

$Revision: 1.4 $

Field Summary

static int	EXITSTATUS_CANCELLED
static int	EXITSTATUS_ERROR
static int	EXITSTATUS_SUCCESS

Method Summary

void	addStep(int idx, WizardStep step)
void	addStep(WizardStep step)
void	addWizardListener(WizardListener ccl)
String[]	finish()
int	getCurrentStep()
WizardStep	getCurrentWizardStep()
int	getExitStatus()
int	getIndexOfStep(WizardStep step)
WizardStep	getStep(int idx)
int	getStepCount()
String[]	gotoFirstStep()
String[]	gotoLastStep()
String[]	gotoNextStep()
String[]	gotoPreviousStep()
void	removeStep(int idx)
void	removeStep(WizardStep step)
void	removeWizardListener(WizardListener ccl)
void	setExitStatus(int value)
String[]	showStep(int idx)

Field Detail

EXITSTATUS_CANCELLED

static final int EXITSTATUS_CANCELLED

See Also:

Constant Field Values

EXITSTATUS_ERROR

static final int EXITSTATUS_ERROR

See Also:

Constant Field Values

EXITSTATUS_SUCCESS

static final int EXITSTATUS_SUCCESS

See Also:

Constant Field Values

Method Detail

getStepCount

int getStepCount()

getStep

WizardStep getStep(int idx)

addStep

void addStep(WizardStep step)

addStep

void addStep(int idx,
             WizardStep step)

removeStep

void removeStep(int idx)

removeStep

void removeStep(WizardStep step)

getCurrentWizardStep

WizardStep getCurrentWizardStep()

getIndexOfStep

int getIndexOfStep(WizardStep step)

showStep

String[] showStep(int idx)

gotoFirstStep

String[] gotoFirstStep()

gotoPreviousStep

String[] gotoPreviousStep()

gotoNextStep

String[] gotoNextStep()

gotoLastStep

String[] gotoLastStep()

finish

String[] finish()

getCurrentStep

int getCurrentStep()

getExitStatus

int getExitStatus()

setExitStatus

void setExitStatus(int value)

addWizardListener

void addWizardListener(WizardListener ccl)

removeWizardListener

void removeWizardListener(WizardListener ccl)