HDIV API 2.0.4

org.hdiv.web.servlet.tags.form
Class FormTagHDIV

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by org.springframework.web.servlet.tags.RequestContextAwareTag
          extended by org.springframework.web.servlet.tags.HtmlEscapingAwareTag
              extended by org.springframework.web.servlet.tags.form.AbstractFormTag
                  extended by org.springframework.web.servlet.tags.form.AbstractDataBoundFormElementTag
                      extended by org.springframework.web.servlet.tags.form.AbstractHtmlElementTag
                          extended by org.springframework.web.servlet.tags.form.FormTag
                              extended by org.hdiv.web.servlet.tags.form.FormTagHDIV
All Implemented Interfaces:
java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag, javax.servlet.jsp.tagext.TryCatchFinally

public class FormTagHDIV
extends org.springframework.web.servlet.tags.form.FormTag

Databinding-aware JSP tag for rendering an HTML 'form' whose inner elements are bound to properties on a command object.

Users should place the command object into the ModelAndView when populating the data for their view. The name of this command object can be configured using the commandName property.

The default value for the commandName property is 'command' which corresponds to the default name when using the org.springframework.web.servlet.mvc.SimpleFormController.

Inner tags can access the name of the command object via the PageContext. The attribute name is defined in AbstractDataBoundFormElementTag.COMMAND_NAME_VARIABLE_NAME.

Since:
HDIV 2.0
Author:
Gorka Vicente
See Also:
FormTag, Serialized Form

Field Summary
 
Fields inherited from class org.springframework.web.servlet.tags.form.FormTag
ACTION_ATTRIBUTE, DEFAULT_COMMAND_NAME, ENCTYPE_ATTRIBUTE, METHOD_ATTRIBUTE, NAME_ATTRIBUTE, ONRESET_ATTRIBUTE, ONSUBMIT_ATTRIBUTE
 
Fields inherited from class org.springframework.web.servlet.tags.form.AbstractHtmlElementTag
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_ATTRIBUTE
 
Fields inherited from class org.springframework.web.servlet.tags.form.AbstractDataBoundFormElementTag
COMMAND_NAME_ATTRIBUTE, COMMAND_NAME_VARIABLE_NAME, ID_ATTRIBUTE
 
Fields inherited from class org.springframework.web.servlet.tags.RequestContextAwareTag
logger, REQUEST_CONTEXT_PAGE_ATTRIBUTE
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
pageContext
 
Fields inherited from interface javax.servlet.jsp.tagext.IterationTag
EVAL_BODY_AGAIN
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
FormTagHDIV()
           
 
Method Summary
 void addExtraParameters()
          Añade nuevos parámetros al formulario que no han sido definidos mediante tags de HTML.
protected  void addHDIVParameter()
          Adds HDIV state as parameter.
protected  java.lang.String composeQueryString(java.lang.String queryString)
          Removes HDIV parameter from queryString and it composes other parameters.
 int doEndTag()
          Closes the 'form' block tag and removes the command name from the PageContext.
protected  java.lang.String generateHiddenTag(java.lang.String name, java.lang.String requestId)
          Renders an HTML <input> element of type hidden.
 org.hdiv.dataComposer.IDataComposer getDataComposer()
           
 org.springframework.web.servlet.tags.form.TagWriter getTagWriter()
           
protected  boolean ignoreParameter(java.lang.String param)
           
protected  java.lang.String resolveAction()
          Resolve the value of the 'action' attribute.
protected  int writeTagContent(org.springframework.web.servlet.tags.form.TagWriter tagWriter)
          Writes the opening part of the block 'form' tag and exposes the command name in the PageContext.
 
Methods inherited from class org.springframework.web.servlet.tags.form.FormTag
autogenerateId, doFinally, getAction, getCommandName, getEnctype, getMethod, getName, getOnreset, getOnsubmit, resolveCommandName, resolveCssClass, setAction, setCommandName, setCssErrorClass, setEnctype, setMethod, setName, setOnreset, setOnsubmit, setPath
 
