Package com.microstrategy.web.app.taglibs

Class DisplayGuiComponentTag

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

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      AbstractNoBodyTagHelper getHelper()
      Method for retrieving the helper associated with the tag.
      void setDisplayMode​(java.lang.String value)
      set the display mode used as the DisplayGuiComponent renders
      void setIsContainer​(boolean value)
      Deprecated.
      The value for isContainer is set from PageConfig.xml
      void setName​(java.lang.String value)
      Indicates the name of the GUI Component that will be rendered.
      void setType​(java.lang.String value)
      Indicates the type of the GUI Component that will be rendered.

      • 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

      • DisplayGuiComponentTag

        public DisplayGuiComponentTag()

    • Method Detail

      • setDisplayMode

        public void setDisplayMode​(java.lang.String value)
        set the display mode used as the DisplayGuiComponent renders
        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

      • setName

        public void setName​(java.lang.String value)
        Indicates the name of the GUI Component that will be rendered.
        Usage:
        The GUI Component is defined based on a bean existing on the page. The value assigned to this attribute will be the GUI Component to search for getting it displayed to the user. If this attribute is not set, the GUI component will use the component specified in pageConfig.xml
        Parameters:
        value - String value with the name of the component to display.

      • setType

        public void setType​(java.lang.String value)
        Indicates the type of the GUI Component that will be rendered.
        Usage:
        By default, the type is 'bean', which means it will take the definition of a gui component from the page config file. The types available are: - bean - message
        Parameters:
        value - String value with the type of the component to display.
        Since:
        MicroStrategy Web 8.0.0

      • setIsContainer

        public void setIsContainer​(boolean value)
        Deprecated.
        The value for isContainer is set from PageConfig.xml