Package com.microstrategy.web.app.beans

Class DocumentPageComponentImpl

    • Field Detail

      • _title

        protected java.lang.String _title

      • _titleId

        protected java.lang.String _titleId

    • Constructor Detail

      • DocumentPageComponentImpl

        public DocumentPageComponentImpl()

    • Method Detail

      • setPageInfo

        public void setPageInfo​(PageInfo page)
        This method sets the current Page (the object with the current Page structure)
        Specified by:
        setPageInfo in interface PageComponent
        Parameters:
        page - Page object

      • getTemplateInfo

        public TemplateInfo getTemplateInfo()
        Convenience method. Equivalent to calling: getPageInfo.getTemplateInfoList().getTemplateInfo(getXMLStatus())
        Specified by:
        getTemplateInfo in interface PageComponent
        Returns:
        the current templateinfo to be used by this page

      • setWebIServerSession

        @Deprecated
public void setWebIServerSession​(WebIServerSession session)
        Deprecated.
        The method does not have any effect in the object
        Specified by:
        setWebIServerSession in interface PageComponent
        Parameters:
        session - The WebIServerSession to be used by this page.

      • persistBeans

        public void persistBeans()
        For each one of the beans defined, saves their State through the StateManager for future use in this page.

      • setErrorInfo

        public 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.
        Specified by:
        setErrorInfo in interface PageComponent
        Parameters:
        error - The last error on this page. null if none happened

      • setTitle

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

      • getTitle

        public java.lang.String getTitle()
        Returns the pages's title. This method dynamically sets the title of the page, depending on:
        1. If the user has set title using the PageComponent.setTitle(String) method, that title is used.
        2. If the first child of the page is of any of the expected types, the title is used based on the bean.
        3. If the PageInfo contains a desc-id, the resource associated with the desc-id is used
        4. If the PageInfo contains a description, the description is used
        5. The name of the page.
            The expected bean types are:
            • ReportFrameBean: the objectName of the associated ReportBean is used. The title will depend as well in the status of the bean (i.e., if it's processing the name is prefixed with Executing ()
            • DocumentFrameBean: the objectName of the associated DocumentBean is used. The title will depend as well in the status of the bean
            • ObjectBean: it's object name
            • PreferencesBean: the name of the current group set.
        Specified by:
        getTitle in interface PageComponent
        Returns:
        The title of this page

      • getTitleDescriptorId

        public java.lang.String getTitleDescriptorId()
        Since:
        MicroStrategy Web 8.0.0

      • setObjectBeanPageTitle

        protected void setObjectBeanPageTitle​(ObjectBean bean)

      • executePreCollectDataAddons

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

      • hasBinaryContent

        public boolean hasBinaryContent()
        Specified by:
        hasBinaryContent in interface PageComponent
        Returns:
        true if the page would generate binary content in it's output

      • getFontSize

        public 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.)
        Specified by:
        getFontSize in interface PageComponent
        Returns:
        a string with size of the font to use

      • getFontName

        public 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
        Specified by:
        getFontName in interface PageComponent
        Returns:
        a String with a comma separated list of the fonts to use in this page.

      • setTemplateFileName

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

      • getTemplateFileName

        public java.lang.String getTemplateFileName()
        Returns the name of a template file to redirect
        Specified by:
        getTemplateFileName in interface PageComponent
        Returns:
        a file name.

      • executeCollectDataRequiredAddons

        public boolean executeCollectDataRequiredAddons​(WebComponent wc)
        Checks if the different addons associated with the WebComponent require a collect data to be performed.
        Specified by:
        executeCollectDataRequiredAddons in interface PageComponent
        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

      • executePostCollectDataAddons

        public void executePostCollectDataAddons()
        Description copied from interface: PageComponent
        Executes the post collect data addons on the page in the order in which they appear in the pageconfig file.
        Specified by:
        executePostCollectDataAddons in interface PageComponent
        Since:
        MicroStrategy Web 7.5.0

      • collectData

        public void collectData()
                 throws WebBeanException
        Triggers execution to the back end no matter whether it is synchronous or asynchronous. This implementation also trigger the addons execution before and after the collect data.
        Specified by:
        collectData in interface WebComponent
        Overrides:
        collectData in class AbstractAppComponent
        Throws:
        WebBeanException - thrown if there is any exception
        Since:
        MicroStrategy Web 8.0.0

      • saveReturnToPage

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

      • doSaveToPageHistory

        protected void doSaveToPageHistory()
        Saves the page of to the page history regardless of the status or isTrack()

      • getPageHistoryList

        protected PageHistoryList getPageHistoryList()
        Returns:
        the page history list object

      • processApplyChanges

        public 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
        Specified by:
        processApplyChanges in interface PageComponent
        Parameters:
        pageName - The name of the new page
        Throws:
        WebException
        Since:
        MicroStrategy Web 8.0.0

      • setChanged

        public void setChanged​(boolean value)
        Description copied from class: AbstractWebComponent
        Sets the changed state of the component
        Specified by:
        setChanged in interface WebComponent
        Overrides:
        setChanged in class AbstractWebComponent
        Parameters:
        value - a boolean value indicating whether the component is changed.
        Since:
        MicroStrategy Web 8.0.0

      • isOpen

        public boolean isOpen()
        Description copied from class: AbstractAppComponent
        Returns a boolean value indicating if the instance is marked as opened or closed.
        Specified by:
        isOpen in interface AppComponent
        Overrides:
        isOpen in class AbstractAppComponent
        Returns:
        boolean value of True if the instance is marked as opened, it will return False otherwise. By default, instances not marked as dialogs (isDialog() property returning False) will have a browser setting associated with them that should indicate if they are opened or closed. The parent hierarchy is also tested to be in opened state as well as dependent beans not to be in error.
        Since:
        MicroStrategy Web 8.0.1
        See Also:
        AppComponent.isOpen()

      • setScreenMode

        public void setScreenMode​(int screenMode)
        Description copied from interface: PageComponent
        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).
        Specified by:
        setScreenMode in interface PageComponent
        Since:
        MicroStrategy Web 8.1.0

      • getScreenMode

        public int getScreenMode()
        Description copied from interface: PageComponent
        Return the current page screen mode.
        Specified by:
        getScreenMode in interface PageComponent
        Returns:
        page screen mode.
        Since:
        MicroStrategy Web 8.1.0

      • setExplicitScreenMode

        public void setExplicitScreenMode​(int screenMode)
        Description copied from interface: PageComponent
        Use to set the explicit screen mode.
        Specified by:
        setExplicitScreenMode in interface PageComponent
        Since:
        MicroStrategy Web 8.1.0

      • getExplicitScreenMode

        public int getExplicitScreenMode()
        Specified by:
        getExplicitScreenMode in interface PageComponent
        Returns:
        integer value representing the explicit screen mode selected
        Since:
        MicroStrategy Web 8.1.0

      • getResourceManagerMode

        public int getResourceManagerMode()
        Description copied from interface: PageComponent
        Returns the mode of the page manager set up on the page component. The values are defined in the PageResourceManager class
        Specified by:
        getResourceManagerMode in interface PageComponent
        Returns:
        positive integer when it is enabled.

      • isRedirect

        public boolean isRedirect()
        Description copied from interface: PageComponent
        Indicates if the page will be sent down as a redirect response (HTTP 302) instead of an ok response (HTTP 200)
        Specified by:
        isRedirect in interface PageComponent
        Returns:
        boolean value indicating if the the page will be displayed as a redirect (HTTP 302) response

      • setIsRedirect

        public void setIsRedirect​(boolean redirect)
        Description copied from interface: PageComponent
        Sets the page as a redirect response (HTTP 302) instead of an ok response (HTTP 200)
        Specified by:
        setIsRedirect in interface PageComponent
        Parameters:
        redirect - boolean value indicating if the the page will be displayed as a redirect (HTTP 302) response

      • getRedirectURL

        public java.lang.String getRedirectURL()
        Description copied from interface: PageComponent
        Returns the URL to be send down to the browser that corresponds to the page.
        Specified by:
        getRedirectURL in interface PageComponent
        Returns:
        a URL String

      • getXMLStatusPageName

        public java.lang.String getXMLStatusPageName()
        Description copied from interface: PageComponent
        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
        Specified by:
        getXMLStatusPageName in interface PageComponent
        Returns:
        String. Page Name from pageConfig.xml

      • hasXMLStatusPage

        public boolean hasXMLStatusPage()
        Description copied from interface: PageComponent
        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
        Specified by:
        hasXMLStatusPage in interface PageComponent
        Returns:
        true is a page Name has been defined in pageConfig.xml

      • isStagePage

        public boolean isStagePage()
        Description copied from interface: PageComponent
        Returns true if this page is just a stage page which acts as a bridge between two pages.
        Specified by:
        isStagePage in interface PageComponent
        Returns:
        true is this page is a stage page.

      • setStagePage

        public void setStagePage​(boolean isStagePage)
        Description copied from interface: PageComponent
        Sets the page as a stage page which acts as a bridge between two pages.
        Specified by:
        setStagePage in interface PageComponent
        Parameters:
        isStagePage - boolean value indicating if the the page is a stagePage.

      • getDebugFlags

        public int getDebugFlags()
        Description copied from interface: PageComponent
        Get the decimal-format debug flags from the page
        Specified by:
        getDebugFlags in interface PageComponent

      • getLastMessageKey

        public int getLastMessageKey()
        Read message key for active session.
        Specified by:
        getLastMessageKey in interface PageComponent
        Returns:
        {int}

      • setUntrack

        public void setUntrack​(boolean untrack)
        Description copied from interface: PageComponent
        Set whether current page should not be tracked.
        Specified by:
        setUntrack in interface PageComponent
        Parameters:
        untrack - Whether current page should not be tracked.

      • isUntrack

        public boolean isUntrack()
        Description copied from interface: PageComponent
        Whether current page should not be tracked. The difference between this API and PageInfo.isTrack() is, this API's value comes from URL while PageInfo.isTrack() comes from pageConfig.xml
        Specified by:
        isUntrack in interface PageComponent
        Returns:
        Whether current page should not be untracked.