/**
    * This file is part of the equanda project.
    *
    * The contents of this file are subject to the Mozilla Public License Version 1.1 (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.mozilla.org/MPL/
    *
    * Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF
    * ANY KIND, either express or implied. See the License for the specific language governing rights and
   * limitations under the License.
   *
   * Alternatively, the contents of this file may be used under the terms of
   * either the GNU General Public License Version 2 or later (the "GPL"), or
   * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
   * in which case the provisions of the GPL or the LGPL are applicable instead
   * of those above. If you wish to allow use of your version of this file only
   * under the terms of either the GPL or the LGPL, and not to allow others to
   * use your version of this file under the terms of the MPL, indicate your
   * decision by deleting the provisions above and replace them with the notice
   * and other provisions required by the GPL or the LGPL. If you do not delete
   * the provisions above, a recipient may use your version of this file under
   * the terms of any one of the MPL, the GPL or the LGPL.
   */
  
  package org.equanda.tapestry5.base;
  
  import org.apache.tapestry5.Block;
  import org.apache.tapestry5.ComponentResources;
  import org.apache.tapestry5.RenderSupport;
  import org.apache.tapestry5.annotations.Environmental;
  import org.apache.tapestry5.annotations.Parameter;
  import org.apache.tapestry5.annotations.SetupRender;
  import org.apache.tapestry5.annotations.SupportsInformalParameters;
  import org.apache.tapestry5.ioc.annotations.Inject;
  import org.apache.tapestry5.services.RequestGlobals;
  import org.slf4j.Logger;
  
  import javax.servlet.http.Cookie;
  import java.io.Serializable;
  import java.util.ArrayList;
  import java.util.List;
  
  /**
   * Abstract superclass for tapestry components that consist of list of maximum 50 panels, where only
   * one of the panels is currently active. A typical example is a tabs component.
   *
   * @author <a href="mailto:joachim@progs.be">Joachim Van der Auwera</a>
   * @author <a href="mailto:geert@synergetics.be">Geert Mergan</a>
   */
  @SupportsInformalParameters
  abstract public class TitleContent
  {
      private static final int MAX_PANELS = 50; // max number of supported panels
  
      @Environmental
      private RenderSupport renderSupport;
  
      @Inject
      private ComponentResources resources;
  
      @Parameter
      private Block titleIcon;
  
      @Parameter
      private Integer exclude;
  
      @Inject
      private RequestGlobals requestGlobals;
  
      @Inject
      private Logger log;
  
      private TwoBlocks panel;
      private int index;
      private int panelCount;
      private String assignedId;
  
      private int activeIndex;
  
      /**
       * TitleContent provides a cookie-based mechanism to keep track of the component which is currently active.
       * Is the superclass going to use this cookie-based mechanism or not?
       *
       * @return true if it will use the cookies, false otherwise.
       */
      abstract public boolean isUsingCookies();
  
      protected int getActiveIndex()
      {
          return activeIndex;
      }
  
      protected void setActiveIndex( int activeIndex )
      {
          this.activeIndex = activeIndex;
      }
  
      public String getId()
      {
         return assignedId;
     }
 
     public int getIndex()
     {
         return index;
     }
 
     public void setIndex( int index )
     {
         this.index = index;
     }
 
     public TwoBlocks getPanel()
     {
         return panel;
     }
 
     public void setPanel( TwoBlocks panel )
     {
         this.panel = panel;
     }
 
     public Block getTitleIcon()
     {
         return titleIcon;
     }
 
     public void setTitleIcon( Block titleIcon )
     {
         this.titleIcon = titleIcon;
     }
 
     public List<TwoBlocks> getPanels()
     {
         panelCount = 0;
         List<TwoBlocks> list = new ArrayList<TwoBlocks>();
         for ( int i = 0; i < MAX_PANELS ; i++ )
         {
             String index = Integer.toString( i + 1 );
             if ( resources.isBound( "title" + index ) && resources.isBound( "content" + index ) )
             {
                 list.add( new TwoBlocks( i + 1 ) );
             }
         }
         if ( exclude != null )
         {
             if ( exclude >= 0 )
             {
                 if ( list.size() > 0 && exclude < list.size() )
                 {
                     list.remove( exclude.intValue() );
                 }
             }
             else
             {
                 int lastIndex = list.size() + ( exclude );
                 if ( lastIndex >= 0 && lastIndex < list.size() )
                 {
                     list = new ArrayList<TwoBlocks>( list.subList( 0, lastIndex ) );
                 }
             }
         }
         panelCount = list.size();
         return list;
     }
 
     @SetupRender
     protected final void setupRender()
     {
         assignedId = renderSupport.allocateClientId( resources );
         if ( isUsingCookies() )
         {
             Cookie[] cookies = requestGlobals.getHTTPServletRequest().getCookies();
             if ( cookies != null )
             {
                 for ( Cookie cookie : cookies )
                 {
                     if ( cookie.getName().equalsIgnoreCase( "active_index_" + assignedId ) )
                     {
                         String val = cookie.getValue();
                         if ( val != null && val.trim().length() > 0 )
                         {
                             try
                             {
                                 setActiveIndex( Integer.parseInt( val ) );
                             }
                             catch ( Exception e )
                             {
                                 log.warn( "Failed to parse cookie with active index: " + val );
                             }
                         }
                         break;
                     }
                 }
             }
         }
         if ( getActiveIndex() == 0 )
         {
             setActiveIndex( 1 );
         }
     }
 
     public int getPanelCount()
     {
         return panelCount;
     }
 
     public class TwoBlocks
         implements Serializable
     {
         private Block title, content;
         private boolean active;
 
         public TwoBlocks( int index )
         {
             active = ( getActiveIndex() == index );
             title = resources.getBlockParameter( "title" + index );
             content = resources.getBlockParameter( "content" + index );
         }
 
         public Block getTitle()
         {
             return title;
         }
 
         public void setTitle( Block title )
         {
             this.title = title;
         }
 
         public Block getContent()
         {
             return content;
         }
 
         public void setContent( Block content )
         {
             this.content = content;
         }
 
         public boolean isActive()
         {
             return active;
         }
 
         public void setActive( boolean active )
         {
             this.active = active;
         }
     }
 }