org.springframework.web.servlet.tags
Class RequestContextAwareTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      org.springframework.web.servlet.tags.RequestContextAwareTag

All Implemented Interfaces:

javax.servlet.jsp.tagext.IterationTag, java.io.Serializable, javax.servlet.jsp.tagext.Tag

Direct Known Subclasses:

BindErrorsTag, BindTag, MessageTag, TransformTag

public abstract class RequestContextAwareTag

extends javax.servlet.jsp.tagext.TagSupport

Superclass for all tags that require a RequestContext. The RequestContext instance provides easy access to current state like WebApplicationContext, Locale, Theme, etc.

Supports an HTML escaping setting per tag instance, overriding any default setting at the page or web.xml level.

Note: Only intended for DispatcherServlet requests!

Author:

Rod Johnson, Juergen Hoeller

See Also:

RequestContext, HtmlEscapeTag.setDefaultHtmlEscape(java.lang.String), HtmlEscapeTag.HTML_ESCAPE_CONTEXT_PARAM, Serialized Form

Field Summary

protected org.apache.commons.logging.Log

logger

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, 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

RequestContextAwareTag()

Method Summary

int	doStartTag() Create and set the current RequestContext.
protected int	doStartTagInternal() Called by doStartTag to perform the actual work.
protected RequestContext	getRequestContext() Return the current RequestContext.
protected boolean	isHtmlEscape() Returns the HTML escaping setting for this tag, or the default setting if not overridden.
void	setHtmlEscape(java.lang.String htmlEscape) Sets HTML escaping for this tag, overriding the default HTML escaping setting for the current page.

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

protected final org.apache.commons.logging.Log logger

Constructor Detail

RequestContextAwareTag

public RequestContextAwareTag()

Method Detail

setHtmlEscape

public final void setHtmlEscape(java.lang.String htmlEscape)

Sets HTML escaping for this tag, overriding the default HTML escaping setting for the current page.

See Also:

HtmlEscapeTag.setDefaultHtmlEscape(java.lang.String)

isHtmlEscape

protected final boolean isHtmlEscape()
                              throws javax.servlet.jsp.JspException

Returns the HTML escaping setting for this tag, or the default setting if not overridden.

Throws:

javax.servlet.jsp.JspException

getRequestContext

protected final RequestContext getRequestContext()

Return the current RequestContext.

doStartTag

public final int doStartTag()
                     throws javax.servlet.jsp.JspException

Create and set the current RequestContext. Delegates to doStartTagInternal for actual work.

Throws:

javax.servlet.jsp.JspException

doStartTagInternal

protected int doStartTagInternal()
                          throws java.lang.Exception

Called by doStartTag to perform the actual work.

Returns:

same as TagSupport.doStartTag

Throws:

java.lang.Exception - any exception, any checked one other than a JspException gets wrapped in a JspException by doStartTag

See Also:

TagSupport.doStartTag()