/*
    * 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: TextTag.java,v $
   * Revision 1.3  2005/04/11 15:31:13  colinmacleod
   * Removed extra gt sign from getFieldName comment.
   *
   * Revision 1.2  2005/04/09 18:04:20  colinmacleod
   * Changed copyright text to GPL v2 explicitly.
   *
   * Revision 1.1  2005/01/06 23:10:07  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 groupware.
   *
   * Revision 1.4  2004/11/03 16:12:09  colinmacleod
   * Changed fieldPath to resourceFieldPath.
   *
   * Revision 1.3  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.2  2004/03/21 21:16:35  colinmacleod
   * Shortened name to ivata groupware.
   *
   * Revision 1.1.1.1  2004/01/27 20:59:40  colinmacleod
   * Moved ivata groupware 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:27  colin
   * Restructured portal into subprojects
   *
   * Revision 1.2  2003/03/03 16:57:12  colin
   * converted localization to automatic paths
   * added labels
   * added mandatory fieldName attribute
   *
   * Revision 1.1  2003/02/24 19:33:33  colin
   * Moved to new subproject.
   *
   * Revision 1.5  2003/02/13 08:51:32  colin
   * moved initialization from doStartTag to MaskProperties.doStartTag
   *
   * Revision 1.4  2003/02/04 17:43:51  colin
   * copyright notice
   *
   * Revision 1.3  2003/01/30 07:52:44  colin
   * bugfixes in mandatory handling
   *
   * Revision 1.2  2003/01/27 08:26:21  colin
   * SSLEXT & i18n changes
   *
   * Revision 1.1  2003/01/18 20:32:08  colin
   * added html struts override tags and help
   * -----------------------------------------------------------------------------
   */
  package com.ivata.mask.web.tag.html;
  import java.io.IOException;
  import javax.servlet.jsp.JspException;
  import javax.servlet.jsp.JspWriter;
  import com.ivata.mask.util.StringHandling;
  import com.ivata.mask.web.format.HTMLFormatter;
  /***
   * <p>
   * Overrides an HTML <code>&lt;input type=text&gt;</code> tag, by overriding
  * the 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>formatter</td>
  * <td>false</td>
  * <td><code>boolean</code></td>
  * <td>Specifies a formatter to format the text if it is read-only.</td>
  * </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.TextTag Stuts} are also included.
  * </p>
  *
  * @since ivata masks 0.4 (2003-01-15)
  * @author Colin MacLeod
  * <a href='mailto:colin.macleod@ivata.com'>colin.macleod@ivata.com</a>
  * @version $Revision: 1.3 $
  */
 public class TextTag extends org.apache.struts.taglib.html.TextTag {
     /***
      * <p>
      * Stores and maintains <strong>ivata groupware</strong> specific mask properties.
      * </p>
      */
     private MaskProperties maskProperties = new MaskProperties();
     /***
      * <p>
      * Formatter used to format read-only text.
      * </p>
      */
     private HTMLFormatter formatter = new HTMLFormatter();
     /***
      * <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);
     }
     /***
      * <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>
      * Overridden to provide mandatory/readony fuctionality.
      * </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 (maskProperties.getReadOnly()) {
             return SKIP_BODY;
         } else {
             // if it is not read-only, use the standard struts implementation
             return super.doStartTag();
         }
     }
     /***
      * <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 {
         // if it is read only, just put out the current text contents, formatted
         if (maskProperties.getReadOnly()) {
             try {
                 JspWriter out = pageContext.getOut();
                 out.print(formatter.format(StringHandling.getNotNull(
                         getValue(), "")));
                 maskProperties.reset(this);
                 return EVAL_PAGE;
             } catch (IOException e) {
                 throw new JspException(e);
             }
         }
         // if it is not read-only, use the standard struts implementation
         int returnValue = super.doEndTag();
         maskProperties.reset(this);
         return super.doEndTag();
     }
     /***
      * <p>
      * Set a formatter to use if the tag is read-only.
      * </p>
      *
      * @param formatterParam
      *            new value of formatter.
      */
     public void setFormatter(final HTMLFormatter formatterParam) {
         this.formatter = formatterParam;
     }
     /***
      * <p>
      * Stores and maintains <strong>ivata groupware</strong> specific mask
      * properties.
      * </p>
      *
      * @return the current value of maskProperties.
      */
     public MaskProperties getMaskProperties() {
         return maskProperties;
     }
     /***
      * <p>
      * Stores and maintains <strong>ivata groupware</strong> specific mask
      * properties.
      * </p>
      *
      * @param maskPropertiesParam
      *            the new value of maskProperties.
      */
     public void setMaskProperties(final MaskProperties maskPropertiesParam) {
         this.maskProperties = maskPropertiesParam;
     }
     /***
      * <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>
      *
      * @return value of fieldName.
      */
     public String getFieldName() {
         return maskProperties.getFieldName();
     }
     /***
      * <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);
     }
 }