Class AbstractNoBodyTag
- java.lang.Object
-
- javax.servlet.jsp.tagext.TagSupport
-
- com.microstrategy.web.app.taglibs.AbstractNoBodyTag
-
- All Implemented Interfaces:
java.io.Serializable
,javax.servlet.jsp.tagext.IterationTag
,javax.servlet.jsp.tagext.JspTag
,javax.servlet.jsp.tagext.Tag
- Direct Known Subclasses:
BaseTag
,BeanValueTag
,BundleDescriptorTag
,ClientSideDescriptorTag
,ConnectionValueTag
,DebugFlagsTag
,DisplayBeanTag
,DisplayCookiesTag
,DisplayGuiComponentTag
,ErrorValueTag
,ExportSetContentTypeTag
,JavaScriptTag
,JuilElementTag
,LicensingInfoTag
,LoggingTag
,MetaContentTypeTag
,ObjectPathTag
,PageStateTag
,PerformanceStringTag
,PerformanceTimerTag
,PreferenceValueTag
,PurgeCachesTag
,QuickSearchTag
,RequestStringTag
,ResourceFeedNameTag
,ResourceMgrTag
,ReturnToPathTag
,ReturnToTag
,RunTimeDiagnosticsTag
,ScriptPageStateTag
,ShowDebugInfoTag
,StringTag
,TaskProcessorNameTag
,UpdateManagerTag
,ValueTag
,WaitTag
public abstract class AbstractNoBodyTag extends javax.servlet.jsp.tagext.TagSupport
This class can be used as base of the custom tags that do not display any body content while rendering the final HTML. The custom tags that extend this class shall have defined a helper extending theAbstractNoBodyTagHelper
class.- Since:
- MicroStrategy Web 7.3.1 or earlier
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description AbstractNoBodyTag()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description int
doEndTag()
Called after the JSP engine finished processing the tag.int
doStartTag()
Process the start tag for this instance.abstract AbstractNoBodyTagHelper
getHelper()
Method for retrieving the helper related with the tag.void
release()
Utility method for cleaning up the properties on the custom tag instance.
-
-
-
Method Detail
-
getHelper
public abstract AbstractNoBodyTagHelper getHelper()
Method for retrieving the helper related with the tag.- Returns:
- an instance from
AbstractNoBodyTagHelper
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 interfacejavax.servlet.jsp.tagext.Tag
- Overrides:
release
in classjavax.servlet.jsp.tagext.TagSupport
-
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 interfacejavax.servlet.jsp.tagext.Tag
- Overrides:
doStartTag
in classjavax.servlet.jsp.tagext.TagSupport
- Returns:
- SKIP_BODY since it does not want to process or display it.
- Throws:
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 interfacejavax.servlet.jsp.tagext.Tag
- Overrides:
doEndTag
in classjavax.servlet.jsp.tagext.TagSupport
- 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
-
-