Spring Form

7/30/2019 Spring Form

1/21

5/9/13 Appendix E. spring-form.tld

static.springsource.org/spring/docs/2.5.5/reference/spring-form.tld.html 1/21

Appendix E. spring-form.tld

E.1. IntroductionOne of the view technologies you can use with the Spring Framework is Java ServerPages (JSPs). To help you implement views using Java Server Pages the SpringFramework provides you with some tags for evaluating errors, setting themes andoutputting internationalized messages.

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

This ap pendix describes the s pring-form.tld tag library.

Section E.2, The checkbox tag

Se ction E.3, The checkboxes t ag Se ction E.4, The errors tag

Se ction E.5, The form tag

Section E.6, The hidden tag

Se ction E.7, The input t ag

Se ction E.8, The label tag

Se ction E.9, The option tag

Section E.10, The options tag

Se ction E.11, The pass wo r d tag

Section E.12, The radiobutton tag

S ection E.13, The radio buttons tag

Section E.14, The se lect tag

Section E.15, The textarea tag

E.2. The checkbox tagRenders an HTML 'input' tag with type 'checkbox'.

Table E.1. Attributes

Attribute Required?Runtime

Expression?Description

accesskey false true HTML Standard Attribute

cssClass false true Equivalent to "class" - HTML OptionalAttribute

cssErrorClass false true

Equivalent to "class" - HTML OptionalAttribute. Used w hen the bo und field has
http://static.springsource.org/spring/docs/2.5.5/reference/spring-form.tld.html#spring-form.tld.textareahttp://static.springsource.org/spring/docs/2.5.5/reference/spring-form.tld.html#spring-form.tld.textareahttp://static.springsource.org/spring/docs/2.5.5/reference/spring-form.tld.html#spring-form.tld.radiobuttonhttp://static.springsource.org/spring/docs/2.5.5/reference/spring-form.tld.html#spring-form.tld.passwordhttp://static.springsource.org/spring/docs/2.5.5/reference/spring-form.tld.html#spring-form.tld.optionshttp://static.springsource.org/spring/docs/2.5.5/reference/spring-form.tld.html#spring-form.tld.inputhttp://static.springsource.org/spring/docs/2.5.5/reference/spring-form.tld.html#spring-form.tld.hiddenhttp://static.springsource.org/spring/docs/2.5.5/reference/spring-form.tld.html#spring-form.tld.formhttp://static.springsource.org/spring/docs/2.5.5/reference/spring-form.tld.html#spring-form.tld.checkboxhttp://www.w3.org/TR/xhtml1/http://www.springframework.org/http://www.springframework.org/http://static.springsource.org/spring/docs/2.5.5/reference/spring-form.tld.html#spring-form.tld.textareahttp://static.springsource.org/spring/docs/2.5.5/reference/spring-form.tld.html#spring-form.tld.selecthttp://static.springsource.org/spring/docs/2.5.5/reference/spring-form.tld.html#spring-form.tld.radiobuttonshttp://static.springsource.org/spring/docs/2.5.5/reference/spring-form.tld.html#spring-form.tld.radiobuttonhttp://static.springsource.org/spring/docs/2.5.5/reference/spring-form.tld.html#spring-form.tld.passwordhttp://static.springsource.org/spring/docs/2.5.5/reference/spring-form.tld.html#spring-form.tld.optionshttp://static.springsource.org/spring/docs/2.5.5/reference/spring-form.tld.html#spring-form.tld.optionhttp://static.springsource.org/spring/docs/2.5.5/reference/spring-form.tld.html#spring-form.tld.labelhttp://static.springsource.org/spring/docs/2.5.5/reference/spring-form.tld.html#spring-form.tld.inputhttp://static.springsource.org/spring/docs/2.5.5/reference/spring-form.tld.html#spring-form.tld.hiddenhttp://static.springsource.org/spring/docs/2.5.5/reference/spring-form.tld.html#spring-form.tld.formhttp://static.springsource.org/spring/docs/2.5.5/reference/spring-form.tld.html#spring-form.tld.errorshttp://static.springsource.org/spring/docs/2.5.5/reference/spring-form.tld.html#spring-form.tld.checkboxeshttp://static.springsource.org/spring/docs/2.5.5/reference/spring-form.tld.html#spring-form.tld.checkboxhttp://www.w3.org/TR/xhtml1/dtds.html#a_dtd_XHTML-1.0-Stricthttp://www.w3.org/TR/xhtml1/http://www.springframework.org/


