org.alfresco.web.bean.wizard
Class WizardState

java.lang.Object
  extended by org.alfresco.web.bean.wizard.WizardState
All Implemented Interfaces:
java.io.Serializable

public final class WizardState
extends java.lang.Object
implements java.io.Serializable

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

See Also:
Serialized Form

Constructor Summary
WizardState(WizardsConfigElement.WizardConfig config, IWizardBean wizard)
          Default constructor
 
Method Summary
 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
 java.util.List 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
 java.lang.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 java.util.List getSteps()
Returns the list of steps the wizard has

Returns:
List of wizard steps

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.