/***
    Copyright (C) 2005 The Java Community
   
    This program is free software; you can redistribute it and/or modify  it under
    the terms of the GNU General Public License as published by  the Free Software
    Foundation; either version 2 of the License, or  (at your option) any later
    version.
   
    This program is distributed in the hope that it will be useful,  but WITHOUT
   ANY WARRANTY; without even the implied warranty of  MERCHANTABILITY or FITNESS
   FOR A PARTICULAR PURPOSE. See the  GNU General Public License for more details.
  
   You should have received a copy of the GNU General Public License  along with
   this program; if not, write to the Free Software  Foundation, Inc., 59 Temple
   Place, Suite 330, Boston, MA 02111-1307 USA.
   */
  package org.bejug.javacareers.common.ajax;
  
  import java.beans.Beans;
  import java.io.IOException;
  import java.util.Map;
  
  import javax.faces.component.UIComponent;
  import javax.faces.context.FacesContext;
  import javax.faces.context.ResponseWriter;
  
  import com.sun.faces.renderkit.html_basic.HtmlBasicInputRenderer;
  import com.sun.faces.util.Util;
  
  
  /***
   * This renderer generates HTML (including JavaScript) for AjaxTextFields,
   * emitting the necessary markup to provide auto completion for the textfield.
   * <p/>
   * This component relies on a cooperating servlet that responds to asynchronous
   * requests.
   *
   * @author Tor Norbye
   */
  public class TextFieldRenderer extends HtmlBasicInputRenderer {
  
      /***
       * the next id
       */
      private int nextId = 0;
  
      /***
       * the key for the rendererscript.
       */
      private static final String RENDERED_SCRIPT_KEY = "bpcatalog-ajax-script-rendered";
  
      /***
       * Creates a new instance of TextFieldRenderer
       */
      public TextFieldRenderer() {
      }
  
      /***
       * begin of the encoding.
       *
       * @param context   the FacesContext.
       * @param component the UIComponent to encode.
       * @throws IOException thrown when the encoding failes.
       */
      public void encodeBegin(FacesContext context, UIComponent component)
              throws IOException {
      }
  
      /***
       * encode the children.
       *
       * @param context   the FacesContext.
       * @param component the UIComponent to encode.
       */
      public void encodeChildren(FacesContext context, UIComponent component) {
      }
  
      /***
       * @param context      the FacesContext.
       * @param component    the component to render.
       * @param currentValue a String containing the currentvalue of the component.
       * @throws IOException thrown when the rendering failes.
       */
      protected void getEndTextToRender(FacesContext context, UIComponent component,
                                        String currentValue) throws IOException {
          //assert component instanceof TextField;
  
          ResponseWriter writer = context.getResponseWriter();
  
          if (!Beans.isDesignTime()) {
              renderScriptOnce(writer, component, context);
          }
  
          String menuId = "menu-popup" + (nextId);
          nextId++;
  
          if (!Beans.isDesignTime()) {
              // Render menu popup (will be positioned etc. by CSS)
              writer.startElement("div", component);
             writer.writeAttribute("id", menuId, null);
             writer.writeAttribute("style",
                     "position: absolute; top:170px;left:140px;visibility:hidden", null);
             writer.writeAttribute("class", "popupFrame", null);
             writer.endElement("div");
             writer.write("\n");
         }
 
         writer.startElement("input", component);
         writeIdAttributeIfNecessary(context, writer, component);
 
         // Set the autocomplete attribute to "off" to disable browser 
         // textfield completion with previous entries
         writer.writeAttribute("autocomplete", "off", null);
 
         writer.writeAttribute("type", "text", null);
         writer.writeAttribute("name", component.getClientId(context), "clientId");
 
         if (currentValue != null) {
             writer.writeAttribute("value", currentValue, "value");
         }
 
         String styleClass = (String) component.getAttributes().get("styleClass");
 
         if (styleClass != null) {
             writer.writeAttribute("class", styleClass, "styleClass");
         }
 
         Util.renderPassThruAttributes(writer, component);
         Util.renderBooleanPassThruAttributes(writer, component);
 
         // Emit the javascript for auto completion
         TextField comp = (TextField) component;
         String methodName = comp.getCompletionMethod();
         String startScript =
                 "doCompletion('" + comp.getClientId(context) + "','" + menuId + "','" + methodName +
                 "'," + ((comp.getOnchoose() != null) ? comp.getOnchoose() : "null") + "," +
                 ((comp.getOndisplay() != null) ? comp.getOndisplay() : "null") + ");";
         String stopScript = "stopCompletionDelayed('" + menuId + "');";
         writer.writeAttribute("onfocus", startScript, null);
         writer.writeAttribute("onkeyup", startScript, null);
         writer.writeAttribute("onblur", stopScript, null);
 
         writer.endElement("input");
     }
 
     /***
      * Render the &lt;script&gt; tag which contains supporting JavaScript
      * for this text field.
      *
      * @param writer    the ResponseWriter for rendering the script-tag
      * @param component the UIComponent contained by the script-tag
      * @param context   the FacesContext.
      * @throws IOException when the rendering of the sript-tag failes.
      */
     private void renderScriptOnce(ResponseWriter writer, UIComponent component, FacesContext context)
             throws IOException {
         // Only render the generic <style> and <script> sections once per page:
         // Store attribute in request map when we've rendered the script such
         // that we only do this once per page
         Map requestMap = context.getExternalContext().getRequestMap();
         Boolean scriptRendered = (Boolean) requestMap.get(RENDERED_SCRIPT_KEY);
 
         if (scriptRendered == Boolean.TRUE) {
             return;
         }
 
         requestMap.put(RENDERED_SCRIPT_KEY, Boolean.TRUE);
 
         // CSS
         writer.write("\n");
 
         writer.startElement("link", component);
         writer.writeAttribute("type", "text/css", null);
         writer.writeAttribute("rel", "stylesheet", null);
 
         //String href = PhaseListener.CSS_VIEW_ID + ".faces";
         String href = "faces/" + PhaseListener.CSS_VIEW_ID;
         writer.writeAttribute("href", href, null);
 
         writer.endElement("link");
         writer.write("\n");
 
         // JavaScript
         writer.startElement("script", component);
         writer.writeAttribute("type", "text/javascript", null);
 
         //String src = PhaseListener.SCRIPT_VIEW_ID + ".faces";
         String src = "faces/" + PhaseListener.SCRIPT_VIEW_ID;
         writer.writeAttribute("src", src, null);
 
         writer.endElement("script");
         writer.write("\n");
     }
 }
 
 /***
  * $Log: TextFieldRenderer.java,v $
  * Revision 1.6  2005/09/13 08:11:06  schauwvliege
  * organize imports
  *
  * Revision 1.5  2005/08/10 12:07:42  bavo_jcs
  * Optimized imports according to checkstyle
  *
  * Revision 1.4  2005/08/10 09:04:45  bavo_jcs
  * Optimized imports according to checkstyle
  *
  * Revision 1.3  2005/08/09 12:59:50  bavo_jcs
  * Optimized imports
  *
  * Revision 1.2  2005/08/08 12:07:54  bme_jcs
  * resolved checkstyle errors
  *
  * Revision 1.1  2005/07/13 11:42:08  bavo_jcs
  * Ajax rename and test-cleanup
  *
  * Revision 1.1  2005/07/13 11:16:53  bavo_jcs
  * Moved Ajax files
  *
  * Revision 1.1  2005/07/06 14:15:30  bavo_jcs
  * Ajax integration
  *
  */