Package com.microstrategy.web.app.taglibs

Class AbstractBodyTagHelper

java.lang.Object

com.microstrategy.web.app.taglibs.CoreTagHelper

com.microstrategy.web.app.taglibs.MstrPageTagHelper

com.microstrategy.web.app.taglibs.AbstractBodyTagHelper

Direct Known Subclasses:

AdvancedSearchLinkTagHelper, ContextMenusTagHelper, DynTableCellTagHelper, DynTableTagHelper, EventTagHelper, PanelTagHelper, ScriptletTagHelper, ShortcutTagHelper

public abstract class AbstractBodyTagHelper
extends MstrPageTagHelper

This class can be used as base for the helpers of the custom tags that extend AbstractBodyTag since they consider the body when rendering the final HTML to show to the user.

Since:

MicroStrategy Web 7.3.1 or earlier

Field Summary

Fields inherited from class com.microstrategy.web.app.taglibs.MstrPageTagHelper

_mstrPage

Constructor Summary

Constructors

Constructor	Description
AbstractBodyTagHelper()

Method Summary

Modifier and Type	Method	Description
abstract MarkupOutput	getContentHead()	Obtains the contents to render before the tag's body.
abstract MarkupOutput	getContentTail()	Obtains the contents to render after the tag's body.
abstract boolean	isTagVisible()	Indicates if the tag is visible or not.
abstract boolean	shallRepeatTag()	Indicates if the content of the tag should be analyzed and displayed again or not.

Methods inherited from class com.microstrategy.web.app.taglibs.MstrPageTagHelper

cleanState, getContainerServices, newHiddenInputBuilder, newURIBuilder, resolveNumericAttribute, setPageComponent

Methods inherited from class com.microstrategy.web.app.taglibs.CoreTagHelper

getTagsFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractBodyTagHelper

public AbstractBodyTagHelper()

Method Detail

isTagVisible

public abstract boolean isTagVisible()

Indicates if the tag is visible or not. Some tags might implement special conditions for not to show them under certain circumstances.

Returns:

A boolean value indicating if the tag is visible or not

shallRepeatTag

public abstract boolean shallRepeatTag()

Indicates if the content of the tag should be analyzed and displayed again or not. Some tags might implement special conditions if they require to loop on a collection of objects for rendering each one of them.

Returns:

A boolean value indicating if the tag contents should be analyzed again or not.

getContentHead

public abstract MarkupOutput getContentHead()
                                     throws java.io.IOException

Obtains the contents to render before the tag's body.

Returns:

A MarkupOutput instance initialized with the contents to display

Throws:

java.io.IOException - if an error happens while getting the contents to render.

getContentTail

public abstract MarkupOutput getContentTail()
                                     throws java.io.IOException

Obtains the contents to render after the tag's body.

Returns:

a MarkupOutput instance initialized with the contents to display

Throws:

java.io.IOException - if an error happens while getting the contents to render.