public class

ErrorsTag

extends AbstractHtmlElementBodyTag

java.lang.Object
↳	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
						↳	org.springframework.web.servlet.tags.form.AbstractHtmlElementBodyTag
							↳	org.springframework.web.servlet.tags.form.ErrorsTag

Class Overview

Form tag for displaying errors for a particular field or object.

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 '*'

Summary

Constants
String	MESSAGES_ATTRIBUTE	The key under which this tag exposes error messages in the PageContext#PAGE_SCOPE page context scope.
String	SPAN_TAG	The HTML '`span`' tag.

[Expand]

Inherited Constants

From class org.springframework.web.servlet.tags.form.AbstractHtmlElementTag

From class org.springframework.web.servlet.tags.form.AbstractDataBoundFormElementTag

From class org.springframework.web.servlet.tags.RequestContextAwareTag

[Expand]

Inherited Fields

From class org.springframework.web.servlet.tags.form.AbstractDataBoundFormElementTag

From class org.springframework.web.servlet.tags.RequestContextAwareTag

Public Constructors
	ErrorsTag()

Public Methods
String	getDelimiter() Return the delimiter to be used between error messages.
String	getElement() Get the HTML element must be used to render the error messages.
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 Methods
String	autogenerateId() Get the value for the HTML '`id`' attribute.
void	exposeAttributes() Exposes any bind status error messages under `this key` in the PageContext#PAGE_SCOPE.
String	getName() Get the value for the HTML '`name`' attribute.
void	removeAttributes() Removes any bind status error messages that were previously stored under `this key` in the PageContext#PAGE_SCOPE.
void	renderDefaultContent(TagWriter tagWriter)
boolean	shouldRender() Should rendering of this tag proceed at all? Only renders output when there are errors for the configured `path`.

[Expand]

Inherited Methods

From class org.springframework.web.servlet.tags.form.AbstractHtmlElementBodyTag

int	doEndTag() If `rendering`, flush any buffered BodyContent or, if no BodyContent is supplied, `render the default content`.
void	doFinally() Clean up any attributes and stored resources.
void	doInitBody()
void	exposeAttributes() Called during `writeTagContent(TagWriter)` allowing subclasses to add any attributes to the javax.servlet.jsp.PageContext as needed.
void	flushBufferedBodyContent(BodyContent bodyContent) The user customised the output of the error messages - flush the buffered content into the main javax.servlet.jsp.JspWriter.
void	onWriteTagContent() Called at the start of `writeTagContent(TagWriter)` allowing subclasses to perform any precondition checks or setup tasks that might be necessary.
void	removeAttributes() Called by `doFinally()` allowing subclasses to remove any attributes from the javax.servlet.jsp.PageContext as needed.
abstract void	renderDefaultContent(TagWriter tagWriter)
void	renderFromBodyContent(BodyContent bodyContent, TagWriter tagWriter) Render the tag contents based on the supplied BodyContent.
void	setBodyContent(BodyContent bodyContent)
boolean	shouldRender() Should rendering of this tag proceed at all.
int	writeTagContent(TagWriter tagWriter) Subclasses should implement this method to perform tag content rendering.

From class org.springframework.web.servlet.tags.form.AbstractHtmlElementTag

String	getCssClass() Get the value of the '`class`' attribute.
String	getCssErrorClass() The CSS class to use when the field bound to a particular tag has errors.
String	getCssStyle() Get the value of the '`style`' attribute.
String	getDir() Get the value of the '`dir`' attribute.
Map<String, Object>	getDynamicAttributes() Get the map of dynamic attributes.
String	getLang() Get the value of the '`lang`' attribute.
String	getOnclick() Get the value of the '`onclick`' attribute.
String	getOndblclick() Get the value of the '`ondblclick`' attribute.
String	getOnkeydown() Get the value of the '`onkeydown`' attribute.
String	getOnkeypress() Get the value of the '`onkeypress`' attribute.
String	getOnkeyup() Get the value of the '`onkeyup`' attribute.
String	getOnmousedown() Get the value of the '`onmousedown`' attribute.
String	getOnmousemove() Get the value of the '`onmousemove`' attribute.
String	getOnmouseout() Get the value of the '`onmouseout`' attribute.
String	getOnmouseover() Get the value of the '`onmouseover`' attribute.
String	getOnmouseup() Get the value of the '`onmouseup`' attribute.
String	getTabindex() Get the value of the '`tabindex`' attribute.
String	getTitle() Get the value of the '`title`' attribute.
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.
void	writeDefaultAttributes(TagWriter tagWriter) Writes the default attributes configured via this base class to the supplied `TagWriter`.
void	writeOptionalAttributes(TagWriter tagWriter) Writes the optional attributes configured via this base class to the supplied `TagWriter`.

From class org.springframework.web.servlet.tags.form.AbstractDataBoundFormElementTag

From class org.springframework.web.servlet.tags.form.AbstractFormTag

From class org.springframework.web.servlet.tags.HtmlEscapingAwareTag

From class org.springframework.web.servlet.tags.RequestContextAwareTag

From class java.lang.Object

From interface org.springframework.web.servlet.tags.EditorAwareTag

Constants

public static final String MESSAGES_ATTRIBUTE

The key under which this tag exposes error messages in the PageContext#PAGE_SCOPE page context scope.

Constant Value: "messages"

public static final String SPAN_TAG

The HTML 'span' tag.

Constant Value: "span"

Public Constructors

public ErrorsTag ()

Public Methods

public String getDelimiter ()

Return the delimiter to be used between error messages.

public String getElement ()

Get the HTML element must be used to render the error messages.

public void setDelimiter (String delimiter)

Set the delimiter to be used between error messages.

Defaults to an HTML '<br/>' tag.

public void setElement (String element)

Set the HTML element must be used to render the error messages.

Defaults to an HTML '<span/>' tag.

Protected Methods

protected String autogenerateId ()

Get the value for the HTML 'id' attribute.

Appends '.errors' to the value returned by getPropertyPath() or to the model attribute name if the <form:errors/> tag's 'path' attribute has been omitted.

Returns

the value for the HTML 'id' attribute

Throws

JspException

protected void exposeAttributes ()

Exposes any bind status error messages under this key in the PageContext#PAGE_SCOPE.

Only called if shouldRender() returns true.

Throws

JspException

protected String 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.

Returns

the value for the HTML 'name' attribute

Throws

JspException

protected void removeAttributes ()

Removes any bind status error messages that were previously stored under this key in the PageContext#PAGE_SCOPE.

protected void renderDefaultContent (TagWriter tagWriter)

Throws

JspException

protected boolean shouldRender ()

Should rendering of this tag proceed at all?

Only renders output when there are errors for the configured path.

Returns

true only when there are errors for the configured path

Throws

JspException

Classes

ErrorsTag

Class Overview

Summary

Constants

public static final String MESSAGES_ATTRIBUTE

public static final String SPAN_TAG

Public Constructors

public ErrorsTag ()

Public Methods

public String getDelimiter ()

public String getElement ()

public void setDelimiter (String delimiter)

public void setElement (String element)

Protected Methods

protected String autogenerateId ()

Returns

Throws

See Also

protected void exposeAttributes ()

Throws

See Also

protected String getName ()

Returns

Throws

protected void removeAttributes ()

See Also

protected void renderDefaultContent (TagWriter tagWriter)

Throws

protected boolean shouldRender ()

Returns

Throws