public class

BindTag

extends HtmlEscapingAwareTag
implements EditorAwareTag
java.lang.Object
   ↳ TagSupport
     ↳ org.springframework.web.servlet.tags.RequestContextAwareTag
       ↳ org.springframework.web.servlet.tags.HtmlEscapingAwareTag
         ↳ org.springframework.web.servlet.tags.BindTag

Class Overview

Bind tag, supporting evaluation of binding errors for a certain bean or bean property. Exposes a "status" variable of type BindStatus, to both Java expressions and JSP EL expressions.

Can be used to bind to any bean or bean property in the model. The specified path determines whether the tag exposes the status of the bean itself (showing object-level errors), a specific bean property (showing field errors), or a matching set of bean properties (showing all corresponding field errors).

The Errors object that has been bound using this tag is exposed to collaborating tags, as well as the bean property that this errors object applies to. Nested tags such as the TransformTag can access those exposed properties.

See Also

Summary

Constants
String STATUS_VARIABLE_NAME Name of the exposed variable within the scope of this tag: "status".
[Expand]
Inherited Constants
From class org.springframework.web.servlet.tags.RequestContextAwareTag
[Expand]
Inherited Fields
From class org.springframework.web.servlet.tags.RequestContextAwareTag
Public Constructors
BindTag()
Public Methods
int doEndTag()
void doFinally()
final PropertyEditor getEditor()
Retrieve the PropertyEditor for the property that this tag is currently bound to.
final Errors getErrors()
Retrieve the Errors instance that this tag is currently bound to.
String getPath()
Return the path that this tag applies to.
final String getProperty()
Retrieve the property that this tag is currently bound to, or null if bound to an object rather than a specific property.
boolean isIgnoreNestedPath()
Return whether to ignore a nested path, if any.
void setIgnoreNestedPath(boolean ignoreNestedPath)
Set whether to ignore a nested path, if any.
void setPath(String path)
Set the path that this tag should apply.
Protected Methods
final int doStartTagInternal()
Called by doStartTag to perform the actual work.
[Expand]
Inherited Methods
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 STATUS_VARIABLE_NAME

Name of the exposed variable within the scope of this tag: "status".

Constant Value: "status"

Public Constructors

public BindTag ()

Public Methods

public int doEndTag ()

public void doFinally ()

public final PropertyEditor getEditor ()

Retrieve the PropertyEditor for the property that this tag is currently bound to. Intended for cooperating nesting tags.

Returns
  • the current PropertyEditor, or null if none

public final Errors getErrors ()

Retrieve the Errors instance that this tag is currently bound to. Intended for cooperating nesting tags.

Returns
  • the current Errors instance, or null if none

public String getPath ()

Return the path that this tag applies to.

public final String getProperty ()

Retrieve the property that this tag is currently bound to, or null if bound to an object rather than a specific property. Intended for cooperating nesting tags.

Returns
  • the property that this tag is currently bound to, or null if none

public boolean isIgnoreNestedPath ()

Return whether to ignore a nested path, if any.

public void setIgnoreNestedPath (boolean ignoreNestedPath)

Set whether to ignore a nested path, if any. Default is to not ignore.

public void setPath (String path)

Set the path that this tag should apply. Can be a bean (e.g. "person") to get global errors, or a bean property (e.g. "person.name") to get field errors (also supporting nested fields and "person.na*" mappings). "person.*" will return all errors for the specified bean, both global and field errors.

See Also

Protected Methods

protected final int doStartTagInternal ()

Called by doStartTag to perform the actual work.

Returns
  • same as TagSupport.doStartTag
Throws
Exception