/*
    * Copyright 2008 The Kuali Foundation
    * 
    * Licensed under the Educational Community License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    * 
    * http://www.opensource.org/licenses/ecl2.php
    * 
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package org.kuali.ole.sys.document.web;
  
  import java.util.List;
  
  import javax.servlet.jsp.JspException;
  import javax.servlet.jsp.PageContext;
  import javax.servlet.jsp.tagext.Tag;
  
  import org.apache.commons.lang.StringUtils;
  import org.kuali.ole.sys.document.datadictionary.AccountingLineViewHideShowLinesDefinition;
  import org.kuali.ole.sys.document.web.renderers.HideShowBlockRenderer;
  import org.kuali.rice.kns.util.WebUtils;
  import org.kuali.rice.kns.web.ui.Field;
  
  /**
   * A renderable element that renders child elements within a div that can be hidden or displayed
   */
  public class HideShowBlock implements RenderableElement {
      private List<AccountingLineTableRow> contentRows; 
      private AccountingLineViewHideShowLinesDefinition definition;
      private AccountingLineRenderingContext renderingContext;
      private String tabKey;
  
      /**
       * Has child table rows add any fields they know about to the List
       * @see org.kuali.ole.sys.document.web.RenderableElement#appendFields(java.util.List)
       * 
       * KRAD Conversion: Customization of adding the fields - No use of data dictionary
       */
      public void appendFields(List<Field> fields) {
         for (AccountingLineTableRow row : contentRows) {
             row.appendFields(fields);
         }
      }
  
      /**
       * This is not an action block
       * @see org.kuali.ole.sys.document.web.RenderableElement#isActionBlock()
       */
      public boolean isActionBlock() {
          return false;
      }
  
      /**
       * Checks if all of the child rows are empty or not; if one isn't empty, then this isn't empty
       * @see org.kuali.ole.sys.document.web.RenderableElement#isEmpty()
       */
      public boolean isEmpty() {
          for (AccountingLineTableRow row : contentRows) {
              if (!row.isEmpty()) return false;
          }
          return true;
      }
  
      /**
       * Checks if all the child rows are hidden; if so, then no point in showing this...
       * @see org.kuali.ole.sys.document.web.RenderableElement#isHidden()
       */
      public boolean isHidden() {
          for (AccountingLineTableRow row : contentRows) {
              if (!row.isHidden()) return false;
          }
          return true;
      }
  
      /**
       * Has child rows populate with the tab index
       * @see org.kuali.ole.sys.document.web.RenderableElement#populateWithTabIndexIfRequested(int)
       */
      public void populateWithTabIndexIfRequested(int reallyHighIndex) {
          for (AccountingLineTableRow row : contentRows) {
              row.populateWithTabIndexIfRequested(reallyHighIndex);
          }
      }
  
      /**
       * Uses a HideShowBlockRenderer to render this element
       * @see org.kuali.ole.sys.document.web.RenderableElement#renderElement(javax.servlet.jsp.PageContext, javax.servlet.jsp.tagext.Tag, org.kuali.ole.sys.document.web.AccountingLineRenderingContext)
       */
      public void renderElement(PageContext pageContext, Tag parentTag, AccountingLineRenderingContext renderingContext) throws JspException {
          this.renderingContext = renderingContext;
          
          HideShowBlockRenderer renderer = new HideShowBlockRenderer();
          renderer.setHideShowBlock(this);
         renderer.render(pageContext, parentTag);
         
         this.renderingContext = null;
     }
     
     /**
      * Forces all children rows to render themselves
      * @param pageContext the pageContext to render to
      * @param parentTag the tag requesting all this rendering
      * @throws JspException thrown if something goes wrong
      */
     public void renderChildRows(PageContext pageContext, Tag parentTag) throws JspException {
         for (AccountingLineTableRow row : contentRows) {
             row.renderElement(pageContext, parentTag, renderingContext);
         }
     }
 
     /**
      * Gets the contentRows attribute. 
      * @return Returns the contentRows.
      */
     public List<AccountingLineTableRow> getContentRows() {
         return contentRows;
     }
 
     /**
      * Sets the contentRows attribute value.
      * @param contentRows The contentRows to set.
      */
     public void setContentRows(List<AccountingLineTableRow> contentRows) {
         this.contentRows = contentRows;
     }
 
     /**
      * Sets the definition attribute value.
      * @param definition The definition to set.
      */
     public void setDefinition(AccountingLineViewHideShowLinesDefinition definition) {
         this.definition = definition;
     }
 
     /** 
      * @return the tab key for this hide/show block
      */
     public String getTabKey() {
         if (tabKey == null) {
             tabKey = WebUtils.generateTabKey(renderingContext.getGroupLabel()+definition.getLabel()) + "-" + renderingContext.getAccountingLinePropertyPath().replaceAll("\\.","-").replaceAll("\\[", "(").replaceAll("\\]", ")");
         }
         return tabKey;
     }
     
     /**
      * @return the current tab state
      */
     public String getTabState() {
         String tabState = renderingContext.getTabState(getTabKey());
         return StringUtils.isNotBlank(tabState) ? tabState : "CLOSE";
     }
     
     /**
      * Determines if this tab should currently be showing or not
      * @return true if the tab shows its contents; false otherwise
      */
     public boolean isShowing() {
         return getTabState().equals("OPEN");
     }
     
     /**
      * @return the label for this hide/show block
      */
     public String getLabel() {
         return definition.getLabel();
     }
     
     /**
      * @return the concatenation of the group label and this block's label
      */
     public String getFullLabel() {
         return renderingContext.getGroupLabel()+(!StringUtils.isBlank(definition.getLabel()) ? " "+definition.getLabel() : " Hide/Show Block");
     }
 }