Package com.microstrategy.web.app.taglibs

Class AbstractBodyTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

javax.servlet.jsp.tagext.BodyTagSupport

com.microstrategy.web.app.taglibs.AbstractBodyTag

All Implemented Interfaces:

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

Direct Known Subclasses:

AdvancedSearchLinkTag, ContextMenusTag, DynTableCellTag, DynTableTag, EventTag, Panel_PanelTag, ScriptletTag, ShortcutOptionsTag

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

This class can be used as base of the custom tags that consider the body when rendering the HTML. The custom tags that extend this class shall have defined a helper extending the AbstractBodyTagHelper class.

Since:

MicroStrategy Web 7.3.1 or earlier

See Also:

Serialized Form

Field Summary

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	Description
AbstractBodyTag()

Method Summary

Modifier and Type	Method	Description
int	doAfterBody()	This method is called after the JSP engine processes the body content of the tag.
int	doEndTag()	Called after the JSP engine finished processing the tag.
int	doStartTag()	Process the start tag for this instance.
abstract AbstractBodyTagHelper	getHelper()	Method for retrieving the helper related with the tag.
void	release()	Utility method for cleaning up the properties on the custom tag instance.

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

doInitBody, getBodyContent, getPreviousOut, 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

Constructor Detail

AbstractBodyTag

public AbstractBodyTag()

Method Detail

getHelper

public abstract AbstractBodyTagHelper getHelper()

Method for retrieving the helper related with the tag.

Returns:

An instance from AbstractBodyTagHelper which will take care of processing and rendering the HTML contents related with this tag.

release

public void release()

Utility method for cleaning up the properties on the custom tag instance.

Specified by:

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

Overrides:

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

doStartTag

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

Process the start tag for this instance. The doStartTag() method assumes that all setter methods have been invoked before.

Specified by:

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

Overrides:

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

Returns:

EVAL_BODY_BUFFERED if the tag wants to process body, SKIP_BODY if it does not want to process it.

Throws:

javax.servlet.jsp.JspException - if an error is risen when displaying the custom tag contents

javax.servlet.jsp.JspException - if an error is risen when displaying the custom tag contents

doAfterBody

public int doAfterBody()
                throws javax.servlet.jsp.JspException,
                       javax.servlet.jsp.JspException

This method is called after the JSP engine processes the body content of the tag. Not invoked in empty tags or in tags returning SKIP_BODY in doStartTag() This method is invoked after every body evaluation.

Specified by:

doAfterBody in interface javax.servlet.jsp.tagext.IterationTag

Overrides:

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

Returns:

EVAL_BODY_AGAIN if the JSP engine should evaluate the tag body again, otherwise return SKIP_BODY.

Throws:

javax.servlet.jsp.JspException - if an error is risen when displaying the custom tag contents

javax.servlet.jsp.JspException - if an error is risen when displaying the custom tag contents

doEndTag

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

Called after the JSP engine finished processing the tag. It's only objective is to clear up the tag after it has been rendered. If overwritten by a child instance, it should itself take care of calling the releaseTag() method.

Specified by:

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

Overrides:

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

Returns:

EVAL_PAGE if the JSP engine should continue evaluating the JSP page, otherwise return SKIP_PAGE.

Throws:

javax.servlet.jsp.JspException - if an error is risen when displaying the custom tag contents

javax.servlet.jsp.JspException - if an error is risen when displaying the custom tag contents