/* ====================================================================
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2000-2001 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Apache" and "Apache Software Foundation" and
 *     "Apache Jetspeed" must not be used to endorse or promote products
 *    derived from this software without prior written permission. For
 *    written permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache" or
 *    "Apache Jetspeed", nor may "Apache" appear in their name, without
 *    prior written permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */

package org.apache.jetspeed.modules.parameters;

// Turbine support
import org.apache.turbine.modules.Assembler;
import org.apache.turbine.util.RunData;

// Jetspeed logging classes
import org.apache.jetspeed.services.logging.JetspeedLogFactoryService;
import org.apache.jetspeed.services.logging.JetspeedLogger;

// Java support
import java.util.Map;
import java.util.Hashtable;
import java.util.Iterator;

/**
 * Interface to be implemented by parameter presentation style class
 *
 * @author <a href="mailto:mark_orciuch@ngsltd.com">Mark Orciuch</a>
 * @version $Id: ParameterPresentationStyle.java,v 1.3 2003/07/23 19:50:14 morciuch Exp $ 
 */
public abstract class ParameterPresentationStyle extends Assembler
{

    /**
     * Static initialization of the logger for this class
     */    
    private static final JetspeedLogger logger = JetspeedLogFactoryService.getLogger(ParameterPresentationStyle.class.getName());     
    
    private Map styleparms = null;

    /**
     * Returns presentation method html fragment
     * 
     * @param data   run context info
     * @param name   name for the returned control
     * @param value  default value for the control
     * @param parms  hashtable with presentation parameters
     * @return html for the control
     */
    public abstract String getContent(RunData data, String name, String value, Map parms);

    /**
     * Allows to initialize style parameter hashtable
     * 
     * @param parms
     */
    public void setParms(Map parms)
    {

        this.styleparms = parms;
    }

    /**
     * Allows to retrieve a style parameter with default
     * 
     * @param key
     * @param def
     * @return object
     */
    public Object getParm(String key, Object def)
    {

        Object result = null;

        if ( this.styleparms != null )
        {
            result = this.styleparms.get(key);
        }

        if ( result == null )
        {
            result = def;
        }

        return result;
    }

    /**
     * <P>Returns javascript event definitions as defined by "[name].style.javascript:[event]".</P>
     * <P> For example: <CODE>symbols.style.javascipt:onChange</CODE>
     * 
     * @return map of javascript events
     */
    public Map getJavascriptEvents()
    {

        Hashtable result = null;

        if (this.styleparms != null) 
        {
             Iterator it = this.styleparms.keySet().iterator();
             while (it.hasNext()) 
             {
                 String parmkey = (String) it.next();
                 if (parmkey.startsWith("javascript:")) 
                 {
                     try 
                     {
                         if (result == null)
                         {
                             result = new Hashtable();
                         }
                         String event = parmkey.substring(parmkey.lastIndexOf(":") + 1);
                         result.put(event, this.styleparms.get(parmkey));
                     } 
                     catch (Exception e) 
                     {
                         logger.error("Exception", e);
                     }
                 }
             }
         }

        return result;
    }

}