/*
    * 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: LabelTag.java,v $
   * Revision 1.5  2005/04/11 15:41:55  colinmacleod
   * Added after text so you can use the label tag
   * for things like list headers too.
   *
   * 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.5  2004/12/31 19:32:36  colinmacleod
   * Cosmetic indentation improvements.
   *
   * 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 op.
   *
   * Revision 1.1.1.1  2004/01/27 20:59:39  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:24  colin
   * Restructured portal into subprojects
   *
   * Revision 1.2  2003/03/04 00:19:00  colin
   * added resourceFieldPath to label directly
   *
   * Revision 1.1  2003/03/03 16:57:12  colin
   * converted localization to automatic paths
   * added labels
   * added mandatory fieldName attribute
   * -----------------------------------------------------------------------------
   */
  package com.ivata.mask.web.tag.html;
  
  import org.apache.log4j.Logger;
  
  import java.io.IOException;
  import java.util.List;
  
  import javax.servlet.jsp.JspException;
  import javax.servlet.jsp.JspWriter;
  import org.apache.struts.taglib.html.BaseHandlerTag;
  import com.ivata.mask.util.StringHandling;
  import com.ivata.mask.web.format.HTMLFormatter;
  /***
  * <p>
  * Specifies a label for a field. This tag must be contained within a form tag,
  * and will take the <code>resourceFieldPath</code> and <code>bundle</code>
  * from there to locate the correct message for this field.
  * </p>
  *
  * @since ivata masks 0.4 (2003-03-01)
  * @author Colin MacLeod
  * <a href='mailto:colin.macleod@ivata.com'>colin.macleod@ivata.com</a>
  * @version $Revision: 1.5 $
  */
 public class LabelTag extends BaseHandlerTag {
     /***
      * Logger for this class.
      */
     private static final Logger logger = Logger.getLogger(LabelTag.class);
     /***
      * Text to appear after the label. You probably don't want this for a list.
      */
     private String afterText = ":";
     /***
      * <p>
      * Usually, the 'for' attribute is the same as the fieldName but, in the
      * case where mutliple fields have the same name, it is helpful to specify a
      * unique <code>styleId</code> for each one an hence a unique value for
      * the <code>for</code> attribute in the label.
      * </p>
      */
     private String forField = null;
     /***
      * <p>
      * Stores the label which is displayed.
      * </p>
      */
     private String label;
     /***
      * <p>
      * Stores and maintains <strong>ivata op </strong> specific mask properties.
      * </p>
      */
     private MaskProperties maskProperties = new MaskProperties();
     /***
      * <p>
      * Resource path of the field within the application resources. Resources
      * for fields are retrieved by appending the field name to this path. This
      * attribute is used when the label is not surrounded by a form tag.
      * </p>
      */
     private String resourceFieldPath = null;
     /***
      * <p>
      * Overridden to reset mask properties.
      * </p>
      *
      * @return <code>EVAL_PAGE</code> since we always want to evaluate the
      *         page after this tag.
      *
      * @throws JspException
      *             if there is an error in the mask properties.
      */
     public int doEndTag() throws JspException {
         int returnValue = super.doEndTag();
         maskProperties.reset(this);
         return returnValue;
     }
     /***
      * <p>
      * Overridden to call <code>MaskProperties</code> initialization.
      * </p>
      *
      * @return <code>SKIP_BODY</code> as this tag has no body.
      *
      * @throws JspException
      *             if there is a problem writing to the page.
      */
     public int doStartTag() throws JspException {
         maskProperties.doStartTag(this, pageContext);
         JspWriter out = pageContext.getOut();
         try {
             StringBuffer attributes = new StringBuffer();
             String fieldNameParam = maskProperties.getFieldName();
             if (StringHandling.isNullOrEmpty(forField)
                     && !StringHandling.isNullOrEmpty(fieldNameParam)) {
                 forField = fieldNameParam;
             }
             attributes.append(HTMLFormatter.getAttributeNotNull("class",
                     getStyleClass()));
             attributes.append(HTMLFormatter
                     .getAttributeNotNull("for", forField));
             attributes.append(HTMLFormatter.getAttributeNotNull("id",
                     fieldNameParam + "Label"));
             attributes.append(HTMLFormatter.getAttributeNotNull("onblur",
                     getOnblur()));
             attributes.append(HTMLFormatter.getAttributeNotNull("onclick",
                     getOnclick()));
             attributes.append(HTMLFormatter.getAttributeNotNull("ondblclick",
                     getOndblclick()));
             attributes.append(HTMLFormatter.getAttributeNotNull("onfocus",
                     getOnfocus()));
             attributes.append(HTMLFormatter.getAttributeNotNull("onkeydown",
                     getOnkeydown()));
             attributes.append(HTMLFormatter.getAttributeNotNull("onkeypress",
                     getOnkeypress()));
             attributes.append(HTMLFormatter.getAttributeNotNull("onmousedown",
                     getOnmousedown()));
             attributes.append(HTMLFormatter.getAttributeNotNull("onmousemove",
                     getOnmousemove()));
             attributes.append(HTMLFormatter.getAttributeNotNull("onmouseout",
                     getOnmouseout()));
             attributes.append(HTMLFormatter.getAttributeNotNull("onmouseover",
                     getOnmouseover()));
             attributes.append(HTMLFormatter.getAttributeNotNull("onmouseup",
                     getOnmouseup()));
             attributes.append(HTMLFormatter.getAttributeNotNull("style",
                     getStyle()));
             attributes.append(HTMLFormatter.getAttributeNotNull("title",
                     maskProperties.getTitle()));
             if (!StringHandling.isNullOrEmpty(forField)) {
                 out.print("<label ");
                 out.print(attributes.toString());
                 out.print(">");
             }
             out.print(label);
             out.print(afterText);
             if (!StringHandling.isNullOrEmpty(forField)) {
                 out.print("</label>");
             }
         } catch (IOException e) {
             throw new JspException(e);
         }
         return SKIP_BODY;
     }
     /***
      * Text to appear after the label. You probably don't want this for a list.
      * @return Returns the after text.
      */
     public String getAfterText() {
         return afterText;
     }
     public final List getArgs() {
         return maskProperties.getLabelArgs();
     }
     /***
      * <p>
      * Calls {@link MaskProperties#getBundleMaskProperites.getBundle}.
      * </p>
      *
      * @return the current value of bundle.
      */
     public final String getBundle() {
         return maskProperties.getBundle();
     }
     /***
      * If you are using the label to display the correct label to show for a
      * given class (rather than a field), this returns the name of that class.
      *
      * @return Returns the class name.
      */
     public String getClassName() {
         return maskProperties.getClassName();
     }
     /***
      * <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 the current value of fieldName.
      */
     public String getFieldName() {
         return maskProperties.getFieldName();
     }
     /***
      * <p>
      * Usually, the 'for' attribute is the same as the fieldName but, in the
      * case where mutliple fields have the same name, it is helpful to specify a
      * unique <code>styleId</code> for each one an hence a unique value for
      * the <code>for</code> attribute in the label.
      * </p>
      *
      * @return the current value of forField.
      */
     public String getForField() {
         return forField;
     }
     /***
      * <p>
      * Some fields have multiple label keys, depending on circumstances. This
      * suffix is appended to the key when retrieving the localized text from the
      * application resources file.
      * </p>
      *
      * @return the current value of keySuffix.
      */
     public String getKeySuffix() {
         return maskProperties.getLabelKeySuffix();
     }
     /***
      * Get the current text value of the label.
      *
      * @return Returns the label.
      */
     public String getLabel() {
         return label;
     }
     /***
      * <p>
      * Stores and maintains <strong>ivata op </strong> specific mask properties.
      * </p>
      *
      * @return the current value of maskProperties.
      */
     public MaskProperties getMaskProperties() {
         return maskProperties;
     }
     /***
      * <p>
      * Resource path of the field within the application resources. Resources
      * for fields are retrieved by appending the field name to this path. This
      * attribute is used when the label is not surrounded by a form tag.
      * </p>
      *
      * @return the current value of resourceFieldPath.
      */
     public String getResourceFieldPath() {
         return resourceFieldPath;
     }
     public final List getTitleArgs() {
         return maskProperties.getTitleArgs();
     }
     /***
      * Refer to {@link #getAfterText}.
      * @param afterTextParam Refer to {@link #getAfterText}.
      */
     public void setAfterText(String afterTextParam) {
         if (logger.isDebugEnabled()) {
             logger.debug("Setting afterText. Before '" + afterText
                     + "', after '" + afterTextParam + "'");
         }
         afterText = afterTextParam;
     }
     /***
      * Refer to {@link MaskProperties#setLabelArgs}.
      *
      * @param args Refer to {@link MaskProperties#setLabelArgs}.
      */
     public final void setArgs(final List args) {
         maskProperties.setLabelArgs(args);
     }
     /***
      * Refer to {@link MaskProperties#setBundle}.
      *
      * @param bundleParam Refer to {@link MaskProperties#setBundle}.
      */
     public void setBundle(final String bundleParam) {
         maskProperties.setBundle(bundleParam);
     }
     /***
      * Refer to {@link #getClassName}.
      * @param classNameParam Refer to {@link #getClassName}.
      */
     public void setClassName(String classNameParam) {
         if (logger.isDebugEnabled()) {
             logger.debug("Setting className. Before '" + getClassName()
                     + "', after '" + classNameParam + "'");
         }
         maskProperties.setClassName(classNameParam);
     }
     /***
      * <p>
      * >Name of the field to which this tag refers. This is used in conjunction
      * with the <code>resourceFieldPath</code> to retrieve the correct message
      * resources path.
      * </p>
      *
      * @param fieldNameParam
      *            the new value of fieldName.
      */
     public void setFieldName(final String fieldNameParam) {
         maskProperties.setFieldName(fieldNameParam);
     }
     /***
      * <p>
      * Usually, the 'for' attribute is the same as the fieldName but, in the
      * case where multiple fields have the same name, it is helpful to specify a
      * unique <code>styleId</code> for each one an hence a unique value for
      * the <code>for</code> attribute in the label.
      * </p>
      *
      * @param forFieldParam
      *            the new value of forField.
      */
     public void setForField(final String forFieldParam) {
         this.forField = forFieldParam;
     }
     /***
      * <p>
      * Some fields have multiple label keys, depending on circumstances. This
      * suffix is appended to the key when retrieving the localized text from the
      * applicaiton resources file.
      * </p>
      *
      * @param keySuffix
      *            the new value of keySuffix.
      */
     public void setKeySuffix(final String keySuffix) {
         maskProperties.setLabelKeySuffix(keySuffix);
     }
     /***
      * <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;
     }
     /***
      * <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>
      * Resource path of the field within the application resources. Resources
      * for fields are retrieved by appending the field name to this path. This
      * attribute is used when the label is not surrounded by a form tag.
      * </p>
      *
      * @param resourceFieldPathParam
      *            the new value of resourceFieldPath.
      */
     public void setResourceFieldPath(final String resourceFieldPathParam) {
         this.resourceFieldPath = resourceFieldPathParam;
     }
     /***
      * 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);
     }
 }