/*
    * Copyright (c) 2001 - 2005 ivata limited.
    * All rights reserved.
    * -----------------------------------------------------------------------------
    * ivata masks may be redistributed under the GNU General Public
    * License as published by the Free Software Foundation;
    * version 2 of the License.
    *
    * These programs are free software; you can redistribute them and/or
   * modify them under the terms of the GNU General Public License
   * as published by the Free Software Foundation; version 2 of the License.
   *
   * These programs are distributed in the hope that they 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 in the file LICENSE.txt for more
   * details.
   *
   * If you would like a copy of the GNU General Public License write to
   *
   * Free Software Foundation, Inc.
   * 59 Temple Place - Suite 330
   * Boston, MA 02111-1307, USA.
   *
   *
   * To arrange commercial support and licensing, contact ivata at
   *                  http://www.ivata.com/contact.jsp
   * -----------------------------------------------------------------------------
   * $Log: SetPropertyTag.java,v $
   * Revision 1.2  2005/04/09 18:04:20  colinmacleod
   * Changed copyright text to GPL v2 explicitly.
   *
   * Revision 1.1  2005/01/19 12:58:20  colinmacleod
   * Moved from ivata groupware.
   *
   * Revision 1.1  2004/09/30 15:16:03  colinmacleod
   * Split off addressbook elements into security subproject.
   *
   * Revision 1.2  2004/03/21 21:16:18  colinmacleod
   * Shortened name to ivata op.
   *
   * Revision 1.1.1.1  2004/01/27 20:57:58  colinmacleod
   * Moved ivata openportal to SourceForge..
   *
   * Revision 1.1.1.1  2003/10/13 20:50:13  colin
   * Restructured portal into subprojects
   *
   * Revision 1.1  2003/02/25 08:15:50  colin
   * moved to jsp category
   *
   * Revision 1.2  2003/02/04 17:43:51  colin
   * copyright notice
   *
   * Revision 1.1  2002/07/01 10:39:05  colin
   * moved from webgui to util tag library
   *
   * Revision 1.4  2002/06/13 15:45:24  peter
   * brought over to peter, fixed bugs in webgui property-settings
   *
   * Revision 1.2  2002/05/11 17:39:21  colin
   * updated and extended javadoc
   *
   * Revision 1.1  2002/04/27 17:37:48  colin
   * first compliling version in EJB/JBuilder project
   *
   * Revision 1.3  2002/01/24 13:19:40  colin
   * consolidated hanlding of theme and properties tags acoss webgui tag
   * library
   *
   * Revision 1.2  2002/01/20 19:28:25  colin
   * added tab and tree tags
   * implemented address book functionality
   * -----------------------------------------------------------------------------
   */
  package com.ivata.mask.web.tag.util;
  
  
  import java.util.Properties;
  
  import javax.servlet.jsp.JspException;
  import javax.servlet.jsp.PageContext;
  import javax.servlet.jsp.tagext.TagSupport;
  
  
  /***
   * <p>This tag is used as a simple way to set an property value on the class
   * <code>java.util.Property</code> as used by all the webgui tabs</p>
   *
   * <p><b>Tag attributes:</b><br/>
   * <table cellpadding='2' cellspacing='5' border='0' align='center'
   * width='85%'>
   *   <tr class='TableHeadingColor'>
   *     <th>attribute</th>
   *     <th>reqd.</th>
   *     <th>param. class</th>
   *     <th width='100%'>description</th>
   *   </tr>
   *   <tr class='TableRowColor'>
  *     <td>name</td>
  *     <td>true</td>
  *     <td><code>String</code></td>
  *     <td>The name of the <code>java.util.Properties</code> where the property
  * should be set.</td>
  *   </tr>
  *   <tr class='TableRowColor'>
  *     <td>property</td>
  *     <td>true</td>
  *     <td><code>String</code></td>
  *     <td>The name of the property to set.</td>
  *   </tr>
  *   <tr class='TableRowColor'>
  *     <td>value</td>
  *     <td>true</td>
  *     <td><code>String</code></td>
  *     <td>The new value for the property.</td>
  *   </tr>
  * </table>
  * </p>
  *
  * @since ivata masks 0.5 (2001-12-16)
  * @author Colin MacLeod
  * <a href='mailto:colin.macleod@ivata.com'>colin.macleod@ivata.com</a>
  * @version $Revision: 1.2 $
  */
 public class SetPropertyTag extends TagSupport {
 
     /***
      * <p>Property declaration for tag attribute: name.</p>
      */
     private String name;
 
     /***
      * <p>This variable contains the referenced properties instance.</p>
      */
     private Properties properties = null;
 
     /***
      * <p>Property declaration for tag attribute: property.</p>
      */
     private String property;
 
     /***
      * <p>Property declaration for tag attribute: value.</p>
      */
     private String value;
 
     /***
      * <p>Default constructor.</p>
      *
      */
     public SetPropertyTag() {
         super();
     }
 
     /***
      * <p>This is where the property actually gets set, whent the class
      * encounters
      * the closed, start tag.</p>
      *
      * <p>This method is called when the JSP engine encounters the start tag,
      * after the attributes are processed.<p>
      *
      * <p>Scripting variables (if any) have their values set here.</p>
      *
      * @exception JspException thrown if there is no valid
      * <code>Properties</code>
      * in this object.
      * @return <code>SKIP_BODY</code> since this tag has no body
      */
     public int doStartTag() throws JspException {
         super.doStartTag();
         // look before you leap
         if (properties == null) {
             throw new JspException(
                     "Error in SetPropertyTag: no properties object set");
         }
         properties.setProperty(property, value);
         return SKIP_BODY;
     }
 
     /***
      * <p>Get the value supplied to the attribute 'name'.</p>
      *
      * <p>This attribute represents the name of the
      * <code>java.util.Properties</code>
      * where the property should be set.</p>
      *
      * @return the value supplied to the tag attribute 'name'
      *
      */
     public final String getName() {
         return name;
     }
 
     /***
      * <p>Get the actual properties in which the value will be set.</p>
      *
      * @return the current value of properties.
      */
     public final Properties getProperties() {
         return properties;
     }
 
     /***
      * <p>Get the value supplied to the attribute 'property'.</p>
      *
      * <p>This attribute represents the name of the property to set.</p>
      *
      * @return the value supplied to the tag attribute 'property'
      *
      */
     public final String getProperty() {
         return property;
     }
 
     /***
      * <p>Get the value supplied to the attribute 'value'.</p>
      *
      * <p>This attribute represents the new value for the property.</p>
      *
      * @return the value supplied to the tag attribute 'value'
      *
      */
     public final String getValue() {
         return value;
     }
 
     /***
      * <p>Set the value supplied to the attribute 'name'.</p>
      *
      * <p>This attribute represents the name of the
      * <code>java.util.Properties</code>
      * where the property should be set. Calling this method will cause the
      * class to
      * look for a new properties objec with this name first at page and then
      * session
      * scope. If none is found an exception is thrown.</p>
      *
      * @exception JspException thrown if there is no properties instance
      * with this name at either page or session scope.
      * @param nameParam the new value supplied to the tag attribute 'name'
      */
     public final void setName(final String nameParam) throws JspException {
         this.name = nameParam;
         properties = (Properties) pageContext.getAttribute(nameParam,
                 PageContext.PAGE_SCOPE);
         if (properties == null) {
             properties = (Properties) pageContext.getAttribute(nameParam,
                     PageContext.SESSION_SCOPE);
             if (properties == null) {
                 throw new JspException(
                         "Error in SetPropertyTag: no properties found at page "
                         + "or session scope for this name: '"
                         + nameParam
                         + "'");
             }
         }
     }
 
     /***
      * <p>Set the actual properties in which the value will be set.</p>
      *
      * @param propertiesParam the new value of properties instance for which the
      * value should be set.
      */
     public final void setProperties(final Properties propertiesParam) {
         this.properties = propertiesParam;
     }
 
     /***
      * <p>Set the value supplied to the attribute 'property'.</p>
      *
      * <p>This attribute represents the name of the property to set.</p>
      *
      * @param propertyParam the name or  key of the property to set in the
      * properties.
      */
     public final void setProperty(final String propertyParam) {
         this.property = propertyParam;
     }
 
     /***
      * <p>Set the value supplied to the attribute 'value'.</p>
      *
      * <p>This attribute represents the new value for the property.</p>
      *
      * @param valueParam the new value supplied to the tag attribute 'value'
      */
     public final void setValue(final String valueParam) {
         this.value = valueParam;
     }
 }