Package com.microstrategy.web.app.taglibs

Class StringTagHelper

    • Constructor Summary

      Constructors 
      Constructor Description
      StringTagHelper()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void cleanState()
      Resets the state of the tag library, by cleaning the values of the properties initialized for this tag.
      MarkupOutput getContent()
      Obtaisn the contents to render based on the attributes that have been defined (if existing).
      void setAttribute​(java.lang.String value)
      Sets the value assigned to the attribute attribute of the custom tag instance that uses this helper
      void setBeanType​(java.lang.String value)
      Sets the value assigned to the beanType attribute of the custom tag instance that uses this helper
      void setDesc​(java.lang.String value)
      Sets the value assigned to the desc attribute of the custom tag instance that uses this helper
      void setJsEncode​(boolean value)
      Sets the value assigned to the jsEncode attribute of the custom tag instance.
      void setKey​(java.lang.String value)
      Sets the value assigned to the key attribute of the custom tag instance that uses this helper
      void setPageComponent​(PageComponent mstrPage)
      Sets the PageComponent instance that will be used as base for the tag when generating the HTML to return to the user.
      void setReplaceValue​(java.lang.String value)
      Sets the value assigned to the replaceValue attribute of the custom tag instance that uses this helper
      void setType​(java.lang.String value)
      Sets the value assigned to the type attribute of the custom tag instance that uses this helper
      void setUcase​(boolean value)
      Sets the value assigned to the ucase attribute of the custom tag instance that uses this helper

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • StringTagHelper

        public StringTagHelper()

    • Method Detail

      • cleanState

        public void cleanState()
        Resets the state of the tag library, by cleaning the values of the properties initialized for this tag.
        Overrides:
        cleanState in class MstrPageTagHelper

      • setPageComponent

        public void setPageComponent​(PageComponent mstrPage)
        Sets the PageComponent instance that will be used as base for the tag when generating the HTML to return to the user.
        Overrides:
        setPageComponent in class MstrPageTagHelper
        Parameters:
        mstrPage - PageComponent instance corresponding to the page to be shown to the user as a result of his request.

      • getContent

        public MarkupOutput getContent()
                        throws java.io.IOException
        Obtaisn the contents to render based on the attributes that have been defined (if existing).
        Specified by:
        getContent in class AbstractNoBodyTagHelper
        Returns:
        a MarkupOutput instance initialized with the contents to display
        Throws:
        java.io.IOException - if an error happens while getting the contents to render.

      • setKey

        public void setKey​(java.lang.String value)
        Sets the value assigned to the key attribute of the custom tag instance that uses this helper
        Parameters:
        value - String with the key to search for.

      • setDesc

        public void setDesc​(java.lang.String value)
        Sets the value assigned to the desc attribute of the custom tag instance that uses this helper
        Parameters:
        value - String with an alternative description to use if the key is not found.

      • setUcase

        public void setUcase​(boolean value)
        Sets the value assigned to the ucase attribute of the custom tag instance that uses this helper
        Parameters:
        value - boolean indicating if the descriptor should be changed to be all upper case font.

      • setReplaceValue

        public void setReplaceValue​(java.lang.String value)
        Sets the value assigned to the replaceValue attribute of the custom tag instance that uses this helper
        Parameters:
        value - String to use for replacing the ## substring in the descriptor, if any are found.

      • setAttribute

        public void setAttribute​(java.lang.String value)
        Sets the value assigned to the attribute attribute of the custom tag instance that uses this helper
        Parameters:
        value - String indicating the name of the HTML attribute tag value to create with the descriptor found as value.

      • setType

        public void setType​(java.lang.String value)
        Sets the value assigned to the type attribute of the custom tag instance that uses this helper
        Parameters:
        value - String with the type of descriptor to be displayed.

      • setBeanType

        public void setBeanType​(java.lang.String value)
        Sets the value assigned to the beanType attribute of the custom tag instance that uses this helper
        Parameters:
        value - String with the type of bean to use for getting the descriptor to display.

      • setJsEncode

        public void setJsEncode​(boolean value)
        Sets the value assigned to the jsEncode attribute of the custom tag instance.
        Parameters:
        value - boolean indicating if the content to display should be javascript encoded
        Since:
        MicroStrategy Web 9.0.1