org.openmrs.web.taglib

Class OpenmrsRequestContextAwareBodyTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

javax.servlet.jsp.tagext.BodyTagSupport

org.openmrs.web.taglib.OpenmrsRequestContextAwareBodyTag

All Implemented Interfaces:

Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

Direct Known Subclasses:

OpenmrsHtmlEscapingAwareTag

public abstract class OpenmrsRequestContextAwareBodyTag
extends javax.servlet.jsp.tagext.BodyTagSupport

Similar to Spring's RequestContextAwareTag, but intended to support tag body handling on the basis of functionalities, provided by JSTL BodyTagSupport. Actually, it inherits additional convenience methods including getter methods for the bodyContent property and methods to get at the previous out JspWriter. May be considered as base class for all tags that require a RequestContext and aware on processing of tag body content.

With use of a RequestContext instance, you can get easy access to current state like the web application context, locale and so on.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	logger Logger available to subclasses

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

bodyContent

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

id, pageContext

Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

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

Constructors

Constructor and Description
OpenmrsRequestContextAwareBodyTag()

Method Summary

Modifier and Type	Method and Description
int	doEndTag() After tag body has been evaluated and buffered this creates and exposes the current RequestContext.
protected abstract int	doEndTagInternal() Called by doEndTag to perform the actual work.
int	doStartTag()
protected org.springframework.web.servlet.support.RequestContext	getRequestContext() Return the current RequestContext.

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

doAfterBody, doInitBody, getBodyContent, getPreviousOut, release, setBodyContent

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

findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.jsp.tagext.Tag

getParent, setPageContext, setParent

Field Detail

logger

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

Logger available to subclasses

Constructor Detail

OpenmrsRequestContextAwareBodyTag

public OpenmrsRequestContextAwareBodyTag()

Method Detail

doStartTag

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

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doStartTag in class javax.servlet.jsp.tagext.BodyTagSupport

Throws:

javax.servlet.jsp.JspException

See Also:

BodyTagSupport.doStartTag()

doEndTag

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

After tag body has been evaluated and buffered this creates and exposes the current RequestContext. Delegates to doEndTagInternal() for actual work.

Specified by:

doEndTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doEndTag in class javax.servlet.jsp.tagext.BodyTagSupport

Throws:

javax.servlet.jsp.JspException

getRequestContext

protected final org.springframework.web.servlet.support.RequestContext getRequestContext()

Return the current RequestContext.

doEndTagInternal

protected abstract int doEndTagInternal()
                                 throws Exception

Called by doEndTag to perform the actual work.

Returns:

same as BodyTagSupport.doEndTag

Throws:

Exception - any exception, any checked one other than a JspException gets wrapped in a JspException by doEndTag

See Also:

TagSupport.doEndTag()