/**
    * 2008, Digitalis Informatica. All rights reserved. Distribuicao e Gestao de Informatica, Lda. Estrada de Paco de Arcos
    * num.9 - Piso -1 2780-666 Paco de Arcos Telefone: (351) 21 4408990 Fax: (351) 21 4408999 http://www.digitalis.pt
    */
   package pt.digitalis.dif.presentation.views.jsp.taglibs.objects;
   
   import java.util.List;
   import java.util.Map;
   
  import pt.digitalis.dif.controller.http.HTTPConstants;
  import pt.digitalis.dif.controller.interfaces.IDIFRequest;
  import pt.digitalis.dif.presentation.views.jsp.taglibs.AbstractDIFTag;
  import pt.digitalis.dif.presentation.views.jsp.taglibs.layout.Wizard;
  import pt.digitalis.dif.presentation.views.jsp.taglibs.objects.beans.WizardStepItem;
  
  /**
   * Helper class that defines a wizard to be rendered on an HTML page
   * 
   * @author Pedro Viegas <a href="mailto:pviegas@digitalis.pt">pviegas@digitalis.pt</a>
   * @created Jan 22, 2009
   */
  public class WizardDefinition {
  
      /** The wizard's form navigation action parameter hidden field */
      public static final String HTML_ACTION_PARAMETER = "_wiz_nav_action";
  
      /** A parameter to control if the wizard step has executed */
      public static final String HTML_EXECUTION_STATE_PARAMETER = "_wiz_executed_step";
  
      /** The wizard's form active step parameter hidden field */
      public static final String HTML_STEP_PARAMETER = "_wiz_step";
  
      /** The wizard's form navigation go to step parameter hidden field */
      public static final String HTML_TO_STEP_PARAMETER = "_wiz_nav_tostep";
  
      /** The index layout rendered in the left of the wizard container */
      public static final String LEFT_INDEX_LAYOUT = "left";
  
      /** The index layout rendered in the top of the wizard container */
      public static final String TOP_INDEX_LAYOUT = "top";
  
      /** Max chars that the top index may contain. More will force a dynamic shortening of the step names */
      public static final int TOP_INDEX_MAX_CHARS = 100;
  
      /**
       * Max chars that the top index may contain in a single title. More will force a truncate operation on these
       * specific titles
       */
      public static final int TOP_INDEX_SINGLE_MAX_CHARS = 30;
  
      /**
       * @param request
       *            the current stage dif request
       * @param wizardName
       *            the wizard/form name
       * @param hasIndex
       *            if the wizard has an index page
       * @param canNavigate
       *            if the wizard can navigate from the present step
       * @param wizardDef
       *            a wizard definition object instance if available
       * @return the current active step number
       */
      static public int getWizardActiveStepNumber(IDIFRequest request, String wizardName, boolean hasIndex,
              boolean canNavigate, WizardDefinition wizardDef)
      {
          int wizardStep;
  
          Object stepParameter = request.getParameter(HTML_STEP_PARAMETER);
          Object actionParameter = request.getParameter(HTML_ACTION_PARAMETER);
          Object formParameter = request.getParameter(HTTPConstants.FORM_SUBMIT_NAME);
          Object stageParameter = request.getParameter(HTTPConstants.FORM_SUBMIT_STAGE);
          Object directStepNavParameter = request.getParameter(HTML_TO_STEP_PARAMETER);
  
          if (stepParameter == null && wizardDef != null)
          {
              // No step given, infer step from the stage...
              for (int i = 0; i < wizardDef.getItems().size(); i++)
              {
                  if (request.getStage().equals(wizardDef.getItems().get(i).getStageId()))
                  {
                      // Found wizard step for the given stage...
                      actionParameter = request.getParameter(WizardDefinition.HTML_ACTION_PARAMETER);
  
                      stepParameter = ++i;
  
                      break;
                  }
              }
  
              // Inferred the first stage from the wizard stage list
              // Since there is an index page we set it instead if no forms have been submitted
              if (wizardDef.getHasIndexPage() && stepParameter != null && (Integer) stepParameter == 2)
              {
                  Object submittedStage = request.getParameter(HTTPConstants.FORM_SUBMIT_STAGE);
  
                  if (submittedStage == null || request.getStage().equalsIgnoreCase(submittedStage.toString()))
                      stepParameter = 1;
              }
 
             request.addParameter(WizardDefinition.HTML_STEP_PARAMETER, stepParameter);
             request.addParameter(WizardDefinition.HTML_TO_STEP_PARAMETER, stepParameter);
             request.addParameter(HTTPConstants.FORM_SUBMIT_NAME, wizardDef.getName());
             request.addParameter(HTTPConstants.FORM_SUBMIT_STAGE, request.getStage());
 
             stepParameter = request.getParameter(HTML_STEP_PARAMETER);
             actionParameter = request.getParameter(HTML_ACTION_PARAMETER);
             formParameter = wizardDef.getName();
             stageParameter = request.getStage();
         }
 
         if (stepParameter == null || formParameter == null || !wizardName.equalsIgnoreCase(formParameter.toString())
                 || stageParameter == null || !request.getStage().equalsIgnoreCase(stageParameter.toString()))
             wizardStep = 1;
         else
         {
             wizardStep = Integer.parseInt(stepParameter.toString());
 
             if (canNavigate || (hasIndex && wizardStep == 1))
             {
                 if (directStepNavParameter != null)
                 {
                     wizardStep = Integer.parseInt(directStepNavParameter.toString().split(" ")[0]);
 
                 }
                 else if (actionParameter != null)
                 {
                     String action = actionParameter.toString();
                     Map<String, String> messages = AbstractDIFTag.getTagMessages(Wizard.class, request.getSession()
                             .getLanguage());
 
                     if (action.equalsIgnoreCase(messages.get("previous")) && wizardStep > 1)
                         wizardStep--;
                     // FIXME: Viegas: Wizard implementation - Must determine the number of steps
                     else if (action.equalsIgnoreCase(messages.get("next")) && wizardStep < 90)
                         wizardStep++;
                 }
             }
         }
 
         return wizardStep;
     }
 
     /** The current wizard step */
     private Integer activeStep;
 
     /** If the finish button is enabled */
     private Boolean canFinish;
 
     /** The description of the wizard. For the index page */
     private String description;
 
     /** the layout of the inner form */
     private String formLayout;
 
     /** if there should exist an auto generated wizard index page */
     private Boolean hasIndexPage;
 
     /** the wizard content fixed height. Forces inner scroll when the content exceeds it */
     private Integer height;
 
     /** the layout of the index when visible */
     private String indexLayout;
 
     /** The list of items of the current wizard */
     private List<WizardStepItem> items;
 
     /** The name (id) of the wizard */
     private String name;
 
     /** set required indicator active or inactive */
     private boolean noRequiredIndicator = false;
 
     /** Readonly wizard */
     private Boolean readonly = false;
 
     /** if the index should be showed on all pages */
     private Boolean showIndex;
 
     /** Turn on or off the titlePrefix */
     private boolean showTitlePrefix = true;
 
     /** Submit title message */
     private String submitTitle;
 
     /** The title of the wizard */
     private String title;
 
     /** Customize the title prefix message */
     private String titlePrefix;
 
     /** If T a top navigation will be added to the bottom one */
     private Boolean topNavigation = false;
 
     /** IF the wizard should render it's inner components inside it's form */
     private Boolean wrapWithForm = true;
 
     /**
      * Default constructor
      * 
      * @param name
      * @param items
      */
     public WizardDefinition(String name, List<WizardStepItem> items)
     {
         this.items = items;
         this.name = name;
         this.activeStep = null;
     }
 
     /**
      * Default constructor
      * 
      * @param name
      * @param items
      * @param activeStep
      */
     public WizardDefinition(String name, List<WizardStepItem> items, int activeStep)
     {
         this.items = items;
         this.name = name;
         this.activeStep = activeStep;
     }
 
     /**
      * @return the activeStep
      */
     public int getActiveStep()
     {
         return activeStep;
     }
 
     /**
      * @return the canFinish
      */
     public Boolean getCanFinish()
     {
         if (canFinish == null)
             return (getActiveStep() == items.size());
         else
             return canFinish;
     }
 
     /**
      * @return the description
      */
     public String getDescription()
     {
         return description;
     }
 
     /**
      * Inspector for the 'formLayout' attribute.
      * 
      * @return the formLayout value
      */
     public String getFormLayout()
     {
         return formLayout;
     }
 
     /**
      * @return the hasIndexPage
      */
     public Boolean getHasIndexPage()
     {
         if (hasIndexPage == null)
             return getDescription() != null;
         else
             return hasIndexPage;
     }
 
     /**
      * Inspector for the 'height' attribute.
      * 
      * @return the height value
      */
     public Integer getHeight()
     {
         return height;
     }
 
     /**
      * @return the indexLayout
      */
     public String getIndexLayout()
     {
         if (indexLayout == null)
             return LEFT_INDEX_LAYOUT;
 
         return indexLayout;
     }
 
     /**
      * @return the items
      */
     public List<WizardStepItem> getItems()
     {
         return items;
     }
 
     /**
      * @return the name
      */
     public String getName()
     {
         return name;
     }
 
     /**
      * Inspector for the 'readonly' attribute.
      * 
      * @return the readonly value
      */
     public Boolean getReadonly()
     {
         return readonly;
     }
 
     /**
      * @return the showIndex
      */
     public Boolean getShowIndex()
     {
         if (showIndex == null)
             return false;
         else
             return showIndex;
     }
 
     /**
      * Inspector for the 'submitTitle' attribute.
      * 
      * @return the submitTitle value
      */
     public String getSubmitTitle()
     {
         return submitTitle;
     }
 
     /**
      * @return the title
      */
     public String getTitle()
     {
         return title;
     }
 
     /**
      * Inspector for the 'titlePrefix' attribute.
      * 
      * @return the titlePrefix value
      */
     public String getTitlePrefix()
     {
         return titlePrefix;
     }
 
     /**
      * Inspector for the 'topNavigation' attribute.
      * 
      * @return the topNavigation value
      */
     public Boolean getTopNavigation()
     {
         return topNavigation;
     }
 
     /**
      * Inspector for the 'wrapWithForm' attribute.
      * 
      * @return the wrapWithForm value
      */
     public Boolean getWrapWithForm()
     {
         return wrapWithForm;
     }
 
     /**
      * Inspector for the 'noRequiredIndicator' attribute.
      * 
      * @return the noRequiredIndicator value
      */
     public boolean isNoRequiredIndicator()
     {
         return noRequiredIndicator;
     }
 
     /**
      * Inspector for the 'showTitlePrefix' attribute.
      * 
      * @return the showTitlePrefix value
      */
     public boolean isShowTitlePrefix()
     {
         return showTitlePrefix;
     }
 
     /**
      * @param activeStep
      *            the activeStep to set
      */
     public void setActiveStep(int activeStep)
     {
         this.activeStep = activeStep;
     }
 
     /**
      * @param canFinish
      *            the canFinish to set
      */
     public void setCanFinish(Boolean canFinish)
     {
         this.canFinish = canFinish;
     }
 
     /**
      * @param description
      *            the description to set
      */
     public void setDescription(String description)
     {
         this.description = description;
     }
 
     /**
      * Modifier for the 'formLayout' attribute.
      * 
      * @param formLayout
      *            the new formLayout value to set
      */
     public void setFormLayout(String formLayout)
     {
         this.formLayout = formLayout;
     }
 
     /**
      * @param hasIndexPage
      *            the hasIndexPage to set
      */
     public void setHasIndexPage(Boolean hasIndexPage)
     {
         this.hasIndexPage = hasIndexPage;
     }
 
     /**
      * Modifier for the 'height' attribute.
      * 
      * @param height
      *            the new height value to set
      */
     public void setHeight(Integer height)
     {
         this.height = height;
     }
 
     /**
      * @param indexLayout
      *            the indexLayout to set
      */
     public void setIndexLayout(String indexLayout)
     {
         this.indexLayout = indexLayout;
     }
 
     /**
      * @param items
      *            the items to set
      */
     public void setItems(List<WizardStepItem> items)
     {
         this.items = items;
     }
 
     /**
      * @param name
      *            the name to set
      */
     public void setName(String name)
     {
         this.name = name;
     }
 
     /**
      * Modifier for the 'noRequiredIndicator' attribute.
      * 
      * @param noRequiredIndicator
      *            the new noRequiredIndicator value to set
      */
     public void setNoRequiredIndicator(boolean noRequiredIndicator)
     {
         this.noRequiredIndicator = noRequiredIndicator;
     }
 
     /**
      * Modifier for the 'readonly' attribute.
      * 
      * @param readonly
      *            the new readonly value to set
      */
     public void setReadonly(Boolean readonly)
     {
         this.readonly = readonly;
     }
 
     /**
      * @param showIndex
      *            the showIndex to set
      */
     public void setShowIndex(Boolean showIndex)
     {
         this.showIndex = showIndex;
     }
 
     /**
      * Modifier for the 'showTitlePrefix' attribute.
      * 
      * @param showTitlePrefix
      *            the new showTitlePrefix value to set
      */
     public void setShowTitlePrefix(boolean showTitlePrefix)
     {
         this.showTitlePrefix = showTitlePrefix;
     }
 
     /**
      * Modifier for the 'submitTitle' attribute.
      * 
      * @param submitTitle
      *            the new submitTitle value to set
      */
     public void setSubmitTitle(String submitTitle)
     {
         this.submitTitle = submitTitle;
     }
 
     /**
      * @param title
      *            the title to set
      */
     public void setTitle(String title)
     {
         this.title = title;
     }
 
     /**
      * Modifier for the 'titlePrefix' attribute.
      * 
      * @param titlePrefix
      *            the new titlePrefix value to set
      */
     public void setTitlePrefix(String titlePrefix)
     {
         this.titlePrefix = titlePrefix;
     }
 
     /**
      * Modifier for the 'topNavigation' attribute.
      * 
      * @param topNavigation
      *            the new topNavigation value to set
      */
     public void setTopNavigation(Boolean topNavigation)
     {
         this.topNavigation = topNavigation;
     }
 
     /**
      * Modifier for the 'wrapWithForm' attribute.
      * 
      * @param wrapWithForm
      *            the new wrapWithForm value to set
      */
     public void setWrapWithForm(Boolean wrapWithForm)
     {
         this.wrapWithForm = wrapWithForm;
     }
 }