Package com.microstrategy.web.app.transforms

Class AbstractReportExportTransform

    • Field Detail

      • styleGraphs

        protected FormalParameter styleGraphs
        This formal parameter determines the style to be used to transform the report bean on graph mode.
        Allowed Values: any report style name from StyleCatalog.xml file.

      • styleGrids

        protected FormalParameter styleGrids
        This formal parameter determines the style to be used to transform the report bean on grid or grid and graph mode.
        Allowed Values: any report style name from StyleCatalog.xml file.

      • styleOutlineGrids

        protected FormalParameter styleOutlineGrids
        This formal parameter determines the style to be used to transform the report bean on grids in Outline mode.
        Allowed Values: any report style name from StyleCatalog.xml file.

      • stylePageByInfo

        protected FormalParameter stylePageByInfo
        This formal parameter determines the style to be used to transform the report bean to display the page by information.
        Allowed Values: any report style name from StyleCatalog.xml file.

      • renderPageByAfterFilterDetails

        protected FormalParameter renderPageByAfterFilterDetails
        This formal parameter determines whether the page by information is rendered after the filter details section.
        Allowed Values: TRUE/FALSE

      • renderOldStyleFilterDetails

        protected FormalParameter renderOldStyleFilterDetails
        This formal parameter determines whether the filter details section is rendered using the old style
        Allowed Values: TRUE/FALSE

      • colspan

        protected int colspan

    • Constructor Detail

      • AbstractReportExportTransform

        public AbstractReportExportTransform()
        Default empty constructor.
        Initialize formal parameters.

    • Method Detail

      • getReportGridTransform

        protected TransformInstance getReportGridTransform​(ViewBean vb)
        Helper method for obtaining the Report Grid Transform associated with this instance
        Parameters:
        vb - ViewBean instance being transformed

      • getReportGraphTransform

        protected TransformInstance getReportGraphTransform​(ViewBean vb)
        Helper method for obtaining the Report Graph Transform associated with this instance
        Parameters:
        vb - ViewBean instance being transformed

      • getReportOutlineGridTransform

        protected TransformInstance getReportOutlineGridTransform​(ViewBean vb)
        Helper method for obtaining the Report Grid Outline Transform associated with this instance
        Parameters:
        vb - ViewBean instance being transformed

      • getPageByTransform

        protected TransformInstance getPageByTransform​(ReportBean rb)
        Helper method for obtaining the Report Page By Transform associated with this instance
        Parameters:
        rb - ReportBean instance being transformed

      • getExportBean

        protected ExportBean getExportBean()
        Helper method for obtaining the ExportBean instance related with this transform
        Returns:
        ExportBean instance linked to this transform class

      • initializeProperties

        public void initializeProperties()
        Initialize some properties for the transform.
        For example, it may overwrite some formal parameters' values depending on whether the corresponding feature is available.
        Overrides:
        initializeProperties in class AbstractReportTransform

      • renderExcelHeader

        public void renderExcelHeader​(MarkupOutput mo)
        Renders the headers on top for reports
        Parameters:
        mo - MarkupOutput

      • renderHeader

        public void renderHeader​(MarkupOutput mo)
        Reads the Export Header from the Project Defaults> Export tab of the Preference page and puts at the top of the HTML page when a report is exported to HTML
        Parameters:
        mo -

      • renderFooter

        public void renderFooter​(MarkupOutput mo)
        Reads the Export Footer from the Project Defaults> Export tab of the Preference page and puts at the bottom of the HTML page when a report is exported to HTML
        Parameters:
        mo -

      • renderMetaContentType

        public void renderMetaContentType​(MarkupOutput out)
        Renders the META tag with the content type
        Parameters:
        out - MarkupOutput

      • renderReportName

        public void renderReportName​(MarkupOutput mo)
        Renders the report name

      • renderReportNameForTitle

        public void renderReportNameForTitle​(MarkupOutput mo)
        Renders the report name for the page's title

      • renderCss

        public void renderCss​(MarkupOutput mo)
        Render the necessary CSS files
        Parameters:
        mo - MarkupOutput

      • renderFilterDetails

        public void renderFilterDetails​(MarkupOutput mo)
        Renders the report's filter details.
        Parameters:
        mo - MarkupOutput

      • renderReport

        public void renderReport​(MarkupOutput mo)
        Renders the report section
        Parameters:
        mo - the output object

      • renderLinesBetweenGridAndGraph

        public void renderLinesBetweenGridAndGraph​(MarkupOutput mo)

      • renderPageByInfo

        public void renderPageByInfo​(MarkupOutput mo)
        Renders the page by information
        Parameters:
        mo - the output object

      • renderNewLine

        public void renderNewLine​(MarkupOutput mo)
        Renders a new line (empty row)
        Parameters:
        mo - the output object

      • getAttributesHTML

        public java.util.Map getAttributesHTML()
        Gets the list of html attributes for the html tag

      • getAttributesBody

        public java.util.Map getAttributesBody()
        Gets the list of html attributes for the body tag

      • getAttributesMainTable

        public java.util.Map getAttributesMainTable()
        Gets the list of html attributes for the main table tag

      • initFormalParasForGridTransform

        protected void initFormalParasForGridTransform​(TransformInstance ti)

      • initFormalParasForGraphTransform

        protected void initFormalParasForGraphTransform​(TransformInstance ti)

      • initFormalParasForPageByTransform

        protected void initFormalParasForPageByTransform​(TransformInstance ti)

      • applyLineBreak

        protected java.lang.String applyLineBreak​(java.lang.String text)

      • getDescription

        public java.lang.String getDescription()
        Return description for this Transform
        Specified by:
        getDescription in interface Transform
        Returns:
        description for this Transform

      • renderShell

        public void renderShell​(MarkupOutput out)
        Description copied from class: AbstractAppTransform

        Generates the shell for this Transform.

        The shell is a <div> tag that automatically surrounds the content generated by the Transform. It's used among other things by the javascript to identify the HTML associated with a bone, and by the iFrame update technology to identify a component in the page.

        The attributes to append to this <div> are obtained from the getAttributesShellDiv method; the style from the getStyleShellDiv method.
        This method calls renderCssLink and checkStatus to generate the Transform's content.
        Overrides:
        renderShell in class AbstractAppTransform
        Parameters:
        out - output by this transform