Class ErrorsTag
- All Implemented Interfaces:
BodyTag
,DynamicAttributes
,IterationTag
,JspTag
,Tag
,TryCatchFinally
,Serializable
,EditorAwareTag
<errors>
tag renders field errors in an HTML 'span' tag.
Displays errors for either an object or a particular field.
This tag supports three main usage patterns:
- Field only - set '
path
' to the field name (or path) - Object errors only - omit '
path
' - All errors - set '
path
' to '*
'
Attribute Summary
Attribute | Required? | Runtime Expression? | Description |
---|---|---|---|
cssClass |
false |
true |
HTML Optional Attribute |
cssStyle |
false |
true |
HTML Optional Attribute |
delimiter |
false |
true |
Delimiter for displaying multiple error messages. Defaults to the br tag. |
dir |
false |
true |
HTML Standard Attribute |
element |
false |
true |
Specifies the HTML element that is used to render the enclosing errors. |
htmlEscape |
false |
true |
Enable/disable HTML escaping of rendered values. |
id |
false |
true |
HTML Standard Attribute |
lang |
false |
true |
HTML Standard Attribute |
onclick |
false |
true |
HTML Event Attribute |
ondblclick |
false |
true |
HTML Event Attribute |
onkeydown |
false |
true |
HTML Event Attribute |
onkeypress |
false |
true |
HTML Event Attribute |
onkeyup |
false |
true |
HTML Event Attribute |
onmousedown |
false |
true |
HTML Event Attribute |
onmousemove |
false |
true |
HTML Event Attribute |
onmouseout |
false |
true |
HTML Event Attribute |
onmouseover |
false |
true |
HTML Event Attribute |
onmouseup |
false |
true |
HTML Event Attribute |
path |
false |
true |
Path to errors object for data binding |
tabindex |
false |
true |
HTML Standard Attribute |
title |
false |
true |
HTML Standard Attribute |
- Since:
- 2.0
- Author:
- Rob Harrop, Juergen Hoeller, Rick Evans
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The key under which this tag exposes error messages in thepage context scope
.static final String
The HTML 'span
' tag.Fields inherited from class org.springframework.web.servlet.tags.form.AbstractHtmlElementTag
CLASS_ATTRIBUTE, DIR_ATTRIBUTE, LANG_ATTRIBUTE, ONCLICK_ATTRIBUTE, ONDBLCLICK_ATTRIBUTE, ONKEYDOWN_ATTRIBUTE, ONKEYPRESS_ATTRIBUTE, ONKEYUP_ATTRIBUTE, ONMOUSEDOWN_ATTRIBUTE, ONMOUSEMOVE_ATTRIBUTE, ONMOUSEOUT_ATTRIBUTE, ONMOUSEOVER_ATTRIBUTE, ONMOUSEUP_ATTRIBUTE, STYLE_ATTRIBUTE, TABINDEX_ATTRIBUTE, TITLE_ATTRIBUTE
Fields inherited from class org.springframework.web.servlet.tags.form.AbstractDataBoundFormElementTag
NESTED_PATH_VARIABLE_NAME
Fields inherited from class org.springframework.web.servlet.tags.RequestContextAwareTag
logger, REQUEST_CONTEXT_PAGE_ATTRIBUTE
Fields inherited from class jakarta.servlet.jsp.tagext.TagSupport
pageContext
Fields inherited from interface jakarta.servlet.jsp.tagext.BodyTag
EVAL_BODY_BUFFERED, EVAL_BODY_TAG
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
-
Method Summary
Modifier and TypeMethodDescriptionprotected String
Get the value for the HTML 'id
' attribute.protected void
Exposes any bind status error messages underthis key
in thePageContext.PAGE_SCOPE
.Return the delimiter to be used between error messages.Get the HTML element must be used to render the error messages.protected String
getName()
Get the value for the HTML 'name
' attribute.protected void
Removes any bind status error messages that were previously stored underthis key
in thePageContext.PAGE_SCOPE
.protected void
renderDefaultContent
(TagWriter tagWriter) void
setDelimiter
(String delimiter) Set the delimiter to be used between error messages.void
setElement
(String element) Set the HTML element must be used to render the error messages.protected boolean
Should rendering of this tag proceed at all?Methods inherited from class org.springframework.web.servlet.tags.form.AbstractHtmlElementBodyTag
doEndTag, doFinally, doInitBody, flushBufferedBodyContent, onWriteTagContent, renderFromBodyContent, setBodyContent, writeTagContent
Methods inherited from class org.springframework.web.servlet.tags.form.AbstractHtmlElementTag
getCssClass, getCssErrorClass, getCssStyle, getDir, getDynamicAttributes, getLang, getOnclick, getOndblclick, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getTabindex, getTitle, isValidDynamicAttribute, resolveCssClass, setCssClass, setCssErrorClass, setCssStyle, setDir, setDynamicAttribute, setLang, setOnclick, setOndblclick, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setTabindex, setTitle, writeDefaultAttributes, writeOptionalAttributes
Methods inherited from class org.springframework.web.servlet.tags.form.AbstractDataBoundFormElementTag
convertToDisplayString, getBindStatus, getBoundValue, getEditor, getId, getNestedPath, getPath, getPropertyEditor, getPropertyPath, processFieldValue, resolveId, setId, setPath
Methods inherited from class org.springframework.web.servlet.tags.form.AbstractFormTag
createTagWriter, doStartTagInternal, evaluate, getDisplayString, getDisplayString, isDefaultHtmlEscape, writeOptionalAttribute
Methods inherited from class org.springframework.web.servlet.tags.HtmlEscapingAwareTag
htmlEscape, isHtmlEscape, isResponseEncodedHtmlEscape, setHtmlEscape
Methods inherited from class org.springframework.web.servlet.tags.RequestContextAwareTag
doCatch, doStartTag, getRequestContext
Methods inherited from class jakarta.servlet.jsp.tagext.TagSupport
doAfterBody, 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
Methods inherited from interface jakarta.servlet.jsp.tagext.BodyTag
doInitBody, setBodyContent
Methods inherited from interface jakarta.servlet.jsp.tagext.IterationTag
doAfterBody
Methods inherited from interface jakarta.servlet.jsp.tagext.Tag
doEndTag, doStartTag, getParent, release, setPageContext, setParent
-
Field Details
-
MESSAGES_ATTRIBUTE
The key under which this tag exposes error messages in thepage context scope
.- See Also:
-
SPAN_TAG
The HTML 'span
' tag.- See Also:
-
-
Constructor Details
-
ErrorsTag
public ErrorsTag()
-
-
Method Details
-
setElement
Set the HTML element must be used to render the error messages.Defaults to an HTML '
<span/>
' tag. -
getElement
Get the HTML element must be used to render the error messages. -
setDelimiter
Set the delimiter to be used between error messages.Defaults to an HTML '
<br/>
' tag. -
getDelimiter
Return the delimiter to be used between error messages. -
autogenerateId
Get the value for the HTML 'id
' attribute.Appends '
.errors
' to the value returned byAbstractDataBoundFormElementTag.getPropertyPath()
or to the model attribute name if the<form:errors/>
tag's 'path
' attribute has been omitted.- Overrides:
autogenerateId
in classAbstractDataBoundFormElementTag
- Returns:
- the value for the HTML '
id
' attribute - Throws:
JspException
- See Also:
-
getName
Get the value for the HTML 'name
' attribute.Simply returns
null
because the 'name
' attribute is not a validate attribute for the 'span
' element.- Overrides:
getName
in classAbstractDataBoundFormElementTag
- Returns:
- the value for the HTML '
name
' attribute - Throws:
JspException
-
shouldRender
Should rendering of this tag proceed at all?Only renders output when there are errors for the configured
path
.- Overrides:
shouldRender
in classAbstractHtmlElementBodyTag
- Returns:
true
only when there are errors for the configuredpath
- Throws:
JspException
-
renderDefaultContent
- Specified by:
renderDefaultContent
in classAbstractHtmlElementBodyTag
- Throws:
JspException
-
exposeAttributes
Exposes any bind status error messages underthis key
in thePageContext.PAGE_SCOPE
.Only called if
shouldRender()
returnstrue
.- Overrides:
exposeAttributes
in classAbstractHtmlElementBodyTag
- Throws:
JspException
- See Also:
-
removeAttributes
protected void removeAttributes()Removes any bind status error messages that were previously stored underthis key
in thePageContext.PAGE_SCOPE
.- Overrides:
removeAttributes
in classAbstractHtmlElementBodyTag
- See Also:
-