2/21



errors.

cssStyle false true Equivalent to "s tyle" - HTML OptionalAttribute

dir false true HTML Standard Attribute

disabled false trueHTML Optional Attribute. Setting the valueof this attribute to 'true' (without thequotes) will disab le the HTML element.

htmlEscape false true Enable/disable HTML escaping of rende redvalues.

id false true HTML Standard Attribute

label false true Value to be displayed as part of the tag

lang false true HTML Standard Attribute

onblur false true HTML Event Attribute

onchange false true HTML Event Attribute

onclick false true HTML Event Attribute

ondblclick false true HTML Event Attribute

onfocus 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 true true Path to property for data binding

tabindex false true HTML Standard Attribute

NEWSLETTER SUBSCRIPTIONSearch Documentation all
http://www.springsource.org/newsletter-subscription?cid=70180000000wIe4AAEhttp://www.springsource.org/?cid=70180000000wIe4AAE


3/21



title false true HTML Standard Attribute

value false true HTML Optional Attribute

E.3. The checkboxes tagRenders multiple HTML 'input' tags with type 'checkbox'.






cssErrorClass false trueEquivalent to "class" - HTML OptionalAttribute. Used w hen the bo und field haserrors.


delimiter false true

Delimiter to use betw een each 'input' tag

with type 'checkbox'. There is no delimiterby default.



element false trueSpecifies the HTML element tha t is use d toenclose e ach 'input' tag w ith type'checkbox'. Defaults to 'span'.



itemLabel false true Value to be displayed a s pa rt of the 'input'tags with type 'checkbox'

items true trueThe Collection, Map or array of objectsused to generate the 'input' tags w ith type


4/21



'checkbox'

itemValue false trueName of the property mappe d to 'value'attribute of the 'input' tags with type'checkbox'


















E.4. The errors tagRenders field errors in an HTML 'span' tag.



5/21



Attribute Required? RuntimeExpression?

Description



delimiter false true Delimiter for disp laying multiple e rrormessages. Defaults to the br tag.


element false true Specifies the HTML element tha t is use d torender the enclosing errors.

htmlEscape false true Enable/disable HTML escaping of renderedvalues.













path false true Path to errors object for data binding




6/21



E.5. The form tagRenders an HTML 'form' tag and exposes a binding path to inner tags for binding.




acceptCharset false true

Specifies the list o f character encodingsfor input data that is accepted b y theserver processing this form. The value is aspace- and/or comma-delimited list of charset values . The client must interpretthis list as an e xclusive-or list, i.e., theserver is able to accept any singlecharacter encoding per entity received.

action false true HTML Required Attribute

autocomplete false true Common Optional Attribute

commandName false trueName of the model attribute under w hichthe form object is e xposed. Defaults to'command'.




enctype false true HTML Optional Attribute




method false true HTML Optional Attribute

modelAttribute false trueName of the model attribute under w hichthe form object is e xposed. Defaults to'command'.

name false true HTML Standard Attribute - added for


7/21



backwards compatibility cases











onreset false true HTML Event Attribute

onsubmit false true HTML Event Attribute

target false true HTML Optional Attribute


E.6. The hidden tagRenders an HTML 'input' tag with type 'hidden' using the bound value.




htmlEscape false true Enable/disable HTML escaping of rendered values.


