Merge from HEAD to WCM-DEV2.

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/WCM-DEV2/root@3659 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/web/bean/wizard/WizardState.java

@@ -0,0 +1,113 @@
+package org.alfresco.web.bean.wizard;
+
+import java.util.List;
+
+import org.alfresco.web.app.AlfrescoNavigationHandler;
+import org.alfresco.web.config.WizardsConfigElement.PageConfig;
+import org.alfresco.web.config.WizardsConfigElement.StepConfig;
+import org.alfresco.web.config.WizardsConfigElement.WizardConfig;
+
+/**
+ * Object responsible for holding the current state of an active wizard.
+ * 
+ * @author gavinc
+ */
+public final class WizardState
+{
+   private int currentStep = 1;
+   private PageConfig currentPageCfg;
+   private WizardConfig config;
+   private IWizardBean wizard;
+   private List<StepConfig> steps;
+   
+   /**
+    * Default constructor
+    * 
+    * @param config The configuration for the wizard
+    * @param wizard The wizard bean instance
+    */
+   public WizardState(WizardConfig config, IWizardBean wizard)
+   {
+      this.config = config;
+      this.wizard = wizard;
+      
+      this.steps = this.config.getStepsAsList();
+   }
+
+   /**
+    * Sets the configuration for the current page of the wizard
+    * 
+    * @param currentPageCfg The configuration
+    */
+   public void setCurrentPageCfg(PageConfig currentPageCfg)
+   {
+      this.currentPageCfg = currentPageCfg;
+   }
+   
+   /**
+    * Sets the current step the wizard is on
+    * 
+    * @param currentStep The current step number
+    */
+   public void setCurrentStep(int currentStep)
+   {
+      this.currentStep = currentStep;
+   }
+   
+   /**
+    * Returns the wizard bean instance
+    * 
+    * @return The wizard bean instance
+    */
+   public IWizardBean getWizard()
+   {
+      return this.wizard;
+   }
+
+   /**
+    * Returns the configuration for the current wizard
+    * 
+    * @return The wizard configuration
+    */
+   public WizardConfig getConfig()
+   {
+      return this.config;
+   }
+   
+   /**
+    * Returns the configuration for the current page of the wizard
+    * 
+    * @return The current page configuration
+    */
+   public PageConfig getCurrentPageCfg()
+   {
+      return currentPageCfg;
+   }
+
+   /**
+    * The current step the wizard is on
+    * 
+    * @return The current wizard step
+    */
+   public int getCurrentStep()
+   {
+      return currentStep;
+   }
+
+   /**
+    * Returns the list of steps the wizard has
+    * 
+    * @return List of wizard steps
+    */
+   public List<StepConfig> getSteps()
+   {
+      return steps;
+   }
+   
+   @Override
+   public String toString()
+   {
+      return AlfrescoNavigationHandler.WIZARD_PREFIX + this.config.getName() + 
+            "[" + this.currentStep + "]";
+   }
+}