Package com.microstrategy.web.app.taglibs

Class DisplayGuiComponentTagHelper

    • Constructor Detail

      • DisplayGuiComponentTagHelper

        public DisplayGuiComponentTagHelper()

    • 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

      • getContent

        public MarkupOutput getContent()
                        throws java.io.IOException
        Obtains the contents to render based on the attributes 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.

      • setDisplayMode

        public void setDisplayMode​(java.lang.String value)
        set the display mode used when the GuiComponent renders itself
        Parameters:
        value - String the display mode: AppContext.DISPLAY_MODE_HTML - plain HTML AppContext.DISPLAY_MODE_JSON - the output will be wrapped up in a json structure in form of {id: id of the component, content: html content to be updated} or {id: if of the component, components: sub json blocks}
        Since:
        MicroStrategy Web 9.0.1

      • getDisplayMode

        public java.lang.String getDisplayMode()
        get the display mode used when the GuiComponent renders itself
        Returns:
        the display mode
        Since:
        MicroStrategy Web 9.0.1

      • setName

        public void setName​(java.lang.String value)
        Sets the value assigned to the name attribute of the custom tag instance that uses this helper
        Parameters:
        value - String with the name of the GUI Component to render

      • 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 the GUI Component to render
        Since:
        MicroStrategy Web 8.0.0

      • setIsContainer

        public void setIsContainer​(boolean value)
        Deprecated.
        No references to this method. pageConfig.xml defines the value for _isContainer
        Set the value assigned to the isContainer attribute of the custom tag instance that uses this helper
        Parameters:
        value - boolean indicating if the GUI Component is a container or not