path true true Path to p roperty for data b inding


8/21



E.7. The input tagRenders an HTML 'input' tag with type 'text' using the bound value.





alt false true HTML Optional Attribute









lang false trueHTML Standard Attribute

maxlength false true HTML Optional Attribute





9/21













onselect false true HTML Event Attribute


readonly false true

HTML Optional Attribute. Setting the valueof this attribute to 'true' (without thequotes) will make the HTML elementreadonly.

size false true HTML Optional Attribute



E.8. The label tagRenders a form field label in an HTML 'label' tag.




cssClass false true Equivalent to "class" - HTML OptionalAttribute.


10/21



cssErrorClass false trueEquivalent to "class" - HTML OptionalAttribute. Used on ly whe n errors arepresent.



for false true HTML Standard Attribute














path true true Path to errors object for data binding



E.9. The option tagRenders a single HTML 'option'. Sets 'selected' as appropriate based on bound value.


11/21













label false true HTML Optional Attribute














12/21




value true true HTML Optional Attribute

E.10. The options tagRenders a list of HTML 'option' tags. Sets 'selected' as appropriate based on boundvalue.











itemLabel false true Name of the property mappe d to the inner

text of the 'option' tag

items true true The Collection, Map or array of objectsused to generate the inner 'option' tags

itemValue false true Name of the property mappe d to 'value'attribute of the 'option' tag




13/21














E.11. The password tagRenders an HTML 'input' tag with type 'password' using the bound value.





alt false true HTML Optional Attribute



cssErrorClass false trueEquivalent to "class" - HTML OptionalAttribute. Used whe n the bound field haserrors.



14/21








maxlength false true HTML Optional Attribute
















readonly false true

HTML Optional Attribute. Setting the valueof this attribute to 'true' (without thequotes) will make the HTML elementreadonly.


15/21



showPassword false true Is the password value to be shown?Defaults to false .




E.12. The radiobutton tagRenders an HTML 'input' tag with type 'radio'.










htmlEscape false true Enable/disable HTML escaping of rende red

values.


label false true Value to be displayed as part of the tag




16/21


















value false true HTML Optional Attribute

E.13. The radiobuttons tagRenders multiple HTML 'input' tags with type 'radio'.







17/21





delimiter false trueDelimiter to use betw een each 'input' tagwith type 'radio'. There is no delimiter by

default.



element false trueSpecifies the HTML element tha t is use d toenclose e ach 'input' tag w ith type 'radio'.Defaults to 'span'.



itemLabel false true Value to be displayed a s pa rt of the 'input'tags w ith type 'radio'

items true trueThe Collection, Map or array of objectsused to generate the 'input' tags w ith type'radio'

itemValue false trueName of the property mappe d to 'value'attribute of the 'input' tags with type'radio'










18/21












E.14. The select tagRenders an HTML 'select' element. Supports databinding to the selected option.



Expression? Description






disabled false true

HTML Optional Attribute. Setting the valueof this attribute to 'true' (without thequotes) will disab le the HTML element.



19/21




itemLabel false true Name of the property mappe d to the innertext of the 'option' tag

items false true The Collection, Map or array of objectsused to generate the inner 'option' tags

itemValue false true Name of the property mappe d to 'value'attribute of the 'option' tag


multiple false true HTML Optional Attribute



















20/21



E.15. The textarea tagRenders an HTML 'textarea'.





cols false true HTML Required Attribute
















21/21











readonly false trueHTML Optional Attribute. Setting the valueof this attribute to 'true' (without thequotes) will make the HTML elementreadonly.

rows false true HTML Required Attribute



Prev Home

Appendix D. spring.tld Sponsored bySpringSource
http://www.springsource.com/http://static.springsource.org/spring/docs/2.5.5/reference/index.htmlhttp://static.springsource.org/spring/docs/2.5.5/reference/spring.tld.html

Documents

Spring Form