Package com.microstrategy.web.app.taglibs

Class IfFeatureTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

javax.servlet.jsp.tagext.BodyTagSupport

com.microstrategy.web.app.taglibs.AbstractIfTag

com.microstrategy.web.app.taglibs.IfFeatureTag

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

public class IfFeatureTag
extends AbstractIfTag

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

Method Summary

Modifier and Type	Method	Description
AbstractIfTagHelper	getHelper()	Method for retrieving the helper associated with the tag.
void	release()	Utility method for cleaning up the properties on the custom tag instance.
void	setEnum(boolean value)	Indicates if the information specified on the value tag is a constant definition on a class or enumeration.
void	setName(java.lang.String value)	Indicates the name of the feature to analyze, given the information specified on the other tag attributes.
void	setType(java.lang.String value)	Indicates the type of feature that will be analyzed.
void	setValue(java.lang.String value)	Indicates the value that will be compared against the information found on the feature.

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

doEndTag, doStartTag, getCondition

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

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

IfFeatureTag

public IfFeatureTag()

Method Detail

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

getHelper

public AbstractIfTagHelper getHelper()

Method for retrieving the helper associated with the tag.

Specified by:

getHelper in class AbstractIfTag

Returns:

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

setName

public void setName(java.lang.String value)

Indicates the name of the feature to analyze, given the information specified on the other tag attributes.
Usage:
The feature to look for specified on this attribute has to be a valid one on the environment specified with the type attribute, otherwise it will return False by default.

Parameters:

value - String value with the name of the feature to check for.

setType

public void setType(java.lang.String value)

Indicates the type of feature that will be analyzed.
Usage:
The list of valid values for this attribute include:

requestKey will look for the property name in the RequestKeys instance available browserSetting will look for the property name in the BrowserSettings instance available systemPreference will look for the property name in the Preferences instance available for System Preferences preference will look for the property name in the Preferences instance available for User Preferences config will look for the property name in the configuration parameters bean will look for the property name in all the beans defined in the configuration file. If not specified, the default will search in WebFeatures.

Parameters:

value - String type of object where the feature name will be searched on.

setValue

public void setValue(java.lang.String value)

Indicates the value that will be compared against the information found on the feature.
Usage:
If the feature to ask for returns a True/False result, then no value is required to specify for the tag.

Parameters:

value - String to use for comparing it against the feature value.

setEnum

public void setEnum(boolean value)

Indicates if the information specified on the value tag is a constant definition on a class or enumeration.
Usage:
If the property assigned to the value attribute is the package, class and constant name so the comparison should be performed with the value of this constant, instead of using the string as such, then this attribute value should be set to True. If it doesn't matter or does not need to be used, it can be ommited. This property is currently used when the type attribute is specified to get the feature value from RequestKeys.

Parameters:

value - String indicating if the value to use comes from an enumeration.