Appendix D. spring.tld

D.1. Introduction

One of the view technologies you can use with the Spring Framework is Java Server Pages (JSPs). To help you implement views using Java Server Pages the Spring Framework provides you with some tags for evaluating errors, setting themes and outputting internationalized messages.

Please note that the various tags generated by this form tag library are compliant with the XHTML-1.0-Strict specification and attendant DTD.

This appendix describes the spring.tld tag library.

D.2. The `bind` tag

Provides BindStatus object for the given bind path. The HTML escaping flag participates in a page-wide or application-wide setting (i.e. by HtmlEscapeTag or a "defaultHtmlEscape" context-param in web.xml).

Table D.1. Attributes

Attribute	Required?	Runtime Expression?
htmlEscape	false	true
Set HTML escaping for this tag, as boolean value. Overrides the default HTML escaping setting for the current page.
ignoreNestedPath	false	true
Set whether to ignore a nested path, if any. Default is to not ignore.
path	true	true
The path to the bean or bean property to bind status information for. For instance account.name, company.address.zipCode or just employee. The status object will exported to the page scope, specifically for this bean or bean property

D.3. The `escapeBody` tag

Escapes its enclosed body content, applying HTML escaping and/or JavaScript escaping. The HTML escaping flag participates in a page-wide or application-wide setting (i.e. by HtmlEscapeTag or a "defaultHtmlEscape" context-param in web.xml).

Table D.2. Attributes

Attribute	Required?	Runtime Expression?
htmlEscape	false	true
Set HTML escaping for this tag, as boolean value. Overrides the default HTML escaping setting for the current page.
javaScriptEscape	false	true
Set JavaScript escaping for this tag, as boolean value. Default is false.

D.4. The `hasBindErrors` tag

Provides Errors instance in case of bind errors. The HTML escaping flag participates in a page-wide or application-wide setting (i.e. by HtmlEscapeTag or a "defaultHtmlEscape" context-param in web.xml).

Table D.3. Attributes

Attribute	Required?	Runtime Expression?
htmlEscape	false	true
Set HTML escaping for this tag, as boolean value. Overrides the default HTML escaping setting for the current page.
name	true	true
The name of the bean in the request, that needs to be inspected for errors. If errors are available for this bean, they will be bound under the 'errors' key.

D.5. The `htmlEscape` tag

Sets default HTML escape value for the current page. Overrides a "defaultHtmlEscape" context-param in web.xml, if any.

Table D.4. Attributes

Attribute	Required?	Runtime Expression?
defaultHtmlEscape	true	true
Set the default value for HTML escaping, to be put into the current PageContext.

D.6. The `message` tag

Retrieves the message with the given code, or text if code isn't resolvable. The HTML escaping flag participates in a page-wide or application-wide setting (i.e. by HtmlEscapeTag or a "defaultHtmlEscape" context-param in web.xml).

Table D.5. Attributes

Attribute	Required?	Runtime Expression?
arguments	false	true
Set optional message arguments for this tag, as a (comma-)delimited String (each String argument can contain JSP EL), an Object array (used as argument array), or a single Object (used as single argument).
argumentSeparator	false	true
The separator character to be used for splitting the arguments string value; defaults to a 'comma' (',').
code	false	true
The code (key) to use when looking up the message. If code is not provided, the text attribute will be used.
htmlEscape	false	true
Set HTML escaping for this tag, as boolean value. Overrides the default HTML escaping setting for the current page.
javaScriptEscape	false	true
Set JavaScript escaping for this tag, as boolean value. Default is false.
message	false	true
A MessageSourceResolvable argument (direct or through JSP EL). Fits nicely when used in conjunction with Spring's own validation error classes which all implement the MessageSourceResolvable interface. For example, this allows you to iterate over all of the errors in a form, passing each error (using a runtime expression) as the value of this 'message' attribute, thus effecting the easy display of such error messages.
scope	false	true
The scope to use when exporting the result to a variable. This attribute is only used when var is also set. Possible values are page, request, session and application.
text	false	true
Default text to output when a message for the given code could not be found. If both text and code are not set, the tag will output null.
var	false	true
The string to use when binding the result to the page, request, session or application scope. If not specified, the result gets outputted to the writer (i.e. typically directly to the JSP).

D.7. The `nestedPath` tag

Sets a nested path to be used by the bind tag's path.

Table D.6. Attributes

Attribute	Required?	Runtime Expression?
path	true	true
Set the path that this tag should apply. E.g. 'customer' to allow bind paths like 'address.street' rather than 'customer.address.street'.

D.8. The `theme` tag

Retrieves the theme message with the given code, or text if code isn't resolvable. The HTML escaping flag participates in a page-wide or application-wide setting (i.e. by HtmlEscapeTag or a "defaultHtmlEscape" context-param in web.xml).

Table D.7. Attributes

Attribute	Required?	Runtime Expression?
arguments	false	true
Set optional message arguments for this tag, as a (comma-)delimited String (each String argument can contain JSP EL), an Object array (used as argument array), or a single Object (used as single argument).
argumentSeparator	false	true
The separator character to be used for splitting the arguments string value; defaults to a 'comma' (',').
code	false	true
The code (key) to use when looking up the message. If code is not provided, the text attribute will be used.
htmlEscape	false	true
Set HTML escaping for this tag, as boolean value. Overrides the default HTML escaping setting for the current page.
javaScriptEscape	false	true
Set JavaScript escaping for this tag, as boolean value. Default is false.
message	false	true
A MessageSourceResolvable argument (direct or through JSP EL).
scope	false	true
The scope to use when exporting the result to a variable. This attribute is only used when var is also set. Possible values are page, request, session and application.
text	false	true
Default text to output when a message for the given code could not be found. If both text and code are not set, the tag will output null.
var	false	true
The string to use when binding the result to the page, request, session or application scope. If not specified, the result gets outputted to the writer (i.e. typically directly to the JSP).

D.9. The `transform` tag

Provides transformation of variables to Strings, using an appropriate custom PropertyEditor from BindTag (can only be used inside BindTag). The HTML escaping flag participates in a page-wide or application-wide setting (i.e. by HtmlEscapeTag or a 'defaultHtmlEscape' context-param in web.xml).

Table D.8. Attributes

Attribute	Required?	Runtime Expression?
htmlEscape	false	true
Set HTML escaping for this tag, as boolean value. Overrides the default HTML escaping setting for the current page.
scope	false	true
The scope to use when exported the result to a variable. This attribute is only used when var is also set. Possible values are page, request, session and application.
value	true	true
The value to transform. This is the actual object you want to have transformed (for instance a Date). Using the PropertyEditor that is currently in use by the 'spring:bind' tag.
var	false	true
The string to use when binding the result to the page, request, session or application scope. If not specified, the result gets outputted to the writer (i.e. typically directly to the JSP).

Prev	Home	Next
Appendix C. spring-beans-2.0.dtd	Sponsored by Interface21	Appendix E. spring-form.tld