org.alfresco.web.bean.wizard

Class WizardState

java.lang.Object

org.alfresco.web.bean.wizard.WizardState

All Implemented Interfaces:

Serializable

public final class WizardState
extends Object
implements Serializable

Object responsible for holding the current state of an active wizard.

Author:

gavinc

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
WizardState(WizardsConfigElement.WizardConfig config, IWizardBean wizard) Default constructor

Method Summary

Modifier and Type	Method and Description
WizardsConfigElement.WizardConfig	getConfig() Returns the configuration for the current wizard
WizardsConfigElement.PageConfig	getCurrentPageCfg() Returns the configuration for the current page of the wizard
int	getCurrentStep() The current step the wizard is on
List<WizardsConfigElement.StepConfig>	getSteps() Returns the list of steps the wizard has
IWizardBean	getWizard() Returns the wizard bean instance
void	setCurrentPageCfg(WizardsConfigElement.PageConfig currentPageCfg) Sets the configuration for the current page of the wizard
void	setCurrentStep(int currentStep) Sets the current step the wizard is on
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

WizardState

public WizardState(WizardsConfigElement.WizardConfig config,
                   IWizardBean wizard)

Default constructor

Parameters:

config - The configuration for the wizard

wizard - The wizard bean instance

Method Detail

setCurrentPageCfg

public void setCurrentPageCfg(WizardsConfigElement.PageConfig currentPageCfg)

Sets the configuration for the current page of the wizard

Parameters:

currentPageCfg - The configuration

setCurrentStep

public void setCurrentStep(int currentStep)

Sets the current step the wizard is on

Parameters:

currentStep - The current step number

getWizard

public IWizardBean getWizard()

Returns the wizard bean instance

Returns:

The wizard bean instance

getConfig

public WizardsConfigElement.WizardConfig getConfig()

Returns the configuration for the current wizard

Returns:

The wizard configuration

getCurrentPageCfg

public WizardsConfigElement.PageConfig getCurrentPageCfg()

Returns the configuration for the current page of the wizard

Returns:

The current page configuration

getCurrentStep

public int getCurrentStep()

The current step the wizard is on

Returns:

The current wizard step

getSteps

public List<WizardsConfigElement.StepConfig> getSteps()

Returns the list of steps the wizard has

Returns:

List of wizard steps

toString

public String toString()

Overrides:

toString in class Object