AbstractHtmlElementTag (Spring Framework 3.2.1.RELEASE API)
Date: 2013-01-24

org.springframework.web.servlet.tags.form

## Class AbstractHtmlElementTag

- java.lang.Object
- - javax.servlet.jsp.tagext.TagSupport
  - - org.springframework.web.servlet.tags.RequestContextAwareTag
    - - org.springframework.web.servlet.tags.HtmlEscapingAwareTag
      - - org.springframework.web.servlet.tags.form.AbstractFormTag
        - - org.springframework.web.servlet.tags.form.AbstractDataBoundFormElementTag
          - - org.springframework.web.servlet.tags.form.AbstractHtmlElementTag

- All Implemented Interfaces:
    Serializable, DynamicAttributes, IterationTag, JspTag, Tag, TryCatchFinally, EditorAwareTag
  Direct Known Subclasses:
    AbstractHtmlElementBodyTag, AbstractHtmlInputElementTag, ButtonTag, FormTag, HiddenInputTag, LabelTag, OptionsTag

      public abstract class AbstractHtmlElementTag
      extends AbstractDataBoundFormElementTag
      implements DynamicAttributes

  Base class for databinding-aware JSP tags that render HTML element. Provides a set of properties corresponding to the set of HTML attributes that are common across elements.

  Additionally, this base class allows for rendering non-standard attributes as part of the tag's output. These attributes are accessible to subclasses if needed via the `dynamicAttributes` map.

  Since:
    2.0
  Author:
    Rob Harrop, Jeremy Grelle, Rossen Stoyanchev
  See Also:
    Serialized Form

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static String` | `CLASS_ATTRIBUTE`
    `static String` | `DIR_ATTRIBUTE`
    `static String` | `LANG_ATTRIBUTE`
    `static String` | `ONCLICK_ATTRIBUTE`
    `static String` | `ONDBLCLICK_ATTRIBUTE`
    `static String` | `ONKEYDOWN_ATTRIBUTE`
    `static String` | `ONKEYPRESS_ATTRIBUTE`
    `static String` | `ONKEYUP_ATTRIBUTE`
    `static String` | `ONMOUSEDOWN_ATTRIBUTE`
    `static String` | `ONMOUSEMOVE_ATTRIBUTE`
    `static String` | `ONMOUSEOUT_ATTRIBUTE`
    `static String` | `ONMOUSEOVER_ATTRIBUTE`
    `static String` | `ONMOUSEUP_ATTRIBUTE`
    `static String` | `STYLE_ATTRIBUTE`
    `static String` | `TABINDEX_ATTRIBUTE`
    `static String` | `TITLE_ATTRIBUTE`

    - ### Fields inherited from class org.springframework.web.servlet.tags.form.AbstractDataBoundFormElementTag

      `COMMAND_NAME_VARIABLE_NAME, NESTED_PATH_VARIABLE_NAME`

    - ### Fields inherited from class org.springframework.web.servlet.tags.RequestContextAwareTag

      `logger, REQUEST_CONTEXT_PAGE_ATTRIBUTE`

    - ### Fields inherited from class javax.servlet.jsp.tagext.TagSupport

      `pageContext`

    - ### Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

      `EVAL_BODY_AGAIN`

    - ### Fields inherited from interface javax.servlet.jsp.tagext.Tag

      `EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `AbstractHtmlElementTag()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected String` | `getCssClass()` Get the value of the '`class`' attribute.
    `protected String` | `getCssErrorClass()` The CSS class to use when the field bound to a particular tag has errors.
    `protected String` | `getCssStyle()` Get the value of the '`style`' attribute.
    `protected String` | `getDir()` Get the value of the '`dir`' attribute.
    `protected Map<String,Object>` | `getDynamicAttributes()` Get the map of dynamic attributes.
    `protected String` | `getLang()` Get the value of the '`lang`' attribute.
    `protected String` | `getOnclick()` Get the value of the '`onclick`' attribute.
    `protected String` | `getOndblclick()` Get the value of the '`ondblclick`' attribute.
    `protected String` | `getOnkeydown()` Get the value of the '`onkeydown`' attribute.
    `protected String` | `getOnkeypress()` Get the value of the '`onkeypress`' attribute.
    `protected String` | `getOnkeyup()` Get the value of the '`onkeyup`' attribute.
    `protected String` | `getOnmousedown()` Get the value of the '`onmousedown`' attribute.
    `protected String` | `getOnmousemove()` Get the value of the '`onmousemove`' attribute.
    `protected String` | `getOnmouseout()` Get the value of the '`onmouseout`' attribute.
    `protected String` | `getOnmouseover()` Get the value of the '`onmouseover`' attribute.
    `protected String` | `getOnmouseup()` Get the value of the '`onmouseup`' attribute.
    `protected String` | `getTabindex()` Get the value of the '`tabindex`' attribute.
    `protected String` | `getTitle()` Get the value of the '`title`' attribute.
    `protected boolean` | `isValidDynamicAttribute(String localName, Object value)` Whether the given name-value pair is a valid dynamic attribute.
    `protected String` | `resolveCssClass()` Gets the appropriate CSS class to use based on the state of the current `BindStatus` object.
    `void` | `setCssClass(String cssClass)` Set the value of the '`class`' attribute.
    `void` | `setCssErrorClass(String cssErrorClass)` The CSS class to use when the field bound to a particular tag has errors.
    `void` | `setCssStyle(String cssStyle)` Set the value of the '`style`' attribute.
    `void` | `setDir(String dir)` Set the value of the '`dir`' attribute.
    `void` | `setDynamicAttribute(String uri, String localName, Object value)`
    `void` | `setLang(String lang)` Set the value of the '`lang`' attribute.
    `void` | `setOnclick(String onclick)` Set the value of the '`onclick`' attribute.
    `void` | `setOndblclick(String ondblclick)` Set the value of the '`ondblclick`' attribute.
    `void` | `setOnkeydown(String onkeydown)` Set the value of the '`onkeydown`' attribute.
    `void` | `setOnkeypress(String onkeypress)` Set the value of the '`onkeypress`' attribute.
    `void` | `setOnkeyup(String onkeyup)` Set the value of the '`onkeyup`' attribute.
    `void` | `setOnmousedown(String onmousedown)` Set the value of the '`onmousedown`' attribute.
    `void` | `setOnmousemove(String onmousemove)` Set the value of the '`onmousemove`' attribute.
    `void` | `setOnmouseout(String onmouseout)` Set the value of the '`onmouseout`' attribute.
    `void` | `setOnmouseover(String onmouseover)` Set the value of the '`onmouseover`' attribute.
    `void` | `setOnmouseup(String onmouseup)` Set the value of the '`onmouseup`' attribute.
    `void` | `setTabindex(String tabindex)` Set the value of the '`tabindex`' attribute.
    `void` | `setTitle(String title)` Set the value of the '`title`' attribute.
    `protected void` | `writeDefaultAttributes(TagWriter tagWriter)` Writes the default attributes configured via this base class to the supplied `TagWriter`.
    `protected void` | `writeOptionalAttributes(TagWriter tagWriter)` Writes the optional attributes configured via this base class to the supplied `TagWriter`.

    - ### Methods inherited from class org.springframework.web.servlet.tags.form.AbstractDataBoundFormElementTag

      `autogenerateId, convertToDisplayString, doFinally, getBindStatus, getBoundValue, getEditor, getId, getName, getNestedPath, getPath, getPropertyEditor, getPropertyPath, processFieldValue, resolveId, setId, setPath`

    - ### Methods inherited from class org.springframework.web.servlet.tags.form.AbstractFormTag

      `createTagWriter, doStartTagInternal, evaluate, evaluateBoolean, getDisplayString, getDisplayString, isDefaultHtmlEscape, writeOptionalAttribute, writeTagContent`

    - ### Methods inherited from class org.springframework.web.servlet.tags.HtmlEscapingAwareTag

      `isHtmlEscape, setHtmlEscape`

    - ### Methods inherited from class org.springframework.web.servlet.tags.RequestContextAwareTag

      `doCatch, doStartTag, getRequestContext`

    - ### Methods inherited from class javax.servlet.jsp.tagext.TagSupport

      `doAfterBody, doEndTag, findAncestorWithClass, getParent, getValue, getValues, release, removeValue, setPageContext, setParent, setValue`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Field Detail

    - #### CLASS_ATTRIBUTE

          public static final String CLASS_ATTRIBUTE

      See Also:
        Constant Field Values

    - #### STYLE_ATTRIBUTE

          public static final String STYLE_ATTRIBUTE

      See Also:
        Constant Field Values

    - #### LANG_ATTRIBUTE

          public static final String LANG_ATTRIBUTE

      See Also:
        Constant Field Values

    - #### TITLE_ATTRIBUTE

          public static final String TITLE_ATTRIBUTE

      See Also:
        Constant Field Values

    - #### DIR_ATTRIBUTE

          public static final String DIR_ATTRIBUTE

      See Also:
        Constant Field Values

    - #### TABINDEX_ATTRIBUTE

          public static final String TABINDEX_ATTRIBUTE

      See Also:
        Constant Field Values

    - #### ONCLICK_ATTRIBUTE

          public static final String ONCLICK_ATTRIBUTE

      See Also:
        Constant Field Values

    - #### ONDBLCLICK_ATTRIBUTE

          public static final String ONDBLCLICK_ATTRIBUTE

      See Also:
        Constant Field Values

    - #### ONMOUSEDOWN_ATTRIBUTE

          public static final String ONMOUSEDOWN_ATTRIBUTE

      See Also:
        Constant Field Values

    - #### ONMOUSEUP_ATTRIBUTE

          public static final String ONMOUSEUP_ATTRIBUTE

      See Also:
        Constant Field Values

    - #### ONMOUSEOVER_ATTRIBUTE

          public static final String ONMOUSEOVER_ATTRIBUTE

      See Also:
        Constant Field Values

    - #### ONMOUSEMOVE_ATTRIBUTE

          public static final String ONMOUSEMOVE_ATTRIBUTE

      See Also:
        Constant Field Values

    - #### ONMOUSEOUT_ATTRIBUTE

          public static final String ONMOUSEOUT_ATTRIBUTE

      See Also:
        Constant Field Values

    - #### ONKEYPRESS_ATTRIBUTE

          public static final String ONKEYPRESS_ATTRIBUTE

      See Also:
        Constant Field Values

    - #### ONKEYUP_ATTRIBUTE

          public static final String ONKEYUP_ATTRIBUTE

      See Also:
        Constant Field Values

    - #### ONKEYDOWN_ATTRIBUTE

          public static final String ONKEYDOWN_ATTRIBUTE

      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### AbstractHtmlElementTag

          public AbstractHtmlElementTag()

  - ### Method Detail

    - #### setCssClass

          public void setCssClass(String cssClass)

      Set the value of the '`class`' attribute. May be a runtime expression.

    - #### getCssClass

          protected String getCssClass()

      Get the value of the '`class`' attribute. May be a runtime expression.

    - #### setCssErrorClass

          public void setCssErrorClass(String cssErrorClass)

      The CSS class to use when the field bound to a particular tag has errors. May be a runtime expression.

    - #### getCssErrorClass

          protected String getCssErrorClass()

      The CSS class to use when the field bound to a particular tag has errors. May be a runtime expression.

    - #### setCssStyle

          public void setCssStyle(String cssStyle)

      Set the value of the '`style`' attribute. May be a runtime expression.

    - #### getCssStyle

          protected String getCssStyle()

      Get the value of the '`style`' attribute. May be a runtime expression.

    - #### setLang

          public void setLang(String lang)

      Set the value of the '`lang`' attribute. May be a runtime expression.

    - #### getLang

          protected String getLang()

      Get the value of the '`lang`' attribute. May be a runtime expression.

    - #### setTitle

          public void setTitle(String title)

      Set the value of the '`title`' attribute. May be a runtime expression.

    - #### getTitle

          protected String getTitle()

      Get the value of the '`title`' attribute. May be a runtime expression.

    - #### setDir

          public void setDir(String dir)

      Set the value of the '`dir`' attribute. May be a runtime expression.

    - #### getDir

          protected String getDir()

      Get the value of the '`dir`' attribute. May be a runtime expression.

    - #### setTabindex

          public void setTabindex(String tabindex)

      Set the value of the '`tabindex`' attribute. May be a runtime expression.

    - #### getTabindex

          protected String getTabindex()

      Get the value of the '`tabindex`' attribute. May be a runtime expression.

    - #### setOnclick

          public void setOnclick(String onclick)

      Set the value of the '`onclick`' attribute. May be a runtime expression.

    - #### getOnclick

          protected String getOnclick()

      Get the value of the '`onclick`' attribute. May be a runtime expression.

    - #### setOndblclick

          public void setOndblclick(String ondblclick)

      Set the value of the '`ondblclick`' attribute. May be a runtime expression.

    - #### getOndblclick

          protected String getOndblclick()

      Get the value of the '`ondblclick`' attribute. May be a runtime expression.

    - #### setOnmousedown

          public void setOnmousedown(String onmousedown)

      Set the value of the '`onmousedown`' attribute. May be a runtime expression.

    - #### getOnmousedown

          protected String getOnmousedown()

      Get the value of the '`onmousedown`' attribute. May be a runtime expression.

    - #### setOnmouseup

          public void setOnmouseup(String onmouseup)

      Set the value of the '`onmouseup`' attribute. May be a runtime expression.

    - #### getOnmouseup

          protected String getOnmouseup()

      Get the value of the '`onmouseup`' attribute. May be a runtime expression.

    - #### setOnmouseover

          public void setOnmouseover(String onmouseover)

      Set the value of the '`onmouseover`' attribute. May be a runtime expression.

    - #### getOnmouseover

          protected String getOnmouseover()

      Get the value of the '`onmouseover`' attribute. May be a runtime expression.

    - #### setOnmousemove

          public void setOnmousemove(String onmousemove)

      Set the value of the '`onmousemove`' attribute. May be a runtime expression.

    - #### getOnmousemove

          protected String getOnmousemove()

      Get the value of the '`onmousemove`' attribute. May be a runtime expression.

    - #### setOnmouseout

          public void setOnmouseout(String onmouseout)

      Set the value of the '`onmouseout`' attribute. May be a runtime expression.

    - #### getOnmouseout

          protected String getOnmouseout()

      Get the value of the '`onmouseout`' attribute. May be a runtime expression.

    - #### setOnkeypress

          public void setOnkeypress(String onkeypress)

      Set the value of the '`onkeypress`' attribute. May be a runtime expression.

    - #### getOnkeypress

          protected String getOnkeypress()

      Get the value of the '`onkeypress`' attribute. May be a runtime expression.

    - #### setOnkeyup

          public void setOnkeyup(String onkeyup)

      Set the value of the '`onkeyup`' attribute. May be a runtime expression.

    - #### getOnkeyup

          protected String getOnkeyup()

      Get the value of the '`onkeyup`' attribute. May be a runtime expression.

    - #### setOnkeydown

          public void setOnkeydown(String onkeydown)

      Set the value of the '`onkeydown`' attribute. May be a runtime expression.

    - #### getOnkeydown

          protected String getOnkeydown()

      Get the value of the '`onkeydown`' attribute. May be a runtime expression.

    - #### getDynamicAttributes

          protected Map<String,Object> getDynamicAttributes()

      Get the map of dynamic attributes.

    - #### setDynamicAttribute

          public void setDynamicAttribute(String uri,
                                 String localName,
                                 Object value)
                                   throws JspException

      Specified by:
        `setDynamicAttribute` in interface `DynamicAttributes`
      Throws:
        `JspException`

    - #### isValidDynamicAttribute

          protected boolean isValidDynamicAttribute(String localName,
                                        Object value)

      Whether the given name-value pair is a valid dynamic attribute.

    - #### writeDefaultAttributes

          protected void writeDefaultAttributes(TagWriter tagWriter)
                                         throws JspException

      Writes the default attributes configured via this base class to the supplied `TagWriter`. Subclasses should call this when they want the base attribute set to be written to the output.
      Overrides:
        `writeDefaultAttributes` in class `AbstractDataBoundFormElementTag`
      Parameters:
        `tagWriter` - the `TagWriter` to which any attributes are to be written
      Throws:
        `JspException`

    - #### writeOptionalAttributes

          protected void writeOptionalAttributes(TagWriter tagWriter)
                                          throws JspException

      Writes the optional attributes configured via this base class to the supplied `TagWriter`. The set of optional attributes that will be rendered includes any non-standard dynamic attributes. Called by `writeDefaultAttributes(TagWriter)`.
      Throws:
        `JspException`

    - #### resolveCssClass

          protected String resolveCssClass()
                                    throws JspException

      Gets the appropriate CSS class to use based on the state of the current `BindStatus` object.
      Throws:
        `JspException`