Class AbstractHtmlElementTag

java.lang.Object

jakarta.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:

jakarta.servlet.jsp.tagext.DynamicAttributes, jakarta.servlet.jsp.tagext.IterationTag, jakarta.servlet.jsp.tagext.JspTag, jakarta.servlet.jsp.tagext.Tag, jakarta.servlet.jsp.tagext.TryCatchFinally, Serializable, EditorAwareTag

Direct Known Subclasses:

AbstractHtmlElementBodyTag, AbstractHtmlInputElementTag, ButtonTag, FormTag, HiddenInputTag, LabelTag, OptionsTag

public abstract class AbstractHtmlElementTag
extends AbstractDataBoundFormElementTag
implements jakarta.servlet.jsp.tagext.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	Description
static final String	CLASS_ATTRIBUTE
static final String	DIR_ATTRIBUTE
static final String	LANG_ATTRIBUTE
static final String	ONCLICK_ATTRIBUTE
static final String	ONDBLCLICK_ATTRIBUTE
static final String	ONKEYDOWN_ATTRIBUTE
static final String	ONKEYPRESS_ATTRIBUTE
static final String	ONKEYUP_ATTRIBUTE
static final String	ONMOUSEDOWN_ATTRIBUTE
static final String	ONMOUSEMOVE_ATTRIBUTE
static final String	ONMOUSEOUT_ATTRIBUTE
static final String	ONMOUSEOVER_ATTRIBUTE
static final String	ONMOUSEUP_ATTRIBUTE
static final String	STYLE_ATTRIBUTE
static final String	TABINDEX_ATTRIBUTE
static final String	TITLE_ATTRIBUTE

Fields inherited from class AbstractDataBoundFormElementTag

NESTED_PATH_VARIABLE_NAME

Fields inherited from class RequestContextAwareTag

logger, REQUEST_CONTEXT_PAGE_ATTRIBUTE

Fields inherited from class jakarta.servlet.jsp.tagext.TagSupport

pageContext

Fields inherited from interface jakarta.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface jakarta.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors

Constructor	Description
AbstractHtmlElementTag()

Method Summary

Modifier and Type	Method	Description
protected @Nullable String	getCssClass()	Get the value of the 'class' attribute.
protected @Nullable String	getCssErrorClass()	The CSS class to use when the field bound to a particular tag has errors.
protected @Nullable String	getCssStyle()	Get the value of the 'style' attribute.
protected @Nullable String	getDir()	Get the value of the 'dir' attribute.
protected @Nullable Map<String,Object>	getDynamicAttributes()	Get the map of dynamic attributes.
protected @Nullable String	getLang()	Get the value of the 'lang' attribute.
protected @Nullable String	getOnclick()	Get the value of the 'onclick' attribute.
protected @Nullable String	getOndblclick()	Get the value of the 'ondblclick' attribute.
protected @Nullable String	getOnkeydown()	Get the value of the 'onkeydown' attribute.
protected @Nullable String	getOnkeypress()	Get the value of the 'onkeypress' attribute.
protected @Nullable String	getOnkeyup()	Get the value of the 'onkeyup' attribute.
protected @Nullable String	getOnmousedown()	Get the value of the 'onmousedown' attribute.
protected @Nullable String	getOnmousemove()	Get the value of the 'onmousemove' attribute.
protected @Nullable String	getOnmouseout()	Get the value of the 'onmouseout' attribute.
protected @Nullable String	getOnmouseover()	Get the value of the 'onmouseover' attribute.
protected @Nullable String	getOnmouseup()	Get the value of the 'onmouseup' attribute.
protected @Nullable String	getTabindex()	Get the value of the 'tabindex' attribute.
protected @Nullable 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 AbstractDataBoundFormElementTag

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

Methods inherited from class AbstractFormTag

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

Methods inherited from class HtmlEscapingAwareTag

htmlEscape, isHtmlEscape, isResponseEncodedHtmlEscape, setHtmlEscape

Methods inherited from class RequestContextAwareTag

doCatch, doStartTag, getRequestContext

Methods inherited from class jakarta.servlet.jsp.tagext.TagSupport

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

Methods inherited from class Object

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

Field Details

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 Details

AbstractHtmlElementTag

public AbstractHtmlElementTag()

Method Details

setCssClass

public void setCssClass(String cssClass)

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

getCssClass

protected @Nullable 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 @Nullable 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 @Nullable 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 @Nullable 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 @Nullable 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 @Nullable 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 @Nullable 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 @Nullable 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 @Nullable 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 @Nullable 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 @Nullable 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 @Nullable 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 @Nullable 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 @Nullable 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 @Nullable 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 @Nullable 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 @Nullable String getOnkeydown()

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

getDynamicAttributes

protected @Nullable Map<String,Object> getDynamicAttributes()

Get the map of dynamic attributes.

setDynamicAttribute

public void setDynamicAttribute(String uri,
 String localName,
 Object value)
                         throws jakarta.servlet.jsp.JspException

Specified by:

setDynamicAttribute in interface jakarta.servlet.jsp.tagext.DynamicAttributes

Throws:

jakarta.servlet.jsp.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 jakarta.servlet.jsp.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:

jakarta.servlet.jsp.JspException

writeOptionalAttributes

protected void writeOptionalAttributes(TagWriter tagWriter)
                                throws jakarta.servlet.jsp.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:

jakarta.servlet.jsp.JspException

resolveCssClass

protected String resolveCssClass()
                          throws jakarta.servlet.jsp.JspException

Gets the appropriate CSS class to use based on the state of the current BindStatus object.

Throws:

jakarta.servlet.jsp.JspException