/*
    * 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: MultiboxTag.java,v $
   * Revision 1.4  2005/04/09 18:04:20  colinmacleod
   * Changed copyright text to GPL v2 explicitly.
   *
   * Revision 1.3  2005/03/10 10:45:38  colinmacleod
   * Fixes for tomcat4. Changed setters and getters
   * to both use the same types.
   *
   * Revision 1.2  2005/01/19 13:14:04  colinmacleod
   * Renamed CausedByException to SystemException.
   *
   * Revision 1.1  2005/01/06 23:10:06  colinmacleod
   * Moved up a version number.
   * Changed copyright notices to 2005.
   * Updated the documentation:
   *   - started working on multiproject:site docu.
   *   - changed the logo.
   * Added checkstyle and fixed LOADS of style issues.
   * Added separate thirdparty subproject.
   * Added struts (in web), util and webgui (in webtheme) from ivata op.
   *
   * Revision 1.6  2004/12/23 21:01:32  colinmacleod
   * Updated Struts to v1.2.4.
   * Changed base classes to use ivata masks.
   *
   * Revision 1.5  2004/11/03 16:12:09  colinmacleod
   * Changed fieldPath to resourceFieldPath.
   *
   * Revision 1.4  2004/07/13 19:48:10  colinmacleod
   * Moved project to POJOs from EJBs.
   * Applied PicoContainer to services layer (replacing session EJBs).
   * Applied Hibernate to persistence layer (replacing entity EJBs).
   *
   * Revision 1.3  2004/03/21 21:16:35  colinmacleod
   * Shortened name to ivata op.
   *
   * Revision 1.2  2004/02/04 23:56:23  colinmacleod
   * Prepared text for ivata op
   *
   * Revision 1.1.1.1  2004/01/27 20:59:40  colinmacleod
   * Moved ivata op to SourceForge.
   *
   * Revision 1.2  2003/10/16 15:43:03  jano
   * Fixes problems with building and some problems with splitting to subprojects
   *
   * Revision 1.1.1.1  2003/10/13 20:49:26  colin
   * Restructured portal into subprojects
   *
   * Revision 1.1  2003/06/02 23:47:13  colin
   * added multibox tag
   * -----------------------------------------------------------------------------
   */
  package com.ivata.mask.web.tag.html;
  import java.util.List;
  
  import javax.servlet.jsp.JspException;
  import org.apache.struts.taglib.TagUtils;
  import com.ivata.mask.util.StringHandling;
  /***
   * <p>
   * Overrides an HTML <code>&lt;input type=checkbox&gt;</code> tag, by
   * overriding the <code>multibox</code> class from <strong>Struts </strong>.
   * </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>
  * <td>fieldName</td>
  * <td>true</td>
  * <td><code>java.lang.String</code></td>
  * <td>The field name is used to default the following attributes of the tag:
  * <br/>
  * <ul>
  * <li><code>styleId</code></li>
  * <li><code>titleKey</code></li>
  * <li><code>valueKey</code></li>
  * </ul>.</td>
  * </tr>
  * <tr>
  * <td>mandatory</td>
  * <td>false</td>
  * <td><code>boolean</code></td>
  * <td>Specifies data for this tag must be entered when the form is submitted.
  * </td>
  * </tr>
  * <tr>
  * <td>readOnly</td>
  * <td>false</td>
  * <td><code>boolean</code></td>
  * <td>Specifies the form elements should be displayed only and cannot be
  * altered.</td>
  * </tr>
  * </table>
  * </p>
  *
  * <p>
  * <b>Note: </b> all the tag attributes from {@link
  * org.apache.struts.taglib.CheckboxTag Stuts} are also included.
  * </p>
  *
  * @since ivata masks 0.4 (2003-05-22)
  * @author Colin MacLeod
  * <a href='mailto:colin.macleod@ivata.com'>colin.macleod@ivata.com</a>
  * @version $Revision: 1.4 $
  */
 public class MultiboxTag extends org.apache.struts.taglib.html.MultiboxTag {
     /***
      * <p>
      * Stores the label which is displayed to the right of the checkbox.
      * </p>
      */
     private String label;
     /***
      * <p>
      * Stores and maintains <strong>ivata op </strong> specific mask properties.
      * </p>
      */
     private MaskProperties maskProperties = new MaskProperties();
     /***
      * <p>
      * Overridden to check whether or not the field is read only, and to apply
      * mandatory field attributes.
      * </p>
      *
      * @return <code>EVAL_PAGE</code> since we always want to evaluate the
      *         page after this tag.
      *
      * @throws JspException
      *             if there is an error wrting to <code>out.print()</code>
      *
      */
     public int doEndTag() throws JspException {
         // TODO: handle read-only here
         int returnValue = super.doEndTag();
         if (!StringHandling.isNullOrEmpty(label)) {
             TagUtils.getInstance().write(pageContext, " " + label);
         }
         maskProperties.reset(this);
         return returnValue;
     }
     /***
      * <p>
      * Overridden to call <code>MaskProperties</code> initialization.
      * </p>
      *
      * @return value returned by superclass method, or <code>SKIP_BODY</code>
      *         if this tag is read-only.
      *
      * @throws JspException
      *             if either <code>valueKey</code> or <code>titleKey</code>
      *             have not been set, or as thrown by superclass method.
      */
     public int doStartTag() throws JspException {
         maskProperties.doStartTag(this, pageContext);
         if (this.value == null) {
             this.value = "true";
         }
         return super.doStartTag();
     }
     public final List getLabelArgs() {
         return maskProperties.getLabelArgs();
     }
     /***
      * <p>
      * Stores and maintains <strong>ivata op </strong> specific mask properties.
      * </p>
      *
      * @return the current value of maskProperties.
      */
     public MaskProperties getMaskProperties() {
         return maskProperties;
     }
     public final List getTitleArgs() {
         return maskProperties.getTitleArgs();
     }
     /***
      * <p>
      * >Name of the field to which this label refers. This is used in
      * conjunction with the <code>resourceFieldPath</code> to retrieve the
      * correct message resources path.
      * </p>
      *
      * @param fieldName
      *            the new value of fieldName.
      */
     public void setFieldName(final String fieldName) {
         maskProperties.setFieldName(fieldName);
     }
     /***
      * <p>
      * Called by <code>MaskProperties</code> to set the label.
      * </p>
      *
      * @param labelParam new text to be displayed as the label.
      */
     public void setLabel(final String labelParam) {
         this.label = labelParam;
     }
     /***
      * Refer to {@link MaskProperties#setLabelArgs}.
      *
      * @param args Refer to {@link MaskProperties#setLabelArgs}.
      */
     public final void setLabelArgs(final List args) {
         maskProperties.setLabelArgs(args);
     }
     /***
      * <p>
      * Localization key of a string which will appear to the right of the check
      * box.
      * </p>
      *
      * @param labelKey
      *            the new value of labelKey.
      */
     public void setLabelKey(final String labelKey) {
         maskProperties.setLabelKey(labelKey);
     }
     /***
      * <p>
      * Set whether or not the value this control must be entered.
      * </p>
      *
      * @param mandatory
      *            <code>true</code> if this field must be entered, otherwise
      *            <code>false</code> if the field is optional.
      */
     public void setMandatory(final boolean mandatory) {
         maskProperties.setMandatory(mandatory);
     }
     /***
      * <p>
      * Stores and maintains <strong>ivata op </strong> specific mask properties.
      * </p>
      *
      * @param maskPropertiesParam
      *            the new value of maskProperties.
      */
     public void setMaskProperties(final MaskProperties maskPropertiesParam) {
         this.maskProperties = maskPropertiesParam;
     }
     /***
      * <p>
      * Specifies whether or not the input values can be altered.
      * </p>
      *
      * @param readOnly
      *            <code>true</code> if the input of this field can be changed,
      *            otherwise <code>false</code> to only display the current
      *            value.
      */
     public void setReadOnly(final boolean readOnly) {
         maskProperties.setReadOnly(readOnly);
     }
     /***
      * Refer to {@link MaskProperties#setTitleArgs}.
      *
      * @param args Refer to {@link MaskProperties#setTitleArgs}.
      */
     public final void setTitleArgs(final List args) {
         maskProperties.setTitleArgs(args);
     }
     /***
      * <p>
      * Set the value of the key used to localize the title tag attribute.
      * </p>
      *
      * @param titleKey
      *            the new value of titleKey.
      */
     public final void setTitleKey(final String titleKey) {
         maskProperties.setTitleKey(titleKey);
     }
 }