Package com.microstrategy.web.app.taglibs

Class StringTag

  • All Implemented Interfaces:
    java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag
    public class StringTag
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
      StringTag()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      AbstractNoBodyTagHelper getHelper()
      Method for retrieving the helper associated with the tag.
      void setAttribute​(java.lang.String value)
      Indicates the HTML attribute to create which will have as value the string found on the Messages collection corresponding to the given key.
      void setBeanType​(java.lang.String value)
      Indicates the type of bean that will be used as base for getting the descriptor to display based on the type attribute defined for the tag.
      void setDesc​(java.lang.String value)
      Indicates an alternative description to use if the key is not specified.
      void setJsEncode​(boolean value)
      Indicates if the output to render should be encoded for Javascript or not.
      void setKey​(java.lang.String value)
      Indicates the key of the localized string that will be displayed, according to the user's settings.
      void setReplaceValue​(java.lang.String value)
      Indicates if the ## string found in the localized message should be replaced by another given string value.
      void setType​(java.lang.String value)
      Indicates the type of descriptor that will be displayed by this tag.
      void setUcase​(boolean value)
      Indicates if the localized string to display should be changed to all upper case font.

      • 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

      • StringTag

        public StringTag()

    • Method Detail

      • setKey

        public void setKey​(java.lang.String value)
        Indicates the key of the localized string that will be displayed, according to the user's settings.
        Parameters:
        value - String with the key of the descriptor to display.

      • setDesc

        public void setDesc​(java.lang.String value)
        Indicates an alternative description to use if the key is not specified.
        Parameters:
        value - String to display if the key is not found.

      • setUcase

        public void setUcase​(boolean value)
        Indicates if the localized string to display should be changed to all upper case font.
        Parameters:
        value - boolean indicating if the string should be changed to upper case font.

      • setReplaceValue

        public void setReplaceValue​(java.lang.String value)
        Indicates if the ## string found in the localized message should be replaced by another given string value.
        Usage:
        If this attribute is specified, the original string that was found given the key will have the ## occurences (if any found) replaced by the text exactly as specified on this attribute.
        Parameters:
        value - String value with the text that should be used to replace the ## characters (if any).

      • setAttribute

        public void setAttribute​(java.lang.String value)
        Indicates the HTML attribute to create which will have as value the string found on the Messages collection corresponding to the given key.
        Usage:
        An HTML tag defined as this:
         <IMG <web:resource attribute="SRC" name="desktop_HistoryList.gif" WIDTH="60" HEIGHT="60" <web:descriptor attribute="ALT" key="mstrWeb.4" desc="History List" /> BORDER="0" />
        Will generate this final HTML output:
        <IMG SRC="../images/desktop_HistoryList.gif" WIDTH="60" HEIGHT="60" ALT="History List" BORDER="0" />
        Parameters:
        value - String with the name of the HTML tag attribute to create.

      • setType

        public void setType​(java.lang.String value)
        Indicates the type of descriptor that will be displayed by this tag.
        Usage:
        Currently, this attribute should be used together with beanType. The possible values for this attribute include:
      • status
Parameters:
value - String
Parameters:
value - String indicating the bean type to use for getting the key to display.