Package com.microstrategy.web.app.transforms

Class ReportPageByTransform

    • Field Detail

      • automaticPageBy

        protected FormalParameter automaticPageBy
        Deprecated.
        This is the flag used in the transform to specify whether the dropdown lists will submit form immediately when user changes it.
        Allowed Values: TRUE/FALSE.

      • showPageByDetails

        protected FormalParameter showPageByDetails
        Deprecated.
        This is the flag used in the transform to specify whether to show or hide the page by details section.
        The details section contains the dropdown boxeds where user can change pageby elements.
        In the application out-of-box, we map the browser setting value for EnumWebBrowserSettings.WebBrowserSettingPageBySection to this formal parameter.
        Allowed Values: TRUE/FALSE.

      • imgApply

        protected FormalParameter imgApply
        Deprecated.
        This is the image name for apply image used in the transform.
        Allowed values: a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

    • Constructor Detail

      • ReportPageByTransform

        public ReportPageByTransform()
        Deprecated.
        default no-args constructor

    • Method Detail

      • isPageByEmpty

        protected boolean isPageByEmpty​(ReportBean rb)
        Deprecated.
        return whether the report doesn't have any page by attribute
        Parameters:
        rb - the ReportBean object
        Returns:
        whether the report doesn't have any page by attribute

      • isOpen

        protected boolean isOpen()
        Deprecated.
        Defines whether this Transform is currently visible to the end user.
        Overrides:
        isOpen in class AbstractAppTransform
        Returns:
        true if the bean is visible
        Since:
        MicroStrategy Web 8.0.0

      • showPageByDetails

        protected boolean showPageByDetails()
        Deprecated.
        whether display page by details from formal parameter "showPageByDetails".
        Returns:
        whether display page by details

      • getDescription

        public java.lang.String getDescription()
        Deprecated.
        Return description for this Transform
        Returns:
        description for this Transform

      • isDesignMode

        protected boolean isDesignMode()
        Deprecated.
        Description copied from class: AbstractReportTransform
        This methods allows the transform to identify if concrete subclasses are designed to work in design mode, or in execute mode.
        Overrides:
        isDesignMode in class AbstractReportTransform
        Returns:
        false by default. Any inherting class should override to implement its own version.
        Since:
        MicroStrategy Web 8.0.0

      • renderCenter

        public void renderCenter​(MarkupOutput out,
                         ReportBean rb)
        Deprecated.
        Description copied from interface: ReportDataTransform
        Render center area of the transform.
        Parameters:
        out - output by this transform
        rb - this report bean
        Since:
        MicroStrategy Web 8.0.0

      • renderEmptyCase

        public void renderEmptyCase​(MarkupOutput out,
                            ReportBean rb)
        Deprecated.
        Description copied from interface: ReportDataTransform
        Render when the report grid/graph is empty.
        Usually some information message is displayed.
        Parameters:
        out - output by this transform
        rb - this report bean
        Since:
        MicroStrategy Web 8.0.0

      • renderData

        public void renderData​(MarkupOutput out,
                       ReportBean rb)
        Deprecated.
        Description copied from interface: ReportDataTransform
        Render the report data area.
        The CENTER area of the transform has layout on top and data on bottom.
        Parameters:
        out - output by this transform
        rb - this report bean
        Since:
        MicroStrategy Web 8.0.0

      • renderLayout

        public void renderLayout​(MarkupOutput out,
                         ReportBean rb)
        Deprecated.
        Description copied from interface: ReportDataTransform
        Render the layout for the report grid.
        The CENTER area of the transform has layout on top and data on bottom.
        Parameters:
        out - output by this transform
        rb - this report bean
        Since:
        MicroStrategy Web 8.0.0

      • hasTop

        public boolean hasTop()
        Deprecated.
        Description copied from class: AbstractReportDataTransform
        Whether the transform has the top area. Out of box, if the formal parameter indicates that we need to display incremental fetch links for row on the top of the data, it returns true, or else, it returns false.
        Overrides:
        hasTop in class AbstractReportDataTransform
        Returns:
        Whether the transform has the top area
        Since:
        MicroStrategy Web 8.0.0

      • hasLeft

        public boolean hasLeft()
        Deprecated.
        Description copied from class: AbstractReportDataTransform
        Whether the transform has the left area. Out of box, if the formal parameter indicates that we need to display incremental fetch links for column and there are data to the left of the current data, it returns true, or else, it returns false.
        Overrides:
        hasLeft in class AbstractReportDataTransform
        Returns:
        Whether the transform has the right area
        Since:
        MicroStrategy Web 8.0.0

      • hasRight

        public boolean hasRight()
        Deprecated.
        Description copied from class: AbstractReportDataTransform
        Whether the transform has the right area. Out of box, if the formal parameter indicates that we need to display incremental fetch links for column and there are data to the right of the current data, it returns true, or else, it returns false.
        Overrides:
        hasRight in class AbstractReportDataTransform
        Returns:
        Whether the transform has the right area
        Since:
        MicroStrategy Web 8.0.0

      • hasBottom

        public boolean hasBottom()
        Deprecated.
        Description copied from class: AbstractReportDataTransform
        Whether the transform has the bottom area. Out of box, if the formal parameter indicates that we need to display incremental fetch links for row on the bottom of the data, it returns true, or else, it returns false.
        Overrides:
        hasBottom in class AbstractReportDataTransform
        Returns:
        Whether the transform has the bottom area
        Since:
        MicroStrategy Web 8.0.0

      • hasCenter

        public boolean hasCenter()
        Deprecated.
        Description copied from class: AbstractReportDataTransform
        Whether the transform has the center area. Out of box, it returns true.
        Specified by:
        hasCenter in class AbstractReportDataTransform
        Returns:
        Whether the transform has the center area
        Since:
        MicroStrategy Web 8.0.0