Package com.microstrategy.web.objects

Interface WebPDFSettings

  • public interface WebPDFSettings
    Deprecated.
    not used anymore
    The WebPDFSettings class contains methods which determine the exact format of the data exported to PDF
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Detail

      • getPageWidth

        double getPageWidth()
        Deprecated.
        Returns the page width .
        Returns:
        The page width.

      • getPageHeight

        double getPageHeight()
        Deprecated.
        Returns the page height.
        Returns:
        The page height.

      • getTopMargin

        double getTopMargin()
        Deprecated.
        Returns the top margin.
        Returns:
        The top margin.

      • getBottomMargin

        double getBottomMargin()
        Deprecated.
        Returns the bottom margin distance.
        Returns:
        The bottom margin.

      • getLeftMargin

        double getLeftMargin()
        Deprecated.
        Returns the left margin distance.
        Returns:
        The left margin.

      • getRightMargin

        double getRightMargin()
        Deprecated.
        Returns the right margin distance.
        Returns:
        The right margin.

      • getMaxHeaderHeight

        double getMaxHeaderHeight()
        Deprecated.
        Returns the maximum header height.
        Returns:
        The maximum header height.

      • getMaxFooterHeight

        double getMaxFooterHeight()
        Deprecated.
        Returns the maximum footer height.
        Returns:
        The maximum footer height.

      • getExpandToFill

        boolean getExpandToFill()
        Deprecated.
        Returns the pagination setting corresponding to expandToFill.
        Returns:
        The corresponding pagination setting.

      • getRepeatColumnHeadersAcrossPages

        boolean getRepeatColumnHeadersAcrossPages()
        Deprecated.
        Returns whether the column headers will be repeated across PDF pages. If upon exporting to PDF, the report spans more than one PDF page, this setting determines whether the column headers would be outputted to all PDF pages or just the first one.
        Returns:
        The corresponding pagination setting.

      • getRepeatRowHeadersAcrossPages

        boolean getRepeatRowHeadersAcrossPages()
        Deprecated.
        Returns whether the row headers will be repeated across PDF pages. If upon exporting to PDF, the report spans more than one PDF page, this setting determines whether the row headers would be outputted to all PDF pages or just the first one.
        Returns:
        The corresponding pagination setting.

      • getCompressPageOutput

        boolean getCompressPageOutput()
        Deprecated.
        Returns whether the output will be compressed as per the current PDF setting.
        Returns:
        The corresponding PDF setting.

      • setPageWidth

        void setPageWidth​(double pageWidth)
        Deprecated.
        Sets the page width. Default value = 8.5. Unit = inches.
        Parameters:
        pageWidth - The page width to be set.

      • setPageHeight

        void setPageHeight​(double pageHeight)
        Deprecated.
        Sets the page height. Default value = 11. Unit = inches.
        Parameters:
        pageHeight - The page height to be set.

      • setTopMargin

        void setTopMargin​(double topMargin)
        Deprecated.
        Sets the top margin. Default value = 0.5. Unit = inches.
        Parameters:
        topMargin - The top margin to be set.

      • setBottomMargin

        void setBottomMargin​(double bottomMargin)
        Deprecated.
        Sets the bottom margin. Default value = 0.5. Unit = inches.
        Parameters:
        bottomMargin - The bottom margin to be set.

      • setLeftMargin

        void setLeftMargin​(double leftMargin)
        Deprecated.
        Sets the left margin. Default value = 0.5 Unit = inches.
        Parameters:
        leftMargin - The left margin to be set.

      • setRightMargin

        void setRightMargin​(double rightMargin)
        Deprecated.
        Sets the right margin. Defalue value = 1.0 Unit inches.
        Parameters:
        rightMargin - The right margin to be set.

      • setMaxHeaderHeight

        void setMaxHeaderHeight​(double maxHeaderHeight)
        Deprecated.
        Sets the Max Header height. Default value = 0.5 Unit = inches.
        Parameters:
        maxHeaderHeight - The maximum header height to be set.

      • setMaxFooterHeight

        void setMaxFooterHeight​(double maxFooterHeight)
        Deprecated.
        Sets the Max Footer Height. Default value = 0.5 Unit = inches.
        Parameters:
        maxFooterHeight - The maximum footer height.

      • setExpandToFill

        void setExpandToFill​(boolean expandToFill)
        Deprecated.
        Sets the expandToFill pagination setting. Default value = False.
        Parameters:
        expandToFill - Specifies whether to expand to fill.

      • setRepeatColumnHeadersAcrossPages

        void setRepeatColumnHeadersAcrossPages​(boolean repeatColumnHeaders)
        Deprecated.
        Sets the repeatColumnHeaders pagination setting. If upon exporting to PDF, the report spans more than one PDF page, this setting determines whether the column headers would be outputted to all PDF pages or just the first one. Default value is True.
        Parameters:
        repeatColumnHeaders - Specifies whether to repeat the column headers.

      • setRepeatRowHeadersAcrossPages

        void setRepeatRowHeadersAcrossPages​(boolean repeatRowHeaders)
        Deprecated.
        Sets the repeatRowHeaders pagination setting. Default value is True. If upon exporting to PDF, the report spans more than one PDF page, this setting determines whether the row headers would be outputted to all PDF pages or just the first one.
        Parameters:
        repeatRowHeaders - Specifies whether to repeat the row headers.

      • setCompressPageOutput

        void setCompressPageOutput​(boolean compressPageOutput)
        Deprecated.
        Sets the compressPageOutput PDF setting. Default value is True.
        Parameters:
        compressPageOutput - Specifies whether to compress the page output.

      • setHandleStyles

        void setHandleStyles​(boolean handleStyles)
        Deprecated.
        Sets the handleStyles debug setting. Default value is True.
        Parameters:
        handleStyles - Specifies whether to handle styles.

      • getHandleStyles

        boolean getHandleStyles()
        Deprecated.
        Returns whether the handleStyles debug setting is set.
        Returns:
        The corresponding debug setting.

      • setCollectPerformanceData

        void setCollectPerformanceData​(boolean collectPerformanceData)
        Deprecated.
        Sets the collectPerformanceData debug setting. Default value is False.
        Parameters:
        collectPerformanceData - Specifies whether to collect the performance data.

      • getCollectPerformanceData

        boolean getCollectPerformanceData()
        Deprecated.
        Returns whether the collectPerformanceData debug setting is set.
        Returns:
        The corresponding debug setting.

      • getHorizontalFitTo

        int getHorizontalFitTo()
        Deprecated.
        returns the number of pages wide to zoom to. The -1 means no restriction.
        Returns:
        the number of pages wide to zoom to.

      • getVerticalFitTo

        int getVerticalFitTo()
        Deprecated.
        returns the number of pages high to zoom to. The -1 means no restriction.
        Returns:
        the number of pages high to zoom to.

      • setHorizontalFitTo

        void setHorizontalFitTo​(int horizontalFitTo)
        Deprecated.
        sets the number of pages wide to zoom to. Default value is -1. The -1 means no restriction.
        Parameters:
        horizontalFitTo - the number of pages wide to zoom to.

      • setVerticalFitTo

        void setVerticalFitTo​(int verticalFitTo)
        Deprecated.
        sets the number of pages high to zoom to. Default value is -1. The -1 means no restriction.
        Parameters:
        verticalFitTo - the number of pages high to zoom to.

      • setPercentageZoomFactor

        void setPercentageZoomFactor​(double percentageZoomFactor)
        Deprecated.
        sets the percentage zoom factor(Default value is 100). A value greater than 0 is expected. When Percentage Zoom Factor is specified (and it is not 100), horizontalFitTo and verticalFitTo will be ignored.
        Parameters:
        percentageZoomFactor - the percentage zoom factor.

      • getPercentageZoomFactor

        double getPercentageZoomFactor()
        Deprecated.
        returns the percentage zoom factor.
        Returns:
        the percentage zoom factor.

      • getAttributeFormNamesDisplay

        int getAttributeFormNamesDisplay()
        Deprecated.
        returns the property related to showing attribute forms. The returned value would be a value from the enumeration interface EnumWebAttributeFormNamesDisplay returns the value of the showAttributeFormNames property.

      • setMergeColumnHeaders

        void setMergeColumnHeaders​(boolean mergeColumnHeaders)
        Deprecated.
        sets the mergeColumnHeaders property. This setting determines whether the column headers should be merged in the resulting PDF or not.

      • getMergeColumnHeaders

        boolean getMergeColumnHeaders()
        Deprecated.
        returns the mergeColumnHeaders property. This setting determines whether the column headers should be merged in the resulting PDF or not.
        Returns:
        the value of the mergeColumnHeaders setting.

      • setOutlineModeSettings

        void setOutlineModeSettings​(java.lang.String settings)
        Deprecated.
        Since:
        MicroStrategy Web 8.0.0

      • getOutlineModeSettings

        java.lang.String getOutlineModeSettings()
        Deprecated.
        Since:
        MicroStrategy Web 8.0.0