Class PrintTransform

  • All Implemented Interfaces:
    AppTransform, Transform

    public class PrintTransform
    extends AbstractAppTransform
    Deprecated.
    not used anymore since printing is done via PDF
    PrintTransform is the class that generates the printable version of the report.
    Since:
    MicroStrategy Web 7.3.1 or earlier
    • Field Detail

      • countPreviousBlockPages

        protected FormalParameter countPreviousBlockPages
        Deprecated.
        Determines whether to count the previous block of pages when displaying the page number on the header/footer.
        If set to false every block of pages will start with page number 1
      • dpiConversion

        public FormalParameter dpiConversion
        Deprecated.
        name for the formal parameter "dpiConversion".
        Since:
        MicroStrategy Web 8.0.0
    • Constructor Detail

      • PrintTransform

        public PrintTransform()
        Deprecated.
        Default empty constructor.
        Initialize formal parameters.
    • Method Detail

      • renderHtmlTopHtmlMode

        public void renderHtmlTopHtmlMode​(MarkupOutput out,
                                          ReportBean rb)
        Deprecated.
        Renders the top section of the HTML on HTML mode until the definition of the BODY tag.
        Adds META tag and CSS includes on the HEAD section.
        Parameters:
        out - the output object
        rb - ReportBean to print
      • renderHtmlBottomHtmlMode

        public void renderHtmlBottomHtmlMode​(MarkupOutput mo)
        Deprecated.
        Renders the bottom part of the HTML for HTML mode.
        Closes the HTML and BODY tags.
        Parameters:
        mo - the output object
      • renderPageHtmlMode

        public void renderPageHtmlMode​(MarkupOutput mo,
                                       ReportBean rb,
                                       int viewMode)
        Deprecated.
        Renders one HTML page for HTML mode.
        Parameters:
        mo - the output object
        rb - ReportBean to print
        viewMode - a value from EnumWebReportViewMode
      • renderHeader

        public void renderHeader​(MarkupOutput mo,
                                 ReportBean rb)
        Deprecated.
        Renders the page's header.
        Parameters:
        mo - the output object
        rb - ReportBean to print
      • renderUserHeader

        public void renderUserHeader​(MarkupOutput mo,
                                     ReportBean rb)
        Deprecated.
        Renders the user's header.
        Parameters:
        mo - the output object
        rb - ReportBean to print
      • renderGrid

        public void renderGrid​(MarkupOutput mo,
                               ReportBean rb)
        Deprecated.
        Renders the report in grid mode by transforming the report bean with the style specified in the styleGrid formal parameter.
        Parameters:
        mo - the output object
        rb - ReportBean to print
      • renderGraph

        public void renderGraph​(MarkupOutput mo,
                                ReportBean rb)
        Deprecated.
        Renders the report in graph mode by transforming the report bean with the style specified in the styleGraph formal parameter.
        Parameters:
        mo - the output object
        rb - ReportBean to print
      • renderCoverPage

        public void renderCoverPage​(MarkupOutput mo,
                                    ReportBean rb)
        Deprecated.
        Renders the cover page.
        The cover page has information like: Total number of rows/columns and filter details. It also includes header and footer.
        Parameters:
        mo - the output object
        rb - ReportBean to print
      • renderFooter

        public void renderFooter​(MarkupOutput mo,
                                 ReportBean rb)
        Deprecated.
        Renders the page's footer.
        Parameters:
        mo - the output object
        rb - ReportBean to print
      • renderUserFooter

        public void renderUserFooter​(MarkupOutput mo,
                                     ReportBean rb)
        Deprecated.
        Renders the user's footer.
        Parameters:
        mo - the output object
        rb - ReportBean to print
      • renderHtmlTopDhtmlMode

        public void renderHtmlTopDhtmlMode​(MarkupOutput out,
                                           ReportBean rb)
        Deprecated.
        Renders the top section of the HTML for DHTML mode until the definition of the DIV tag that contains the report(s).
        Adds META tag and CSS/JavaScript includes on the HEAD section.
        Parameters:
        out - the output object
        rb - ReportBean to print
      • renderHtmlBottomDhtmlMode

        public void renderHtmlBottomDhtmlMode​(MarkupOutput mo,
                                              ReportBean rb)
        Deprecated.
        Renders the bottom part of the HTML for DHTML mode.
        Closes the DIV tag that contains the report(s) and adds the DIV tags for Header, Footer and Cover Page.
        Also adds the Parameters needed for the DHTML printing component.
        Finally, closes the BODY and HTML tag.
        Parameters:
        mo - the output object
        rb - ReportBean to print
      • renderShell

        public void renderShell​(MarkupOutput out)
        Deprecated.
        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
        Since:
        MicroStrategy Web 8.0.0
      • getDescription

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