Package com.microstrategy.web.app.taglibs

Class ScriptletTagHelper

java.lang.Object

com.microstrategy.web.app.taglibs.CoreTagHelper

com.microstrategy.web.app.taglibs.MstrPageTagHelper

com.microstrategy.web.app.taglibs.AbstractBodyTagHelper

com.microstrategy.web.app.taglibs.ScriptletTagHelper

public class ScriptletTagHelper
extends AbstractBodyTagHelper

Helper for the ScriptletTag tag library.

Since:

MicroStrategy Web 9.0.0

Field Summary

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

_mstrPage

Constructor Summary

Constructors

Constructor	Description
ScriptletTagHelper()

Method Summary

Modifier and Type	Method	Description
MarkupOutput	getContentHead()	Obtains the contents to render before the tag's body.
MarkupOutput	getContentTail()	Obtains the contents to render after the tag's body.
boolean	isTagVisible()	Indicates if the tag is visible or not.
void	setContent(java.lang.String content)	Set the body content of the tag.
boolean	shallRepeatTag()	Indicates if the content of the tag should be analyzed and displayed again or not.
boolean	shouldRenderChildren()	Returns true if the children need to be rendered

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

ScriptletTagHelper

public ScriptletTagHelper()

Method Detail

getContentHead

public MarkupOutput getContentHead()
                            throws java.io.IOException

Description copied from class: AbstractBodyTagHelper

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

Specified by:

getContentHead in class AbstractBodyTagHelper

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 MarkupOutput getContentTail()
                            throws java.io.IOException

Description copied from class: AbstractBodyTagHelper

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

Specified by:

getContentTail in class AbstractBodyTagHelper

Returns:

a MarkupOutput instance initialized with the contents to display

Throws:

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

isTagVisible

public boolean isTagVisible()

Description copied from class: AbstractBodyTagHelper

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

Specified by:

isTagVisible in class AbstractBodyTagHelper

Returns:

A boolean value indicating if the tag is visible or not

shallRepeatTag

public boolean shallRepeatTag()

Description copied from class: AbstractBodyTagHelper

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.

Specified by:

shallRepeatTag in class AbstractBodyTagHelper

Returns:

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

setContent

public void setContent(java.lang.String content)

Set the body content of the tag. It should be called when the shouldRenderChildren() returns false

Parameters:

content - - the string content of the body of the tag.

shouldRenderChildren

public boolean shouldRenderChildren()

Returns true if the children need to be rendered