Package com.microstrategy.web.app.taglibs

Class BaseTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

com.microstrategy.web.app.taglibs.AbstractNoBodyTag

com.microstrategy.web.app.taglibs.BaseTag

All Implemented Interfaces:

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

public class BaseTag
extends AbstractNoBodyTag

Since:

MicroStrategy Web 7.3.1 or earlier

See Also:

Serialized Form

Field Summary

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

id, pageContext

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
BaseTag()

Method Summary

Modifier and Type	Method	Description
AbstractNoBodyTagHelper	getHelper()	Retrieves the helper associated with the tag.
void	setAttribute(java.lang.String value)	Indicates the HTML tag attribute to create and to which the resource information value obtained will be assigned to.
void	setBundleName(java.lang.String value)	This is specific to the tags with type "jsbundle".
void	setDebugBundleName(java.lang.String value)	This is specific to the tags with type "jsbundle".
void	setLocation(java.lang.String value)	This is specific to the tags with type "javascript".
void	setName(java.lang.String value)	Indicates the name only (and any extra path information if necessary) of the file to which the resource path information will be added.
void	setType(java.lang.String value)	Indicates the type of resource folder information it will search for in order to complete the path information for the file specified.

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

doEndTag, doStartTag, release

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

doAfterBody, 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

Constructor Detail

BaseTag

public BaseTag()

Method Detail

getHelper

public AbstractNoBodyTagHelper getHelper()

Retrieves the helper associated with the tag.

Specified by:

getHelper in class AbstractNoBodyTag

Returns:

an instance from AbstractNoBodyTagHelper which will take care of processing and rendering the HTML contents associated with this tag.

setType

public void setType(java.lang.String value)

Indicates the type of resource folder information it will search for in order to complete the path information for the file specified.
Usage:
The possible values for this attribute include:

helpfile: The information to obtain will correspond to the location of the help file to be shown to the user image: The information to obtain will include the full resource path where the images are located. If the attribute value is not specified, it will default to obtain the image resource path. javascript: The information to obtain will include the full resource path where the javascript files are located. section: The information to obtain will correspond to the path and file name of the specified section on the PageComponent template. style: The information to obtain will include the full resource path where the style files are located. Some extra logic is executed for determining which one of the possible four resource paths should be used, depending on the environment from the user is calling the request. custom-style: The information to obtain will include the full resource path where custom style files are located. custom-javascript: The information to obtain will include the full resource path where custom javascript files are located.

Parameters:

value - String value with the type of resource folder to search for.

See Also:

BaseTag

setAttribute

public void setAttribute(java.lang.String value)

Indicates the HTML tag attribute to create and to which the resource information value obtained will be assigned to.
Usage:
Use this attribute whenever this tag is meant to be used inside another HTML tag. The HTML code generated by this custom tag will include only the attribute and assigning to it the value retrieved as resource information.
The following example shows how the src attribute is set on the script tag:

Parameters:

value - String with the name of the HTML tag attribute to create for the resource folder information.

setName

public void setName(java.lang.String value)

Indicates the name only (and any extra path information if necessary) of the file to which the resource path information will be added.
Usage:
In the case of images, styles and javascripts, this attribute specifies the name of the file to be used. The tag will take care of adding the path for being able to reach it. When using the type attribute set as section, it represents the name of the section on the template that is being requested.

Parameters:

value - String value with the name of the file to access, once the full path is defined by the resource folder information.

setLocation

public void setLocation(java.lang.String value)

This is specific to the tags with type "javascript". Indicates the location where the output will be added in the generated html when the resource manager is enabled
Usage:
When the resource manager is enabled, the javascript files are normally output at the bottom of the html page. Setting the location to "head" would generate this tag output within the head section of the html page.

Parameters:

value - String is either "head" or "tail". The default value is "tail".

Since:

MicroStrategy Web 9.0.0

setBundleName

public void setBundleName(java.lang.String value)

This is specific to the tags with type "jsbundle". Indicates which JavaScript bundle should be included in the page.
Usage:
When the corresponding debugFlag EnumWebAppDebugFlags is enabled, it will generate a group of "script" tags to include all the JavaScript files in the bundle individually.
Otherwise, the entire bundle file (which is compressed, and concatenated as a single .js file) will be included.

Parameters:

value - String the javascript bundle name, which must be defined in jsBundles.xml.

Since:

MicroStrategy Web 9.0.3

setDebugBundleName

public void setDebugBundleName(java.lang.String value)

This is specific to the tags with type "jsbundle". This tag will play a roll only when the When the corresponding debugFlag EnumWebAppDebugFlags is enabled, Indicates which JavaScript debug bundle should be included in the page.
Usage:
When the corresponding debugFlag EnumWebAppDebugFlags is enabled:
If the debugBundle is specifed with a bundle name, include the debugBundle instead of the default bundle.
If the debugBundle is not specified, include individual files in the default bundle.

Parameters:

value - String the javascript debug bundle name, which must be defined in jsBundles.xml.

Since:

MicroStrategy Web 9.0.3