Consistent JSP tag documentation
Issue: SPR-13520
This commit is contained in:
Juergen Hoeller
@@ -33,6 +33,41 @@ This appendix describes the `spring-form.tld` tag library.
|
||||
|
||||
|
||||
|
||||
[[spring-form.tld.button]]
|
||||
== The button tag
|
||||
|
||||
Renders a form field label in an HTML 'button' tag.
|
||||
|
||||
[[spring-form.tld.button.table]]
|
||||
[cols="1,1,1,3"]
|
||||
.Attributes
|
||||
|===
|
||||
| Attribute| Required?| Runtime Expression?| Description
|
||||
|
||||
| disabled
|
||||
| false
|
||||
| true
|
||||
| HTML Optional Attribute. Setting the value of this attribute to 'true' will disable the HTML element.
|
||||
|
||||
| id
|
||||
| false
|
||||
| true
|
||||
| HTML Standard Attribute
|
||||
|
||||
| name
|
||||
| false
|
||||
| true
|
||||
| The name attribute for the HTML button tag
|
||||
|
||||
| value
|
||||
| false
|
||||
| true
|
||||
| The name attribute for the HTML button tag
|
||||
|===
|
||||
|
||||
|
||||
|
||||
|
||||
[[spring-form.tld.checkbox]]
|
||||
== The checkbox tag
|
||||
|
||||
@@ -72,8 +107,7 @@ Renders an HTML 'input' tag with type 'checkbox'.
|
||||
| disabled
|
||||
| false
|
||||
| true
|
||||
| HTML Optional Attribute. Setting the value of this attribute to 'true' (without the
|
||||
quotes) will disable the HTML element.
|
||||
| HTML Optional Attribute. Setting the value of this attribute to 'true' will disable the HTML element.
|
||||
|
||||
| htmlEscape
|
||||
| false
|
||||
@@ -218,8 +252,7 @@ Renders multiple HTML 'input' tags with type 'checkbox'.
|
||||
| delimiter
|
||||
| false
|
||||
| true
|
||||
| Delimiter to use between each 'input' tag with type 'checkbox'. There is no delimiter
|
||||
by default.
|
||||
| Delimiter to use between each 'input' tag with type 'checkbox'. There is no delimiter by default.
|
||||
|
||||
| dir
|
||||
| false
|
||||
@@ -229,14 +262,12 @@ Renders multiple HTML 'input' tags with type 'checkbox'.
|
||||
| disabled
|
||||
| false
|
||||
| true
|
||||
| HTML Optional Attribute. Setting the value of this attribute to 'true' (without the
|
||||
quotes) will disable the HTML element.
|
||||
| HTML Optional Attribute. Setting the value of this attribute to 'true' will disable the HTML element.
|
||||
|
||||
| element
|
||||
| false
|
||||
| true
|
||||
| Specifies the HTML element that is used to enclose each 'input' tag with type
|
||||
'checkbox'. Defaults to 'span'.
|
||||
| Specifies the HTML element that is used to enclose each 'input' tag with type 'checkbox'. Defaults to 'span'.
|
||||
|
||||
| htmlEscape
|
||||
| false
|
||||
@@ -256,14 +287,12 @@ Renders multiple HTML 'input' tags with type 'checkbox'.
|
||||
| items
|
||||
| true
|
||||
| true
|
||||
| The Collection, Map or array of objects used to generate the 'input' tags with type
|
||||
'checkbox'
|
||||
| The Collection, Map or array of objects used to generate the 'input' tags with type 'checkbox'
|
||||
|
||||
| itemValue
|
||||
| false
|
||||
| true
|
||||
| Name of the property mapped to 'value' attribute of the 'input' tags with type
|
||||
'checkbox'
|
||||
| Name of the property mapped to 'value' attribute of the 'input' tags with type 'checkbox'
|
||||
|
||||
| lang
|
||||
| false
|
||||
@@ -490,8 +519,8 @@ Renders an HTML 'form' tag and exposes a binding path to inner tags for binding.
|
||||
| true
|
||||
| Specifies the list of character encodings for input data that is accepted by the
|
||||
server processing this form. The value is a space- and/or comma-delimited list of
|
||||
charset values. The client must interpret this list as an exclusive-or list, i.e., the
|
||||
server is able to accept any single character encoding per entity received.
|
||||
charset values. The client must interpret this list as an exclusive-or list, i.e.,
|
||||
the server is able to accept any single character encoding per entity received.
|
||||
|
||||
| action
|
||||
| false
|
||||
@@ -501,8 +530,7 @@ Renders an HTML 'form' tag and exposes a binding path to inner tags for binding.
|
||||
| commandName
|
||||
| false
|
||||
| true
|
||||
| Name of the model attribute under which the form object is exposed. Defaults to
|
||||
'command'.
|
||||
| Name of the model attribute under which the form object is exposed. Defaults to 'command'.
|
||||
|
||||
| cssClass
|
||||
| false
|
||||
@@ -544,11 +572,15 @@ Renders an HTML 'form' tag and exposes a binding path to inner tags for binding.
|
||||
| true
|
||||
| HTML Optional Attribute
|
||||
|
||||
| methodParam
|
||||
| false
|
||||
| true
|
||||
| The parameter name used for HTTP methods other then GET and POST. Default is '_method'.
|
||||
|
||||
| modelAttribute
|
||||
| false
|
||||
| true
|
||||
| Name of the model attribute under which the form object is exposed. Defaults to
|
||||
'command'.
|
||||
| Name of the model attribute under which the form object is exposed. Defaults to 'command'.
|
||||
|
||||
| name
|
||||
| false
|
||||
@@ -615,6 +647,11 @@ Renders an HTML 'form' tag and exposes a binding path to inner tags for binding.
|
||||
| true
|
||||
| HTML Event Attribute
|
||||
|
||||
| servletRelativeAction
|
||||
| false
|
||||
| true
|
||||
| Action reference to be appended to the current servlet path
|
||||
|
||||
| target
|
||||
| false
|
||||
| true
|
||||
@@ -708,8 +745,7 @@ Renders an HTML 'input' tag with type 'text' using the bound value.
|
||||
| disabled
|
||||
| false
|
||||
| true
|
||||
| HTML Optional Attribute. Setting the value of this attribute to 'true' (without the
|
||||
quotes) will disable the HTML element.
|
||||
| HTML Optional Attribute. Setting the value of this attribute to 'true' will disable the HTML element.
|
||||
|
||||
| htmlEscape
|
||||
| false
|
||||
@@ -809,8 +845,7 @@ Renders an HTML 'input' tag with type 'text' using the bound value.
|
||||
| readonly
|
||||
| false
|
||||
| true
|
||||
| HTML Optional Attribute. Setting the value of this attribute to 'true' (without the
|
||||
quotes) will make the HTML element readonly.
|
||||
| HTML Optional Attribute. Setting the value of this attribute to 'true' will make the HTML element readonly.
|
||||
|
||||
| size
|
||||
| false
|
||||
@@ -985,8 +1020,7 @@ Renders a single HTML 'option'. Sets 'selected' as appropriate based on bound va
|
||||
| disabled
|
||||
| false
|
||||
| true
|
||||
| HTML Optional Attribute. Setting the value of this attribute to 'true' (without the
|
||||
quotes) will disable the HTML element.
|
||||
| HTML Optional Attribute. Setting the value of this attribute to 'true' will disable the HTML element.
|
||||
|
||||
| htmlEscape
|
||||
| false
|
||||
@@ -1111,8 +1145,7 @@ Renders a list of HTML 'option' tags. Sets 'selected' as appropriate based on bo
|
||||
| disabled
|
||||
| false
|
||||
| true
|
||||
| HTML Optional Attribute. Setting the value of this attribute to 'true' (without the
|
||||
quotes) will disable the HTML element.
|
||||
| HTML Optional Attribute. Setting the value of this attribute to 'true' will disable the HTML element.
|
||||
|
||||
| htmlEscape
|
||||
| false
|
||||
@@ -1257,8 +1290,7 @@ Renders an HTML 'input' tag with type 'password' using the bound value.
|
||||
| disabled
|
||||
| false
|
||||
| true
|
||||
| HTML Optional Attribute. Setting the value of this attribute to 'true' (without the
|
||||
quotes) will disable the HTML element.
|
||||
| HTML Optional Attribute. Setting the value of this attribute to 'true' will disable the HTML element.
|
||||
|
||||
| htmlEscape
|
||||
| false
|
||||
@@ -1358,8 +1390,7 @@ Renders an HTML 'input' tag with type 'password' using the bound value.
|
||||
| readonly
|
||||
| false
|
||||
| true
|
||||
| HTML Optional Attribute. Setting the value of this attribute to 'true' (without the
|
||||
quotes) will make the HTML element readonly.
|
||||
| HTML Optional Attribute. Setting the value of this attribute to 'true' will make the HTML element readonly.
|
||||
|
||||
| showPassword
|
||||
| false
|
||||
@@ -1424,8 +1455,7 @@ Renders an HTML 'input' tag with type 'radio'.
|
||||
| disabled
|
||||
| false
|
||||
| true
|
||||
| HTML Optional Attribute. Setting the value of this attribute to 'true' (without the
|
||||
quotes) will disable the HTML element.
|
||||
| HTML Optional Attribute. Setting the value of this attribute to 'true' will disable the HTML element.
|
||||
|
||||
| htmlEscape
|
||||
| false
|
||||
@@ -1570,8 +1600,7 @@ Renders multiple HTML 'input' tags with type 'radio'.
|
||||
| delimiter
|
||||
| false
|
||||
| true
|
||||
| Delimiter to use between each 'input' tag with type 'radio'. There is no delimiter by
|
||||
default.
|
||||
| Delimiter to use between each 'input' tag with type 'radio'. There is no delimiter by default.
|
||||
|
||||
| dir
|
||||
| false
|
||||
@@ -1581,14 +1610,12 @@ Renders multiple HTML 'input' tags with type 'radio'.
|
||||
| disabled
|
||||
| false
|
||||
| true
|
||||
| HTML Optional Attribute. Setting the value of this attribute to 'true' (without the
|
||||
quotes) will disable the HTML element.
|
||||
| HTML Optional Attribute. Setting the value of this attribute to 'true' will disable the HTML element.
|
||||
|
||||
| element
|
||||
| false
|
||||
| true
|
||||
| Specifies the HTML element that is used to enclose each 'input' tag with type 'radio'.
|
||||
Defaults to 'span'.
|
||||
| Specifies the HTML element that is used to enclose each 'input' tag with type 'radio'. Defaults to 'span'.
|
||||
|
||||
| htmlEscape
|
||||
| false
|
||||
@@ -1608,8 +1635,7 @@ Renders multiple HTML 'input' tags with type 'radio'.
|
||||
| items
|
||||
| true
|
||||
| true
|
||||
| The Collection, Map or array of objects used to generate the 'input' tags with type
|
||||
'radio'
|
||||
| The Collection, Map or array of objects used to generate the 'input' tags with type 'radio'
|
||||
|
||||
| itemValue
|
||||
| false
|
||||
@@ -1744,8 +1770,7 @@ Renders an HTML 'select' element. Supports databinding to the selected option.
|
||||
| disabled
|
||||
| false
|
||||
| true
|
||||
| HTML Optional Attribute. Setting the value of this attribute to 'true' (without the
|
||||
quotes) will disable the HTML element.
|
||||
| HTML Optional Attribute. Setting the value of this attribute to 'true' will disable the HTML element.
|
||||
|
||||
| htmlEscape
|
||||
| false
|
||||
@@ -1915,8 +1940,7 @@ Renders an HTML 'textarea'.
|
||||
| disabled
|
||||
| false
|
||||
| true
|
||||
| HTML Optional Attribute. Setting the value of this attribute to 'true' (without the
|
||||
quotes) will disable the HTML element.
|
||||
| HTML Optional Attribute. Setting the value of this attribute to 'true' will disable the HTML element.
|
||||
|
||||
| htmlEscape
|
||||
| false
|
||||
@@ -2011,8 +2035,7 @@ Renders an HTML 'textarea'.
|
||||
| readonly
|
||||
| false
|
||||
| true
|
||||
| HTML Optional Attribute. Setting the value of this attribute to 'true' (without the
|
||||
quotes) will make the HTML element readonly.
|
||||
| HTML Optional Attribute. Setting the value of this attribute to 'true' will make the HTML element readonly.
|
||||
|
||||
| rows
|
||||
| false
|
||||
|
||||
@@ -29,6 +29,26 @@ This appendix describes the `spring.tld` tag library.
|
||||
|
||||
|
||||
|
||||
[[spring.tld.argument]]
|
||||
== The argument tag
|
||||
|
||||
Argument tag based on the JSTL fmt:param tag. The purpose is to support arguments
|
||||
inside the message and theme tags.
|
||||
|
||||
[[spring.tld.argument.table]]
|
||||
[cols="1,1,1,3"]
|
||||
.Attributes
|
||||
|===
|
||||
| Attribute| Required?| Runtime Expression?| Description
|
||||
|
||||
| value
|
||||
| false
|
||||
| true
|
||||
| The value of the argument.
|
||||
|
||||
|
||||
|
||||
|
||||
[[spring.tld.bind]]
|
||||
== The bind tag
|
||||
|
||||
@@ -92,6 +112,51 @@ HtmlEscapeTag or a "defaultHtmlEscape" context-param in web.xml).
|
||||
|
||||
|
||||
|
||||
[[spring.tld.eval]]
|
||||
== The eval tag
|
||||
|
||||
Evaluates a Spring expression (SpEL) and either prints the result or assigns it to a
|
||||
variable.
|
||||
|
||||
[[spring.tld.eval.table]]
|
||||
[cols="1,1,1,3"]
|
||||
.Attributes
|
||||
|===
|
||||
| Attribute| Required?| Runtime Expression?| Description
|
||||
|
||||
| expression
|
||||
| true
|
||||
| true
|
||||
| The expression to evaluate.
|
||||
|
||||
| htmlEscape
|
||||
| false
|
||||
| true
|
||||
| Set HTML escaping for this tag, as a boolean value. Overrides the default HTML
|
||||
escaping setting for the current page.
|
||||
|
||||
| javaScriptEscape
|
||||
| false
|
||||
| true
|
||||
| Set JavaScript escaping for this tag, as a boolean value. Default is false.
|
||||
|
||||
| scope
|
||||
| false
|
||||
| true
|
||||
| The scope for the var. 'application', 'session', 'request' and 'page' scopes are
|
||||
supported. Defaults to page scope. This attribute has no effect unless the var
|
||||
attribute is also defined.
|
||||
|
||||
| var
|
||||
| false
|
||||
| true
|
||||
| The name of the variable to export the evaluation result to. If not specified the
|
||||
evaluation result is converted to a String and written as output.
|
||||
|===
|
||||
|
||||
|
||||
|
||||
|
||||
[[spring.tld.hasBindErrors]]
|
||||
== The hasBindErrors tag
|
||||
|
||||
@@ -238,6 +303,31 @@ Sets a nested path to be used by the bind tag's path.
|
||||
|
||||
|
||||
|
||||
[[spring.tld.param]]
|
||||
== The param tag
|
||||
|
||||
Parameter tag based on the JSTL c:param tag. The sole purpose is to support params
|
||||
inside the url tag.
|
||||
|
||||
[[spring.tld.param.table]]
|
||||
[cols="1,1,1,3"]
|
||||
.Attributes
|
||||
|===
|
||||
| Attribute| Required?| Runtime Expression?| Description
|
||||
|
||||
| name
|
||||
| true
|
||||
| true
|
||||
| The name of the parameter.
|
||||
|
||||
| value
|
||||
| false
|
||||
| true
|
||||
| The value of the parameter.
|
||||
|
||||
|
||||
|
||||
|
||||
[[spring.tld.theme]]
|
||||
== The theme tag
|
||||
|
||||
@@ -365,7 +455,7 @@ escaping. Modeled after the JSTL c:url tag with backwards compatibility in mind.
|
||||
|===
|
||||
| Attribute| Required?| Runtime Expression?| Description
|
||||
|
||||
| url
|
||||
| value
|
||||
| true
|
||||
| true
|
||||
| The URL to build. This value can include template {placeholders} that are replaced
|
||||
@@ -402,49 +492,3 @@ escaping. Modeled after the JSTL c:url tag with backwards compatibility in mind.
|
||||
| true
|
||||
| Set JavaScript escaping for this tag, as a boolean value. Default is false.
|
||||
|===
|
||||
|
||||
|
||||
|
||||
|
||||
[[spring.tld.eval]]
|
||||
== The eval tag
|
||||
|
||||
Evaluates a Spring expression (SpEL) and either prints the result or assigns it to a
|
||||
variable.
|
||||
|
||||
[[spring.tld.eval.table]]
|
||||
[cols="1,1,1,3"]
|
||||
.Attributes
|
||||
|===
|
||||
| Attribute| Required?| Runtime Expression?| Description
|
||||
|
||||
| expression
|
||||
| true
|
||||
| true
|
||||
| The expression to evaluate.
|
||||
|
||||
| var
|
||||
| false
|
||||
| true
|
||||
| The name of the variable to export the evaluation result to. If not specified the
|
||||
evaluation result is converted to a String and written as output.
|
||||
|
||||
| scope
|
||||
| false
|
||||
| true
|
||||
| The scope for the var. 'application', 'session', 'request' and 'page' scopes are
|
||||
supported. Defaults to page scope. This attribute has no effect unless the var
|
||||
attribute is also defined.
|
||||
|
||||
| htmlEscape
|
||||
| false
|
||||
| true
|
||||
| Set HTML escaping for this tag, as a boolean value. Overrides the default HTML
|
||||
escaping setting for the current page.
|
||||
|
||||
| javaScriptEscape
|
||||
| false
|
||||
| true
|
||||
| Set JavaScript escaping for this tag, as a boolean value. Default is false.
|
||||
|===
|
||||
|
||||
|
||||
Reference in New Issue
Block a user