Methods inherited from class org.springframework.web.servlet.tags.form.AbstractHtmlElementTag
getCssClass, getCssErrorClass, getCssStyle, getDir, getLang, getOnclick, getOndblclick, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getTabindex, getTitle, setCssClass, setCssStyle, setDir, setLang, setOnclick, setOndblclick, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setTabindex, setTitle, writeDefaultAttributes
 
Methods inherited from class org.springframework.web.servlet.tags.form.AbstractDataBoundFormElementTag
getBindStatus, getBoundValue, getCompletePath, getId, getNestedPath, getPath, getPropertyEditor, setId
 
Methods inherited from class org.springframework.web.servlet.tags.form.AbstractFormTag
createTagWriter, doStartTagInternal, evaluate, getDisplayString, getDisplayString, writeOptionalAttribute
 
Methods inherited from class org.springframework.web.servlet.tags.HtmlEscapingAwareTag
isHtmlEscape, setHtmlEscape
 
Methods inherited from class org.springframework.web.servlet.tags.RequestContextAwareTag
doCatch, doStartTag, getRequestContext
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, findAncestorWithClass, getParent, getValue, getValues, release, removeValue, setPageContext, setParent, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FormTagHDIV

public FormTagHDIV()
Method Detail

writeTagContent

protected int writeTagContent(org.springframework.web.servlet.tags.form.TagWriter tagWriter)
                       throws javax.servlet.jsp.JspException
Writes the opening part of the block 'form' tag and exposes the command name in the PageContext.

Overrides:
writeTagContent in class org.springframework.web.servlet.tags.form.FormTag
Parameters:
tagWriter - the TagWriter to which the form content is to be written
Returns:
Tag.EVAL_BODY_INCLUDE
Throws:
javax.servlet.jsp.JspException

resolveAction

protected java.lang.String resolveAction()
                                  throws javax.servlet.jsp.JspException
Resolve the value of the 'action' attribute.

If the user configured an 'action' value then the result of evaluating this value is used. Otherwise, the originating URI is used.

Overrides:
resolveAction in class org.springframework.web.servlet.tags.form.FormTag
Returns:
the value that is to be used for the 'action' attribute
Throws:
javax.servlet.jsp.JspException

composeQueryString

protected java.lang.String composeQueryString(java.lang.String queryString)
Removes HDIV parameter from queryString and it composes other parameters.

Parameters:
queryString - query string
Returns:
queryString without HDIV's parameter

ignoreParameter

protected boolean ignoreParameter(java.lang.String param)

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException
Closes the 'form' block tag and removes the command name from the PageContext.

Specified by:
doEndTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doEndTag in class org.springframework.web.servlet.tags.form.FormTag
Throws:
javax.servlet.jsp.JspException

addExtraParameters

public void addExtraParameters()
                        throws javax.servlet.jsp.JspException
Añade nuevos parámetros al formulario que no han sido definidos mediante tags de HTML.

Throws:
javax.servlet.jsp.JspException

addHDIVParameter

protected void addHDIVParameter()
                         throws javax.servlet.jsp.JspException
Adds HDIV state as parameter.

Throws:
javax.servlet.jsp.JspException

generateHiddenTag

protected java.lang.String generateHiddenTag(java.lang.String name,
                                             java.lang.String requestId)
Renders an HTML <input> element of type hidden.

Parameters:
name - hidden parameter name
requestId - request identification
Returns:
HTML <input> element of type hidden

getDataComposer

public org.hdiv.dataComposer.IDataComposer getDataComposer()

getTagWriter

public org.springframework.web.servlet.tags.form.TagWriter getTagWriter()
Returns:
the tag writer

HDIV 2.0.4

Copyright © 2008 hdiv.org. All Rights Reserved.