Spring Framework

org.springframework.web.servlet.tags.form
Class AbstractDataBoundFormElementTag

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
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, EditorAwareTag
Direct Known Subclasses:
AbstractHtmlElementTag

public abstract class AbstractDataBoundFormElementTag
extends AbstractFormTag
implements EditorAwareTag

Base tag for all data-binding aware JSP form tags.

Provides the common path and id properties. Provides sub-classes with utility methods for accessing the BindStatus of their bound value and also for interacting with the TagWriter.

Since:
2.0
Author:
Rob Harrop, Juergen Hoeller
See Also:
Serialized Form

Field Summary
static java.lang.String COMMAND_NAME_VARIABLE_NAME
          Deprecated. as of Spring 2.5, in favor of FormTag.MODEL_ATTRIBUTE_VARIABLE_NAME
protected static java.lang.String NESTED_PATH_VARIABLE_NAME
          Name of the exposed path variable within the scope of this tag: "nestedPath".
 
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
AbstractDataBoundFormElementTag()
           
 
Method Summary
protected  java.lang.String autogenerateId()
          Autogenerate the 'id' attribute value for this tag.
protected  java.lang.String convertToDisplayString(java.lang.Object value)
          Get a display String for the given value, converted by a PropertyEditor that the BindStatus may have registered for the value's Class.
 void doFinally()
          Disposes of the BindStatus instance.
protected  BindStatus getBindStatus()
          Get the BindStatus for this tag.
protected  java.lang.Object getBoundValue()
          Get the bound value.
 java.beans.PropertyEditor getEditor()
          Exposes the PropertyEditor for EditorAwareTag.
 java.lang.String getId()
          Get the value of the 'id' attribute.
protected  java.lang.String getName()
          Get the value for the HTML 'name' attribute.
protected  java.lang.String getNestedPath()
          Get the value of the nested path that may have been exposed by the NestedPathTag.
protected  java.lang.String getPath()
          Get the resolved property path for the form object.
protected  java.beans.PropertyEditor getPropertyEditor()
          Get the PropertyEditor, if any, in use for value bound to this tag.
protected  java.lang.String getPropertyPath()
          Build the property path for this tag, including the nested path but not prefixed with the name of the form attribute.
protected  java.lang.String processFieldValue(java.lang.String name, java.lang.String value, java.lang.String type)
          Process the given form field through a RequestDataValueProcessor instance if one is configured or otherwise returns the same value.
protected  java.lang.String resolveId()
          Determine the 'id' attribute value for this tag, autogenerating one if none specified.
 void setId(java.lang.String id)
          Set the value of the 'id' attribute.
 void setPath(java.lang.String path)
          Set the property path from the form object.
protected  void writeDefaultAttributes(TagWriter tagWriter)
          Writes the default set of attributes to the supplied TagWriter.
 
Methods inherited from class org.springframework.web.servlet.tags.form.AbstractFormTag
createTagWriter, doStartTagInternal, evaluate, evaluateBoolean, getDisplayString, getDisplayString, isDefaultHtmlEscape, writeOptionalAttribute, writeTagContent
 
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, doEndTag, 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
 

Field Detail

NESTED_PATH_VARIABLE_NAME

protected static final java.lang.String NESTED_PATH_VARIABLE_NAME
Name of the exposed path variable within the scope of this tag: "nestedPath". Same value as NestedPathTag.NESTED_PATH_VARIABLE_NAME.

See Also:
Constant Field Values

COMMAND_NAME_VARIABLE_NAME

@Deprecated
public static final java.lang.String COMMAND_NAME_VARIABLE_NAME
Deprecated. as of Spring 2.5, in favor of FormTag.MODEL_ATTRIBUTE_VARIABLE_NAME
The name of the PageContext attribute under which the command object name is exposed.

Constructor Detail

AbstractDataBoundFormElementTag

public AbstractDataBoundFormElementTag()
Method Detail

setPath

public void setPath(java.lang.String path)
Set the property path from the form object. May be a runtime expression.


getPath

protected final java.lang.String getPath()
                                  throws javax.servlet.jsp.JspException
Get the resolved property path for the form object.

Throws:
javax.servlet.jsp.JspException

