Package com.microstrategy.web.app.beans

Interface PrintBean

  • All Superinterfaces:
    AppComponent, Transformable, WebComponent
    public interface PrintBean
extends AppComponent
    Deprecated.
    not used anymore since printing is done via PDF
    The interface PrintBean is representing the export web component.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Field Detail

      • PAPER_ORIENTATION_PORTRAIT_OPTION

        static final java.lang.String PAPER_ORIENTATION_PORTRAIT_OPTION
        Deprecated.
        Constant representing the paper orientation portrait option
        See Also:
        Constant Field Values

      • PAPER_ORIENTATION_LANDSCAPE_OPTION

        static final java.lang.String PAPER_ORIENTATION_LANDSCAPE_OPTION
        Deprecated.
        Constant representing the paper orientation landscape option
        See Also:
        Constant Field Values

      • SCALING_SHRINK_FONT_OPTION

        static final java.lang.String SCALING_SHRINK_FONT_OPTION
        Deprecated.
        Constant representing the shrink font scaling option
        See Also:
        Constant Field Values

      • SCALING_FIT_TO_PAGE_OPTION

        static final java.lang.String SCALING_FIT_TO_PAGE_OPTION
        Deprecated.
        Constant representing the fit to page scaling option
        See Also:
        Constant Field Values

      • PrintSectionDisplayAdminHeader

        static final int PrintSectionDisplayAdminHeader
        Deprecated.
        Constant representing the admin header section
        See Also:
        Constant Field Values

      • PrintSectionDisplayUserHeader

        static final int PrintSectionDisplayUserHeader
        Deprecated.
        Constant representing the user header section
        See Also:
        Constant Field Values

      • PrintSectionDisplayPagebyInfoHeader

        static final int PrintSectionDisplayPagebyInfoHeader
        Deprecated.
        Constant representing the page by info header section
        See Also:
        Constant Field Values

      • PrintSectionDisplayCoverPage

        static final int PrintSectionDisplayCoverPage
        Deprecated.
        Constant representing the cover page section
        See Also:
        Constant Field Values

      • PrintSectionDisplayAdminFooter

        static final int PrintSectionDisplayAdminFooter
        Deprecated.
        Constant representing the admin footer section
        See Also:
        Constant Field Values

      • PrintSectionDisplayUserFooter

        static final int PrintSectionDisplayUserFooter
        Deprecated.
        Constant representing the user footer section
        See Also:
        Constant Field Values

      • HEADER_FOOTER_PATTERN_TOTAL_PAGES

        static final java.lang.String HEADER_FOOTER_PATTERN_TOTAL_PAGES
        Deprecated.
        Constant representing the total pages macro pattern
        See Also:
        Constant Field Values

      • HEADER_FOOTER_PATTERN_CURRENT_PAGE

        static final java.lang.String HEADER_FOOTER_PATTERN_CURRENT_PAGE
        Deprecated.
        Constant representing the page macro pattern
        See Also:
        Constant Field Values

      • HEADER_FOOTER_PATTERN_DATE

        static final java.lang.String HEADER_FOOTER_PATTERN_DATE
        Deprecated.
        Constant representing the date macro pattern
        See Also:
        Constant Field Values

      • HEADER_FOOTER_PATTERN_TIME

        static final java.lang.String HEADER_FOOTER_PATTERN_TIME
        Deprecated.
        Constant representing the time macro pattern
        See Also:
        Constant Field Values

      • HEADER_FOOTER_PATTERN_PROJECT

        static final java.lang.String HEADER_FOOTER_PATTERN_PROJECT
        Deprecated.
        Constant representing the project macro pattern
        See Also:
        Constant Field Values

      • HEADER_FOOTER_PATTERN_REPORT

        static final java.lang.String HEADER_FOOTER_PATTERN_REPORT
        Deprecated.
        Constant representing the report macro pattern
        See Also:
        Constant Field Values

      • HEADER_FOOTER_PATTERN_TEMPLATE

        static final java.lang.String HEADER_FOOTER_PATTERN_TEMPLATE
        Deprecated.
        Constant representing the template macro pattern
        See Also:
        Constant Field Values

      • HEADER_FOOTER_PATTERN_FILTER

        static final java.lang.String HEADER_FOOTER_PATTERN_FILTER
        Deprecated.
        Constant representing the filter macro pattern
        See Also:
        Constant Field Values

      • HEADER_FOOTER_PATTERN_DETAILS

        static final java.lang.String HEADER_FOOTER_PATTERN_DETAILS
        Deprecated.
        Constant representing the details macro pattern
        See Also:
        Constant Field Values

      • HEADER_FOOTER_PATTERN_USER_NAME

        static final java.lang.String HEADER_FOOTER_PATTERN_USER_NAME
        Deprecated.
        Constant representing the user name macro pattern
        See Also:
        Constant Field Values

    • Method Detail

      • getReportBean

        ReportBean getReportBean()
        Deprecated.
        Returns:
        the report bean associated with this export bean

      • setReportBean

        void setReportBean​(ReportBean rb)
        Deprecated.
        Sets the report bean associated with this print bean.
        Parameters:
        rb - Report Bean

      • getCurrentPagebyOrdinal

        int getCurrentPagebyOrdinal​(ReportBean rb)
        Deprecated.
        Returns the current pageby ordinal indicated by the report bean.
        Parameters:
        rb - ReportBean to print
        Returns:
        the current pageby ordinal

      • getRowsToShow

        int getRowsToShow​(ReportBean rb)
        Deprecated.
        Returns the total number of rows to show on the current print block
        Parameters:
        rb - ReportBean to print
        Returns:
        the total number of rows to show on the current print block

      • getRowsPerBlock

        int getRowsPerBlock​(ReportBean rb)
        Deprecated.
        Returns the total number of rows per printing block.
        Parameters:
        rb - ReportBean to print
        Returns:
        the total number of rows per printing block

      • getGridRowsPerPage

        java.lang.String getGridRowsPerPage()
        Deprecated.
        Returns the current grid rows per page (only HTML mode)
        Returns:
        the current grid rows per page

      • setGridRowsPerPage

        void setGridRowsPerPage​(java.lang.String gridRowsPerPage)
        Deprecated.
        Sets the current grid rows per page (only HTML mode)
        Parameters:
        gridRowsPerPage - the current grid rows per page

      • getGridColsPerPage

        java.lang.String getGridColsPerPage()
        Deprecated.
        Returns the current grid columns per page (only HTML mode)
        Returns:
        the current grid columns per page

      • setGridColsPerPage

        void setGridColsPerPage​(java.lang.String gridColsPerPage)
        Deprecated.
        Sets the current grid columns per page (only HTML mode)
        Parameters:
        gridColsPerPage - the current grid columns per page

      • getGraphRowsPerPage

        java.lang.String getGraphRowsPerPage()
        Deprecated.
        Returns the current the current graph rows per page
        Returns:
        the current the current graph rows per page

      • setGraphRowsPerPage

        void setGraphRowsPerPage​(java.lang.String graphRowsPerPage)
        Deprecated.
        Sets the current the current graph rows per page
        Parameters:
        graphRowsPerPage - the current graph rows per page

      • getGraphColsPerPage

        java.lang.String getGraphColsPerPage()
        Deprecated.
        Returns the current graph columns per page
        Returns:
        the current graph columns per page

      • setGraphColsPerPage

        void setGraphColsPerPage​(java.lang.String graphColsPerPage)
        Deprecated.
        Sets the current graph columns per page
        Parameters:
        graphColsPerPage - graph columns per page

      • getGraphsPerBlock

        java.lang.String getGraphsPerBlock()
        Deprecated.
        Returns the current graphs per block. This limits the amount of HTML sent the the client.
        Returns:
        the current graphs per block

      • setGraphsPerBlock

        void setGraphsPerBlock​(java.lang.String graphsPerBlock)
        Deprecated.
        Sets the current graphs per block. This limits the amount of HTML sent the the client.
        Parameters:
        graphsPerBlock - the current graphs per block

      • getCellsPerBlock

        java.lang.String getCellsPerBlock()
        Deprecated.
        Returns the current cells per block. This limits the amount of HTML sent the the client.
        Returns:
        the current cells per block

      • setCellsPerBlock

        void setCellsPerBlock​(java.lang.String cellsPerBlock)
        Deprecated.
        Sets the current cells per block. This limits the amount of HTML sent the the client.
        Parameters:
        cellsPerBlock - the current cells per block

      • getPaperSize

        java.lang.String getPaperSize()
        Deprecated.
        Returns the current paper size (a key from paperSizes.xml)
        Returns:
        the current paper size

      • setPaperSize

        void setPaperSize​(java.lang.String paperSize)
        Deprecated.
        Sets the current paper size (a key from paperSizes.xml)
        Parameters:
        paperSize - the current paper size

      • getPaperOrientationOption

        java.lang.String getPaperOrientationOption()
        Deprecated.
        Returns the current paper orientation (PAPER_ORIENTATION_PORTRAIT_OPTION or PAPER_ORIENTATION_LANDSCAPE_OPTION)
        Returns:
        the current paper orientation

      • setPaperOrientationOption

        void setPaperOrientationOption​(java.lang.String paperOrientationOption)
        Deprecated.
        Sets the current paper orientation (PAPER_ORIENTATION_PORTRAIT_OPTION or PAPER_ORIENTATION_LANDSCAPE_OPTION)
        Parameters:
        paperOrientationOption - the current paper orientation

      • getHeaderLeftSection

        java.lang.String getHeaderLeftSection()
        Deprecated.
        Returns the current header left section content
        Returns:
        the current header left section

      • setHeaderLeftSection

        void setHeaderLeftSection​(java.lang.String headerLeftSection)
        Deprecated.
        Sets the current header left section content
        Parameters:
        headerLeftSection - the current header left section

      • getHeaderCenterSection

        java.lang.String getHeaderCenterSection()
        Deprecated.
        Returns the current header center section content
        Returns:
        the current header center section

      • setHeaderCenterSection

        void setHeaderCenterSection​(java.lang.String headerCenterSection)
        Deprecated.
        Sets the current header center section content
        Parameters:
        headerCenterSection - the current header center section

      • getHeaderRightSection

        java.lang.String getHeaderRightSection()
        Deprecated.
        Returns the current header right section content
        Returns:
        the current header right section

      • setHeaderRightSection

        void setHeaderRightSection​(java.lang.String headerRightSection)
        Deprecated.
        Sets the current header right section content
        Parameters:
        headerRightSection - the current header right section

      • getFooterLeftSection

        java.lang.String getFooterLeftSection()
        Deprecated.
        Returns the current footer left section content
        Returns:
        the current footer left section

      • setFooterLeftSection

        void setFooterLeftSection​(java.lang.String footerLeftSection)
        Deprecated.
        Sets the current footer left section content
        Parameters:
        footerLeftSection - the current footer left section

      • getFooterCenterSection

        java.lang.String getFooterCenterSection()
        Deprecated.
        Returns the current footer center section content
        Returns:
        the current footer center section

      • setFooterCenterSection

        void setFooterCenterSection​(java.lang.String footerCenterSection)
        Deprecated.
        Sets the current footer center section content
        Parameters:
        footerCenterSection - the current footer center section

      • getFooterRightSection

        java.lang.String getFooterRightSection()
        Deprecated.
        Returns the current footer right section content
        Returns:
        the current footer right section

      • setFooterRightSection

        void setFooterRightSection​(java.lang.String footerRightSection)
        Deprecated.
        Sets the current footer right section content
        Parameters:
        footerRightSection - the current footer right section

      • getAdminHeaderFilePath

        java.lang.String getAdminHeaderFilePath()
        Deprecated.
        Returns the current administrator's header file path
        Returns:
        the current administrator's header file path

      • setAdminHeaderFilePath

        void setAdminHeaderFilePath​(java.lang.String adminHeaderFilePath)
        Deprecated.
        Sets the current administrator's header file path
        Parameters:
        adminHeaderFilePath - the current administrator's header file path

      • getAdminFooterFilePath

        java.lang.String getAdminFooterFilePath()
        Deprecated.
        Returns the current administrator's footer file path
        Returns:
        the current administrator's footer file path

      • setAdminFooterFilePath

        void setAdminFooterFilePath​(java.lang.String adminFooterFilePath)
        Deprecated.
        Sets the current administrator's footer file path
        Parameters:
        adminFooterFilePath - the current administrator's footer file path

      • getMarginSizeLeft

        java.lang.String getMarginSizeLeft()
        Deprecated.
        returns the current left margin size in inches (only DHTML mode)
        Returns:
        the current left margin size

      • setMarginSizeLeft

        void setMarginSizeLeft​(java.lang.String marginSizeLeft)
        Deprecated.
        Sets the current left margin size in inches (only DHTML mode)
        Parameters:
        marginSizeLeft - the current left margin size

      • getMarginSizeRight

        java.lang.String getMarginSizeRight()
        Deprecated.
        Returns the current right margin size in inches (only DHTML mode)
        Returns:
        the current right margin size

      • setMarginSizeRight

        void setMarginSizeRight​(java.lang.String marginSizeRight)
        Deprecated.
        Sets the current right margin size in inches (only DHTML mode)
        Parameters:
        marginSizeRight - the current right margin size

      • getMarginSizeTop

        java.lang.String getMarginSizeTop()
        Deprecated.
        Returns the current top margin size in inches (only DHTML mode)
        Returns:
        the current top margin size

      • setMarginSizeTop

        void setMarginSizeTop​(java.lang.String marginSizeTop)
        Deprecated.
        Sets the current top margin size in inches (only DHTML mode)
        Parameters:
        marginSizeTop - the current top margin size

      • getMarginSizeBottom

        java.lang.String getMarginSizeBottom()
        Deprecated.
        Returns the current bottom margin size in inches (only DHTML mode)
        Returns:
        the current bottom margin size

      • setMarginSizeBottom

        void setMarginSizeBottom​(java.lang.String marginSizeBottom)
        Deprecated.
        Sets the current bottom margin size in inches (only DHTML mode)
        Parameters:
        marginSizeBottom - the current bottom margin size

      • getHeaderSize

        java.lang.String getHeaderSize()
        Deprecated.
        Returns the current header size in inches (only DHTML mode)
        Returns:
        the current header size

      • setHeaderSize

        void setHeaderSize​(java.lang.String headerSize)
        Deprecated.
        Sets the current header size in inches (only DHTML mode)
        Parameters:
        headerSize - the current header size

      • getFooterSize

        java.lang.String getFooterSize()
        Deprecated.
        Returns the current footer size in inches (only DHTML mode)
        Returns:
        the current footer size

      • setFooterSize

        void setFooterSize​(java.lang.String footerSize)
        Deprecated.
        Sets the current footer size in inches (only DHTML mode)
        Parameters:
        footerSize - the current footer size

      • getScalingOption

        java.lang.String getScalingOption()
        Deprecated.
        Returns the current scaling option (SCALING_SHRINK_FONT_OPTION or SCALING_FIT_TO_PAGE_OPTION)
        Returns:
        the current scaling option

      • setScalingOption

        void setScalingOption​(java.lang.String scalingOption)
        Deprecated.
        Sets the current scaling option (SCALING_SHRINK_FONT_OPTION or SCALING_FIT_TO_PAGE_OPTION)
        Parameters:
        scalingOption - the current scaling option

      • getShrinkFontPercentage

        java.lang.String getShrinkFontPercentage()
        Deprecated.
        Returns the current shrink font percentage. Applied if scalingOption equals SCALING_SHRINK_FONT (only DHTML mode)
        Returns:
        the current shrink font percentage.

      • setShrinkFontPercentage

        void setShrinkFontPercentage​(java.lang.String shrinkFontPercentage)
        Deprecated.
        Sets the current shrink font percentage. Applied if scalingOption equals SCALING_SHRINK_FONT (only DHTML mode)
        Parameters:
        shrinkFontPercentage - the current shrink font percentage

      • getStyleGrids

        java.lang.String getStyleGrids()
        Deprecated.
        Returns the current style used when transforming the report bean to generate grids
        Returns:
        the current style used when transforming the report bean to generate grids

      • setStyleGrids

        void setStyleGrids​(java.lang.String styleGrids)
        Deprecated.
        Sets the current style used when transforming the report bean to generate grids
        Parameters:
        styleGrids - the current style used when transforming the report bean to generate grids

      • getStyleGraphs

        java.lang.String getStyleGraphs()
        Deprecated.
        Returns the current style used when transforming the report bean to generate graphs
        Returns:
        the current style used when transforming the report bean to generate graphs

      • setStyleGraphs

        void setStyleGraphs​(java.lang.String styleGraphs)
        Deprecated.
        Sets the current style used when transforming the report bean to generate graphs
        Parameters:
        styleGraphs - the current style used when transforming the report bean to generate graphs

      • getStylePagebyInfo

        java.lang.String getStylePagebyInfo()
        Deprecated.
        Returns the current style used when transforming the report bean to generate the page by information
        Returns:
        the current style used when transforming the report bean to generate the page by information

      • setStylePagebyInfo

        void setStylePagebyInfo​(java.lang.String stylePagebyInfo)
        Deprecated.
        Sets the current style used when transforming the report bean to generate the page by information
        Parameters:
        stylePagebyInfo - the current style used when transforming the report bean to generate the page by information

      • getStartRow

        java.lang.String getStartRow()
        Deprecated.
        Returns the block's start row
        Returns:
        the block's start row

      • setStartRow

        void setStartRow​(java.lang.String startRow)
        Deprecated.
        Sets the block's start row
        Parameters:
        startRow - the block's start row

      • getPrintSectionFlags

        int getPrintSectionFlags()
        Deprecated.
        Returns the current print section flags (a value from combining PrintSectionDisplay flags (PrintSectionDisplayGrid, PrintSectionDisplayHeader, etc.))
        Returns:
        the current print section flags

      • setPrintSectionFlags

        void setPrintSectionFlags​(int printSectionFlags)
        Deprecated.
        Sets the current print section flags (a value from combining PrintSectionDisplay flags (PrintSectionDisplayGrid, PrintSectionDisplayHeader, etc.))
        Parameters:
        printSectionFlags - the current print section flags

      • getPagebyOrdinal

        java.lang.String getPagebyOrdinal()
        Deprecated.
        Returns the current page by ordinal
        Returns:
        the current page by ordinal

      • setPagebyOrdinal

        void setPagebyOrdinal​(java.lang.String pagebyOrdinal)
        Deprecated.
        Sets the current page by ordinal
        Parameters:
        pagebyOrdinal - the current page by ordinal

      • getUserGraphWidth

        java.lang.String getUserGraphWidth()
        Deprecated.
        Returns the user's graph width. Determines the size of graphs
        Returns:
        the user's graph width

      • setUserGraphWidth

        void setUserGraphWidth​(java.lang.String userGraphWidth)
        Deprecated.
        Sets the user's graph width. Determines the size of graphs
        Parameters:
        userGraphWidth - the user's graph width

      • getUserGraphHeight

        java.lang.String getUserGraphHeight()
        Deprecated.
        Returns the user's graph height. Determines the size of graphs
        Returns:
        the user's graph height

      • setUserGraphHeight

        void setUserGraphHeight​(java.lang.String userGraphHeight)
        Deprecated.
        Sets the user's graph height. Determines the size of graphs
        Parameters:
        userGraphHeight - the user's graph height

      • getGraphSize

        java.lang.String getGraphSize()
        Deprecated.
        Returns the user's graph size. Determines the size of graphs (PreferencesGraphTransform.GRAPH_USE_USER_SIZE or PreferencesGraphTransform.GRAPH_USE_REPORT_SIZE)
        Returns:
        the user's graph size

      • setGraphSize

        void setGraphSize​(java.lang.String graphSize)
        Deprecated.
        Sets the user's graph size. Determines the size of graphs (PreferencesGraphTransform.GRAPH_USE_USER_SIZE or PreferencesGraphTransform.GRAPH_USE_REPORT_SIZE)
        Parameters:
        graphSize - the user's graph size

      • getDisplayCoverPage

        boolean getDisplayCoverPage()
        Deprecated.
        Returns a boolean value that indicates whether to display the cover page
        Returns:
        true if the cover page is to be displayed

      • setDisplayCoverPage

        void setDisplayCoverPage​(boolean displayCoverPage)
        Deprecated.
        Sets the boolean value that indicates whether to display the cover page
        Parameters:
        displayCoverPage - true if the cover page is to be displayed

      • getExpandPageByFields

        boolean getExpandPageByFields()
        Deprecated.
        Returns a boolean value that indicates whether to expand the page=by fields
        Returns:
        true if the page-by fileds are to be expanded

      • setExpandPageByFields

        void setExpandPageByFields​(boolean expandPageByFields)
        Deprecated.
        Sets the boolean value that indicates whether to expand the page=by fields
        Parameters:
        expandPageByFields - true if the page-by fields are to be expanded

      • getFitRowsToPage

        boolean getFitRowsToPage()
        Deprecated.
        Returns a boolean value that determines whether to fit the rows to page. Applied if scaling equals to SCALING_FIT_TO_PAGE_OPTION (only DHTML mode)
        Returns:
        true if fit the rows to page.

      • setFitRowsToPage

        void setFitRowsToPage​(boolean fitRowsToPage)
        Deprecated.
        Sets the boolean value that determines whether to fit the rows to page. Applied if scaling equals to SCALING_FIT_TO_PAGE_OPTION (only DHTML mode)
        Parameters:
        fitRowsToPage - true if fit the rows to page

      • getFitColsToPage

        boolean getFitColsToPage()
        Deprecated.
        Returns a boolean value that determines whether to fit the columns to page. Applied if scaling equals to SCALING_FIT_TO_PAGE_OPTION (only DHTML mode)
        Returns:
        true if fit columns to page.

      • setFitColsToPage

        void setFitColsToPage​(boolean fitColsToPage)
        Deprecated.
        Sets the boolean value that determines whether to fit the columns to page. Applied if scaling equals to SCALING_FIT_TO_PAGE_OPTION (only DHTML mode)
        Parameters:
        fitColsToPage - true if fit columns to page

      • getDisplayPopupPrintDialog

        boolean getDisplayPopupPrintDialog()
        Deprecated.
        Returns a boolean value that determine whether to display the popup print dialog when printing. (only DHTML)
        Returns:
        true is the popup print dialog is to be displayed (only DHTML)

      • setDisplayPopupPrintDialog

        void setDisplayPopupPrintDialog​(boolean displayPopupPrintDialog)
        Deprecated.
        Sets the boolean value that determine whether to display the popup print dialog when printing. (only DHTML)
        Parameters:
        displayPopupPrintDialog - true is the popup print dialog is to be displayed

      • getDisplayGridAndGraphSamePage

        boolean getDisplayGridAndGraphSamePage()
        Deprecated.
        Returns a boolean value that determines whether to display the grid and graph on the same page.
        Returns:
        true if the Grid and Graph are to be displayed on the same page

      • setDisplayGridAndGraphSamePage

        void setDisplayGridAndGraphSamePage​(boolean displayGridAndGraphSamePage)
        Deprecated.
        Sets the boolean value that determine whether to display the grid and graph on the same page.
        Parameters:
        displayGridAndGraphSamePage - true if the Grid and Graph are to be displayed on the same page