Package com.microstrategy.web.app.taglibs

Class WaitTagHelper

    • Constructor Detail

      • WaitTagHelper

        public WaitTagHelper()

    • 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

      • getWebBean

        protected ResultSetBean getWebBean()
        Returns instance of current bean being processed, either a RWBean or ReportBean.
        Due to the fact that this class is shared by both beans, we need to come up with one generic function that returns an instance of the ResultSetBean class which is parent interface of both RWBean and ReportBean.
        Returns:
        a ResultSetBean instance with the bean to be processed.
        Since:
        MicroStrategy Web 8.0.0

      • getInboxEvent

        protected WebEvent getInboxEvent()
        Specifies the Inbox event to be used for rendering corresponding HTML button.
        The Inbox event to return will be any of the following, depending on the type of bean (either RWBean or ReportBean):
          EnumReportBeanEvents.REPORT_EVENT_SAVE_TO_INBOX EnumRWBeanEvents.REPORT_WRITER_EVENT_SAVE_TO_INBOX
        Returns:
        a WebEvent instance either a RWBean or ReportBean event.
        Since:
        MicroStrategy Web 8.0.0

      • getCancelEvent

        protected WebEvent getCancelEvent()
        Specifies Cancel event to be used for rendering corresponding HTML button.
        It will call function getWebBean and depending on whether given ResultSetBean instance is an RWBean or ReportBean; the Inbox event to return will be any of the following:
          EnumReportBeanEvents.REPORT_EVENT_CANCEL_REQUEST EnumRWBeanEvents.REPORT_WRITER_EVENT_CANCEL_REQUEST
        Returns:
        a WebEvent instance either a RWBean or ReportBean event.
        Since:
        MicroStrategy Web 8.0.0

      • getInboxSource

        protected WebInboxSource getInboxSource()
        Specifies the Inbox source object.
        Returns:
        a WebInboxSource instance.
        Since:
        MicroStrategy Web 8.0.0

      • getWebBeanMssgId

        protected java.lang.String getWebBeanMssgId()
                                     throws java.lang.Exception
        Specifies the current WebBean message ID.
        Returns:
        a String with the message ID for the corersponding report or rw document.
        Throws:
        java.lang.Exception
        Since:
        MicroStrategy Web 8.0.0

      • 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.

      • 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 indicating the type of wait content to render.

      • setFlags

        public void setFlags​(int value)
        Parameters:
        value -
        Since:
        MicroStrategy Web 8.1.0

      • 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}
        Since:
        MicroStrategy Web 9.0.1