public class FormTag extends AbstractHtmlElementTag
form' whose
inner elements are bound to properties on a form object.
Users should place the form object into the
ModelAndView when
populating the data for their view. The name of this form object can be
configured using the "modelAttribute" property.
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
DEFAULT_COMMAND_NAME
The default attribute name: "command"
|
static java.lang.String |
MODEL_ATTRIBUTE_VARIABLE_NAME
The name of the
PageContext attribute under which the
form object name is exposed. |
CLASS_ATTRIBUTE, DIR_ATTRIBUTE, LANG_ATTRIBUTE, ONCLICK_ATTRIBUTE, ONDBLCLICK_ATTRIBUTE, ONKEYDOWN_ATTRIBUTE, ONKEYPRESS_ATTRIBUTE, ONKEYUP_ATTRIBUTE, ONMOUSEDOWN_ATTRIBUTE, ONMOUSEMOVE_ATTRIBUTE, ONMOUSEOUT_ATTRIBUTE, ONMOUSEOVER_ATTRIBUTE, ONMOUSEUP_ATTRIBUTE, STYLE_ATTRIBUTE, TABINDEX_ATTRIBUTE, TITLE_ATTRIBUTENESTED_PATH_VARIABLE_NAMElogger, REQUEST_CONTEXT_PAGE_ATTRIBUTEpageContextEVAL_BODY_AGAINEVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE| Constructor and Description |
|---|
FormTag() |
| Modifier and Type | Method and Description |
|---|---|
protected java.lang.String |
autogenerateId()
Autogenerated IDs correspond to the form object name.
|
int |
doEndTag()
Closes the '
form' block tag and removes the form object name
from the PageContext. |
void |
doFinally()
Clears the stored
TagWriter. |
protected java.lang.String |
getAcceptCharset()
Get the value of the '
acceptCharset' attribute. |
protected java.lang.String |
getAction()
Get the value of the '
action' attribute. |
protected java.lang.String |
getAutocomplete()
Get the value of the '
autocomplete' attribute. |
protected java.lang.String |
getCommandName()
Get the name of the form attribute in the model.
|
protected java.lang.String |
getEnctype()
Get the value of the '
enctype' attribute. |
protected java.lang.String |
getMethod()
Get the value of the '
method' attribute. |
protected java.lang.String |
getMethodParameter()
Get the name of the request param for non-browser supported HTTP methods.
|
protected java.lang.String |
getModelAttribute()
Get the name of the form attribute in the model.
|
protected java.lang.String |
getName()
Get the value of the '
name' attribute. |
protected java.lang.String |
getOnreset()
Get the value of the '
onreset' attribute. |
protected java.lang.String |
getOnsubmit()
Get the value of the '
onsubmit' attribute. |
protected java.lang.String |
getServletRelativeAction()
Get the value of the '
action' attribute. |
java.lang.String |
getTarget()
Get the value of the '
target' attribute. |
protected boolean |
isMethodBrowserSupported(java.lang.String method)
Determine if the HTTP method is supported by browsers (i.e.
|
protected java.lang.String |
resolveAction()
Resolve the value of the '
action' attribute. |
protected java.lang.String |
resolveCssClass()
Override resolve CSS class since error class is not supported.
|
protected java.lang.String |
resolveModelAttribute()
Resolves and returns the name of the form object. |
void |
setAcceptCharset(java.lang.String acceptCharset)
Set the value of the '
acceptCharset' attribute. |
void |
setAction(java.lang.String action)
Set the value of the '
action' attribute. |
void |
setAutocomplete(java.lang.String autocomplete)
Set the value of the '
autocomplete' attribute. |
void |
setCommandName(java.lang.String commandName)
Set the name of the form attribute in the model.
|
void |
setCssErrorClass(java.lang.String cssErrorClass)
Unsupported for forms.
|
void |
setEnctype(java.lang.String enctype)
Set the value of the '
enctype' attribute. |
void |
setMethod(java.lang.String method)
Set the value of the '
method' attribute. |
void |
setMethodParam(java.lang.String methodParam)
Set the name of the request param for non-browser supported HTTP methods.
|
void |
setModelAttribute(java.lang.String modelAttribute)
Set the name of the form attribute in the model.
|
void |
setName(java.lang.String name)
Set the value of the '
name' attribute. |
void |
setOnreset(java.lang.String onreset)
Set the value of the '
onreset' attribute. |
void |
setOnsubmit(java.lang.String onsubmit)
Set the value of the '
onsubmit' attribute. |
void |
setPath(java.lang.String path)
Unsupported for forms.
|
void |
setServletRelativeAction(java.lang.String servletRelativeaction)
Set the value of the '
action' attribute. |
void |
setTarget(java.lang.String target)
Set the value of the '
target' attribute. |
protected int |
writeTagContent(TagWriter tagWriter)
Writes the opening part of the block '
form' tag and exposes
the form object name in the PageContext. |
getCssClass, getCssErrorClass, getCssStyle, getDir, getDynamicAttributes, getLang, getOnclick, getOndblclick, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getTabindex, getTitle, isValidDynamicAttribute, setCssClass, setCssStyle, setDir, setDynamicAttribute, setLang, setOnclick, setOndblclick, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setTabindex, setTitle, writeDefaultAttributes, writeOptionalAttributesconvertToDisplayString, getBindStatus, getBoundValue, getEditor, getId, getNestedPath, getPath, getPropertyEditor, getPropertyPath, processFieldValue, resolveId, setIdcreateTagWriter, doStartTagInternal, evaluate, getDisplayString, getDisplayString, isDefaultHtmlEscape, writeOptionalAttributeisHtmlEscape, setHtmlEscapedoCatch, doStartTag, getRequestContextdoAfterBody, findAncestorWithClass, getParent, getValue, getValues, release, removeValue, setPageContext, setParent, setValuepublic static final java.lang.String DEFAULT_COMMAND_NAME
public static final java.lang.String MODEL_ATTRIBUTE_VARIABLE_NAME
PageContext attribute under which the
form object name is exposed.public void setModelAttribute(java.lang.String modelAttribute)
May be a runtime expression.
protected java.lang.String getModelAttribute()
public void setCommandName(java.lang.String commandName)
May be a runtime expression.
setModelAttribute(java.lang.String)protected java.lang.String getCommandName()
getModelAttribute()public void setName(java.lang.String name)
name' attribute.
May be a runtime expression.
Name is not a valid attribute for form on XHTML 1.0. However, it is sometimes needed for backward compatibility.
protected java.lang.String getName()
throws JspException
name' attribute.getName in class AbstractDataBoundFormElementTagname' attributeJspExceptionpublic void setAction(java.lang.String action)
action' attribute.
May be a runtime expression.
protected java.lang.String getAction()
action' attribute.public void setServletRelativeAction(java.lang.String servletRelativeaction)
action' attribute.
May be a runtime expression.
protected java.lang.String getServletRelativeAction()
action' attribute.public void setMethod(java.lang.String method)
method' attribute.
May be a runtime expression.
protected java.lang.String getMethod()
method' attribute.public void setTarget(java.lang.String target)
target' attribute.
May be a runtime expression.
public java.lang.String getTarget()
target' attribute.public void setEnctype(java.lang.String enctype)
enctype' attribute.
May be a runtime expression.
protected java.lang.String getEnctype()
enctype' attribute.public void setAcceptCharset(java.lang.String acceptCharset)
acceptCharset' attribute.
May be a runtime expression.
protected java.lang.String getAcceptCharset()
acceptCharset' attribute.public void setOnsubmit(java.lang.String onsubmit)
onsubmit' attribute.
May be a runtime expression.
protected java.lang.String getOnsubmit()
onsubmit' attribute.public void setOnreset(java.lang.String onreset)
onreset' attribute.
May be a runtime expression.
protected java.lang.String getOnreset()
onreset' attribute.public void setAutocomplete(java.lang.String autocomplete)
autocomplete' attribute.
May be a runtime expression.protected java.lang.String getAutocomplete()
autocomplete' attribute.public void setMethodParam(java.lang.String methodParam)
protected java.lang.String getMethodParameter()
protected boolean isMethodBrowserSupported(java.lang.String method)
protected int writeTagContent(TagWriter tagWriter) throws JspException
form' tag and exposes
the form object name in the PageContext.writeTagContent in class AbstractFormTagtagWriter - the TagWriter to which the form content is to be writtenTag.EVAL_BODY_INCLUDEJspExceptionprotected java.lang.String autogenerateId()
throws JspException
autogenerateId in class AbstractDataBoundFormElementTagJspExceptionprotected java.lang.String resolveModelAttribute()
throws JspException
Resolves and returns the name of the form object.java.lang.IllegalArgumentException - if the form object resolves to nullJspExceptionprotected java.lang.String resolveAction()
throws JspException
action' attribute.
If the user configured an 'action' value then the result of
evaluating this value is used. If the user configured an
'servletRelativeAction' value then the value is prepended
with the context and servlet paths, and the result is used. Otherwise, the
originating URI is used.
action' attributeJspExceptionpublic int doEndTag()
throws JspException
form' block tag and removes the form object name
from the PageContext.doEndTag in interface TagdoEndTag in class TagSupportJspExceptionpublic void doFinally()
TagWriter.doFinally in interface TryCatchFinallydoFinally in class AbstractDataBoundFormElementTagprotected java.lang.String resolveCssClass()
throws JspException
resolveCssClass in class AbstractHtmlElementTagJspExceptionpublic void setPath(java.lang.String path)
setPath in class AbstractDataBoundFormElementTagjava.lang.UnsupportedOperationException - alwayspublic void setCssErrorClass(java.lang.String cssErrorClass)
setCssErrorClass in class AbstractHtmlElementTagjava.lang.UnsupportedOperationException - always