setId

public void setId(java.lang.String id)
Set the value of the 'id' attribute.

May be a runtime expression; defaults to the value of getName(). Note that the default value may not be valid for certain tags.

Overrides:
setId in class javax.servlet.jsp.tagext.TagSupport

getId

public java.lang.String getId()
Get the value of the 'id' attribute.

Overrides:
getId in class javax.servlet.jsp.tagext.TagSupport

writeDefaultAttributes

protected void writeDefaultAttributes(TagWriter tagWriter)
                               throws javax.servlet.jsp.JspException
Writes the default set of attributes to the supplied TagWriter. Further abstract sub-classes should override this method to add in any additional default attributes but must remember to call the super method.

Concrete sub-classes should call this method when/if they want to render default attributes.

Parameters:
tagWriter - the TagWriter to which any attributes are to be written
Throws:
javax.servlet.jsp.JspException

resolveId

protected java.lang.String resolveId()
                              throws javax.servlet.jsp.JspException
Determine the 'id' attribute value for this tag, autogenerating one if none specified.

Throws:
javax.servlet.jsp.JspException
See Also:
getId(), autogenerateId()

autogenerateId

protected java.lang.String autogenerateId()
                                   throws javax.servlet.jsp.JspException
Autogenerate the 'id' attribute value for this tag.

The default implementation simply delegates to getName(), deleting invalid characters (such as "[" or "]").

Throws:
javax.servlet.jsp.JspException

getName

protected java.lang.String getName()
                            throws javax.servlet.jsp.JspException
Get the value for the HTML 'name' attribute.

The default implementation simply delegates to getPropertyPath() to use the property path as the name. For the most part this is desirable as it links with the server-side expectation for data binding. However, some subclasses may wish to change the value of the 'name' attribute without changing the bind path.

Returns:
the value for the HTML 'name' attribute
Throws:
javax.servlet.jsp.JspException

getBindStatus

protected BindStatus getBindStatus()
                            throws javax.servlet.jsp.JspException
Get the BindStatus for this tag.

Throws:
javax.servlet.jsp.JspException

getNestedPath

protected java.lang.String getNestedPath()
Get the value of the nested path that may have been exposed by the NestedPathTag.


getPropertyPath

protected java.lang.String getPropertyPath()
                                    throws javax.servlet.jsp.JspException
Build the property path for this tag, including the nested path but not prefixed with the name of the form attribute.

Throws:
javax.servlet.jsp.JspException
See Also:
getNestedPath(), getPath()

getBoundValue

protected final java.lang.Object getBoundValue()
                                        throws javax.servlet.jsp.JspException
Get the bound value.

Throws:
javax.servlet.jsp.JspException
See Also:
getBindStatus()

getPropertyEditor

protected java.beans.PropertyEditor getPropertyEditor()
                                               throws javax.servlet.jsp.JspException
Get the PropertyEditor, if any, in use for value bound to this tag.

Throws:
javax.servlet.jsp.JspException

getEditor

public final java.beans.PropertyEditor getEditor()
                                          throws javax.servlet.jsp.JspException
Exposes the PropertyEditor for EditorAwareTag.

Use getPropertyEditor() for internal rendering purposes.

Specified by:
getEditor in interface EditorAwareTag
Returns:
the current PropertyEditor, or null if none
Throws:
javax.servlet.jsp.JspException - if resolving the editor failed

convertToDisplayString

protected java.lang.String convertToDisplayString(java.lang.Object value)
                                           throws javax.servlet.jsp.JspException
Get a display String for the given value, converted by a PropertyEditor that the BindStatus may have registered for the value's Class.

Throws:
javax.servlet.jsp.JspException

processFieldValue

protected final java.lang.String processFieldValue(java.lang.String name,
                                                   java.lang.String value,
                                                   java.lang.String type)
Process the given form field through a RequestDataValueProcessor instance if one is configured or otherwise returns the same value.


doFinally

public void doFinally()
Disposes of the BindStatus instance.

Specified by:
doFinally in interface javax.servlet.jsp.tagext.TryCatchFinally
Overrides:
doFinally in class RequestContextAwareTag

Spring Framework