Package com.microstrategy.web.app.beans

Interface PageComponent

    • Field Detail

      • REMOVE_PAGE

        static final int REMOVE_PAGE
        Used by saveReturnToPage(int mode) to indicate the page link in the return to browser setting should be removed
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • STORE_PAGE

        static final int STORE_PAGE
        Used by saveReturnToPage(int mode) to add a page's link to the browser setting
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

    • Method Detail

      • setPageInfo

        void setPageInfo​(PageInfo page)
        This method sets the current PageInfo (the object with the current Page structure). The PageInfo should be the one used to create this component.
        Parameters:
        page - Page object

      • getPageInfo

        PageInfo getPageInfo()
        Returns:
        the current PageInfo (that holds the Page structure)

      • getContextMenuManager

        ContextMenuManager getContextMenuManager()
        Deprecated.
        This method is not used by the application and will be removed in future versions.
        Returns:
        The Page's ContextMenuManager

      • setErrorInfo

        void setErrorInfo​(AppBeanError error)
        Associates an AppBeanError with the page. If an error occurred during the page initialization/execution, this error should be set. It's responsibility of the display later (i.e., the JSP) to display this error to the end user.
        Parameters:
        error - The last error on this page. null if none happened

      • getErrorInfo

        AppBeanError getErrorInfo()
        Returns the last AppBeanError set to this page. If no errors have been associated to this page it returns null.
        Returns:
        the AppBeanError associated with the execution of the page.

      • setTitle

        void setTitle​(java.lang.String title)
        Define the alias that the page will display when called.
        Parameters:
        title - String with the title of the page. User setTitle

      • getTitle

        java.lang.String getTitle()
        Returns the pages's title.
        Returns:
        The title of this page

      • executeCollectDataRequiredAddons

        boolean executeCollectDataRequiredAddons​(WebComponent wc)
        Checks if the different addons associated with the WebComponent require a collect data to be performed.
        Parameters:
        wc - WebComponent instance that will have its addon methods called
        Returns:
        boolean value indicating if the collectData is required or not
        Since:
        MicroStrategy Web 8.0.0

      • executePreCollectDataAddons

        void executePreCollectDataAddons()
        Executes the addons on the page in the order in which they appear in the pageconfig file.
        Since:
        MicroStrategy Web 7.5.0

      • hasBinaryContent

        boolean hasBinaryContent()
        Returns:
        true if the page would generate binary content in it's output

      • getFontSize

        java.lang.String getFontSize()
        A string with the base font size to use, the string might contain the type of size (i.e, pt, px, etc.)
        Returns:
        a string with size of the font to use

      • getFontName

        java.lang.String getFontName()
        Returns a string with the name of the fonts, or the list of fonts that a browser should use when rendering the page. This is usually retrieved from user Preferences
        Returns:
        a String with a comma separated list of the fonts to use in this page.

      • getContactInfo

        java.lang.String getContactInfo()
        Returns the administrator contact info for this application.
        Returns:
        The admin contact info.

      • getTemplateFileName

        java.lang.String getTemplateFileName()
        Returns the name of a template file to redirect
        Returns:
        a file name.

      • setTemplateFileName

        void setTemplateFileName​(java.lang.String value)
        Sets the name of a template file to redirect
        Parameters:
        value - String value indicating the template file name to use.

      • executePostCollectDataAddons

        void executePostCollectDataAddons()
        Executes the post collect data addons on the page in the order in which they appear in the pageconfig file.
        Since:
        MicroStrategy Web 7.5.0

      • saveReturnToPage

        void saveReturnToPage​(int mode)
        Saves the information of the last visited page so it can be restored by the returnTo event.
        Parameters:
        mode - int value indicating the type of action that should be performed about the return to page information. Values includeSTORE_PAGE and REMOVE_PAGE.
        Since:
        MicroStrategy Web 8.0.0

      • processApplyChanges

        void processApplyChanges​(java.lang.String pageName)
                  throws WebException
        The method will be responsible for executing the apply events to those beans that require to so, when the page is about to change
        Parameters:
        pageName - The name of the new page
        Throws:
        WebException
        Since:
        MicroStrategy Web 8.0.0

      • saveLastPage

        void saveLastPage()
        Saves the information of the last succesful page so it can be restored by the cancel event.
        Since:
        MicroStrategy Web 8.0.0

      • setScreenMode

        void setScreenMode​(int screenMode)
        Set the screenMode of the page. Screen mode can be normal screen mode (screenMode = 1), full screen mode (screenMode = 2), or default to normal screen mode (screenMode = 0).
        Parameters:
        screenMode -
        Since:
        MicroStrategy Web 8.1.0

      • getScreenMode

        int getScreenMode()
        Return the current page screen mode.
        Returns:
        page screen mode.
        Since:
        MicroStrategy Web 8.1.0

      • setExplicitScreenMode

        void setExplicitScreenMode​(int screenMode)
        Use to set the explicit screen mode.
        Parameters:
        screenMode -
        Since:
        MicroStrategy Web 8.1.0

      • getExplicitScreenMode

        int getExplicitScreenMode()
        Returns:
        integer value representing the explicit screen mode selected
        Since:
        MicroStrategy Web 8.1.0

      • getResourceManagerMode

        int getResourceManagerMode()
        Returns the mode of the page manager set up on the page component. The values are defined in the PageResourceManager class
        Returns:
        the current mode of the page resource manager for this page.
        Since:
        MicroStrategy Web 9.0.0

      • isRedirect

        boolean isRedirect()
        Indicates if the page will be sent down as a redirect response (HTTP 302) instead of an ok response (HTTP 200)
        Returns:
        boolean value indicating if the the page will be displayed as a redirect (HTTP 302) response
        Since:
        MicroStrategy Web 9.0.1

      • setIsRedirect

        void setIsRedirect​(boolean redirect)
        Sets the page as a redirect response (HTTP 302) instead of an ok response (HTTP 200)
        Parameters:
        redirect - boolean value indicating if the the page will be displayed as a redirect (HTTP 302) response
        Since:
        MicroStrategy Web 9.0.1

      • getRedirectURL

        java.lang.String getRedirectURL()
        Returns the URL to be send down to the browser that corresponds to the page.
        Returns:
        a URL String
        Since:
        MicroStrategy Web 9.0.1

      • getXMLStatusPageName

        java.lang.String getXMLStatusPageName()
        Returns the name of the page in the Page Framework that will be displayed for the current page and xml status combination. This is defined at the template level in the pageConfig.xml file
        Returns:
        String. Page Name from pageConfig.xml

      • hasXMLStatusPage

        boolean hasXMLStatusPage()
        Returns true if a page in the Page Framework will be displayed for the current page and xml status combination. This is defined at the template level in the pageConfig.xml file
        Returns:
        true is a page Name has been defined in pageConfig.xml

      • isStagePage

        boolean isStagePage()
        Returns true if this page is just a stage page which acts as a bridge between two pages.
        Returns:
        true is this page is a stage page.

      • setStagePage

        void setStagePage​(boolean isStagePage)
        Sets the page as a stage page which acts as a bridge between two pages.
        Parameters:
        isStagePage - boolean value indicating if the the page is a stagePage.

      • switchPage

        void switchPage​(java.lang.String pageName,
                ServletWebComponent servletWebComponent)
         throws WebException,
                WebBeanException
        Replaces the current page in the Servlet with the indicated page
        Parameters:
        servletWebComponent -
        pageName - . Name of the new page to instantiate
        Throws:
        WebException - When it fails to redirects to the target page.
        WebBeanException

      • getDebugOut

        MarkupOutput getDebugOut​(int debugFlags)
        Get the Debug Information into the output
        Returns:
        an instance of MarkupOutput.
        Since:
        MicroStrategy Web 9.0.3

      • getDebugFlags

        int getDebugFlags()
        Get the decimal-format debug flags from the page
        Since:
        MicroStrategy Web 9.0.3

      • isRestoredFromPageHistory

        boolean isRestoredFromPageHistory()

      • setRestoredFromPageHistory

        void setRestoredFromPageHistory​(boolean value)

      • getLastMessageKey

        int getLastMessageKey()

      • getLastMsgID

        java.lang.String getLastMsgID()