/*
    * Licensed to the Apache Software Foundation (ASF) under one
    * or more contributor license agreements.  See the NOTICE file
    * distributed with this work for additional information
    * regarding copyright ownership.  The ASF licenses this file
    * to you under the Apache 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.apache.org/licenses/LICENSE-2.0
   *
   * 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.apache.myfaces.custom.submitOnEvent;
  
  import org.apache.myfaces.custom.dialog.ModalDialog;
  import org.apache.myfaces.custom.dojo.DojoUtils;
  import org.apache.myfaces.renderkit.html.util.AddResource;
  import org.apache.myfaces.renderkit.html.util.AddResourceFactory;
  import org.apache.myfaces.shared_tomahawk.renderkit.html.HTML;
  import org.apache.myfaces.shared_tomahawk.renderkit.html.HtmlRenderer;
  
  import javax.faces.component.ActionSource;
  import javax.faces.component.EditableValueHolder;
  import javax.faces.component.UICommand;
  import javax.faces.component.UIComponent;
  import javax.faces.component.UIInput;
  import javax.faces.component.UISelectBoolean;
  import javax.faces.component.UISelectMany;
  import javax.faces.component.UISelectOne;
  import javax.faces.context.FacesContext;
  import javax.faces.context.ResponseWriter;
  import java.io.IOException;
  import java.util.Arrays;
  import java.util.Set;
  import java.util.TreeSet;
  
  /**
   * Attach an event handler to an input element or use a global event handler to
   * submit a form by "clicking" on a link or button
   *
   * 
   * @JSFRenderer
   *   renderKitId = "HTML_BASIC" 
   *   family = "org.apache.myfaces.SubmitOnEvent"
   *   type = "org.apache.myfaces.SubmitOnEvent"
   * 
   * @version $Id: SubmitOnEventRenderer.java 673833 2008-07-03 21:58:05Z skitching $
   */
  public class SubmitOnEventRenderer extends HtmlRenderer
  {
      private final static Set ON_CHANGE_FAMILY = new TreeSet(Arrays.asList(new String[]
      {
          UISelectBoolean.COMPONENT_FAMILY,
          UISelectMany.COMPONENT_FAMILY,
          UISelectOne.COMPONENT_FAMILY
      }));
  
      public void encodeEnd(FacesContext facesContext, UIComponent uiComponent) throws IOException
      {
          SubmitOnEvent submitOnEvent = (SubmitOnEvent) uiComponent;
  
          UIComponent forComponent = null;
  
          UIComponent triggerComponent = null;
          UIComponent parent = uiComponent.getParent();
          if (parent != null)
          {
              if (UIInput.COMPONENT_FAMILY.equals(parent.getFamily())
                  || parent instanceof UIInput
                  || parent instanceof ModalDialog
                  || parent instanceof EditableValueHolder)
              {
                  triggerComponent = parent;
              }
              else if (UICommand.COMPONENT_FAMILY.equals(parent.getFamily())
                  || parent instanceof UICommand
                  || parent instanceof ActionSource)
              {
                  forComponent = parent;
              }
          }
  
          if (triggerComponent != null && !triggerComponent.isRendered())
          {
              // the component we are attaced to is not being rendered, so we can quit now ...
              return;
          }
  
          if (forComponent == null)
          {
              String forComponentId = submitOnEvent.getFor();
              if (forComponentId == null)
              {
                 throw new IllegalArgumentException("SubmitOnEvent: attribute 'for' missing");
             }
 
             forComponent = uiComponent.findComponent(forComponentId);
             if (forComponent == null)
             {
                 throw new IllegalArgumentException("SubmitOnEvent: can't find 'for'-component '" + forComponentId + "'");
             }
         }
 
         AddResourceFactory.getInstance(facesContext).addJavaScriptAtPosition(
                 facesContext, AddResource.HEADER_BEGIN, SubmitOnEventRenderer.class,
                 "submitOnEvent.js");
 
         // If the dojo library will be loaded, use it to attach to the onLoad handler.
         // Do NOT use dojo if no other component requires it, this avoids loading of this
         // heavy-weight javascript-library for just the simple submitOnEvent use-case.
         // We do this for better integration with dojo widget (e.g. our ModalDialog)
         // where using the timeout stuff is not appropriate.
         boolean useDojoForInit = DojoUtils.isDojoInitialized(facesContext);
 
         StringBuffer js = new StringBuffer(80);
 
         if (useDojoForInit)
         {
             js.append("dojo.addOnLoad(function() {");
         }
         else
         {
             js.append("setTimeout(\"");
         }
         js.append("orgApacheMyfacesSubmitOnEventRegister('");
         if (submitOnEvent.getEvent() != null)
         {
             js.append(submitOnEvent.getEvent().toLowerCase());
         }
         else
         {
             if (triggerComponent != null
                 && triggerComponent.getFamily() != null
                 && ON_CHANGE_FAMILY.contains(triggerComponent.getFamily()))
             {
                 js.append("change");
             }
             else
             {
                 js.append("keypress");
             }
         }
         js.append("','");
         if (submitOnEvent.getCallback() != null)
         {
             js.append(submitOnEvent.getCallback());
         }
         js.append("','");
         if (triggerComponent != null)
         {
             if (triggerComponent instanceof ModalDialog)
             {
                 js.append(((ModalDialog) triggerComponent).getDialogVar());
             }
             else
             {
                 js.append(triggerComponent.getClientId(facesContext));
             }
         }
         js.append("','");
         js.append(forComponent.getClientId(facesContext));
         js.append("');");
         // js.append("');");
         if (useDojoForInit)
         {
             js.append("});");
         }
         else
         {
             js.append("\", 100)");
         }
 
         // AddResourceFactory.getInstance(facesContext).addInlineScriptAtPosition(facesContext, AddResource.BODY_END, js.toString());
 
         ResponseWriter out = facesContext.getResponseWriter();
         out.startElement(HTML.SCRIPT_ELEM, uiComponent);
         out.writeAttribute(HTML.SCRIPT_LANGUAGE_ATTR, HTML.SCRIPT_LANGUAGE_JAVASCRIPT, null);
         out.writeAttribute(HTML.SCRIPT_TYPE_ATTR, HTML.SCRIPT_TYPE_TEXT_JAVASCRIPT, null);
         out.writeText(js.toString(), null);
         out.endElement(HTML.SCRIPT_ELEM);
     }
 }