Package com.microstrategy.web.app.transforms

Class PreferencesPDFTransform

    • Field Detail

      • portraitImage

        protected FormalParameter portraitImage
        Specifies the image used for the portrait option on the paper orientation PDF setting.
        Allowed Values:
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

      • landscapeImage

        protected FormalParameter landscapeImage
        Specifies the image used for the landscape option on the paper orientation PDF setting.
        Allowed Values:
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

      • PDFHeaderFooterGroupName

        protected FormalParameter PDFHeaderFooterGroupName
        Specifies the preferences group name of the PDF header/footer editor. Used to create the link to the Header/Footer editor.
        Allowed Values:
        The available preferences groups are specified in the preferencesGroups file.
        Usage:
        Changing this value will make the link to the Header/Footer editor point to another preferences group.

    • Constructor Detail

      • PreferencesPDFTransform

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

    • Method Detail

      • initializeTransform

        public void initializeTransform​(Transformable data)
        Description copied from class: AbstractAppTransform

        This method initialize the private and protected fields of the transform, such as width and height. It also invokes the initializeWebComponent, initializeImages and initializeCss methods.

        This method is automatically called from the transform method. Transforms which would like to invoke other methods in this instance directly (for example, to invoke some render methods), need first to call this method to guarantee that the Transform is ready to generate output.
        Specified by:
        initializeTransform in interface AppTransform
        Overrides:
        initializeTransform in class AbstractOptionsTransform
        Parameters:
        data - the bean to transform.
        Since:
        MicroStrategy Web 7.5.3

      • renderExportSection

        public void renderExportSection​(MarkupOutput out)
        Renders pulldown list for selecting whether to export the 'whole report' or the 'portion displayed'.
        Parameters:
        out - the output object

      • renderScaling

        public void renderScaling​(MarkupOutput out)
        Renders scaling section.
        Parameters:
        out - the output object

      • renderOrientation

        public void renderOrientation​(MarkupOutput out)
        Renders orientation radio buttons.
        Parameters:
        out - the output object

      • renderAdvancedPDFButton

        public void renderAdvancedPDFButton​(MarkupOutput out)
        Renders button for advanced options section. Displayed only in the options page in DHTML mode.
        Parameters:
        out - the output object

      • renderPaperSize

        public void renderPaperSize​(MarkupOutput out)
        Renders pulldown list with paper sizes.
        Parameters:
        out - the output object

      • renderMargin

        public void renderMargin​(MarkupOutput out)
        Renders textboxes for the margins.
        Parameters:
        out - the output object

      • renderMarginTitle

        public void renderMarginTitle​(MarkupOutput out)
        Renders the title for the margin options.
        Since:
        MicroStrategy Web 8.0.1

      • renderMarginLeft

        public void renderMarginLeft​(MarkupOutput out)
        Renders textboxes for the margins.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1

      • renderMarginRight

        public void renderMarginRight​(MarkupOutput out)
        Renders textboxes for the margins.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1

      • renderMarginTop

        public void renderMarginTop​(MarkupOutput out)
        Renders textboxes for the margins.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1

      • renderMarginBottom

        public void renderMarginBottom​(MarkupOutput out)
        Renders textboxes for the margins.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1

      • renderMaxHeaderAndFooterSize

        public void renderMaxHeaderAndFooterSize​(MarkupOutput out)
        Renders maximum header and footer textboxes.
        Parameters:
        out - the output object

      • renderMaxHeaderSize

        public void renderMaxHeaderSize​(MarkupOutput out)
        Renders maximum header and footer textboxes.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1

      • renderMaxFooterSize

        public void renderMaxFooterSize​(MarkupOutput out)
        Renders maximum header and footer textboxes.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1

      • renderCoverPageFilterDetails

        public void renderCoverPageFilterDetails​(MarkupOutput out)
        Renders checkbox for displaying the cover page with filter details.
        Parameters:
        out - the output object

      • renderCoverPageDetailsContents

        public void renderCoverPageDetailsContents​(MarkupOutput out)
        Renders the cover page contents options (With Filter Details, With Report Details)
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 9.0.0

      • renderCoverPageLocation

        public void renderCoverPageLocation​(MarkupOutput out)
        Renders the cover page location options (Before report, After report)
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 9.0.0

      • renderMaxCells

        public void renderMaxCells​(MarkupOutput out)
        Deprecated.
        this preference is not used anymore
        Renders textbox for maximum number of cells to export.
        Parameters:
        out - the output object

      • renderOptions

        public void renderOptions​(MarkupOutput out)
        Renders checkbox for showing the options page before exporting.
        Parameters:
        out - the output object

      • getTitle

        public java.lang.String getTitle()
        Generates the Header of the Preferences dialog. Over ride the method in AbstractPreferenceTransform
        Overrides:
        getTitle in class AbstractOptionsTransform
        Returns:
        the Header of the Preferences dialog.

      • renderDoNotPrompt

        public void renderDoNotPrompt​(MarkupOutput out)
        Generates a checkbox to allow the user to save the "do not prompt me again" preferences in the options page.
        Since:
        MicroStrategy Web 8.0.1

      • renderExportButton

        public void renderExportButton​(MarkupOutput out)
        Generates the submit input and related hidden inputs used to submit the information to display the report in PDF.
        Since:
        MicroStrategy Web 8.0.1

      • renderProjectHeaderAndFooter

        public void renderProjectHeaderAndFooter​(MarkupOutput out)
        Renders link to edit the project header and footer.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 8.0.0

      • renderPDFReportHeaderButton

        public void renderPDFReportHeaderButton​(MarkupOutput out)
        Renders link to edit the report header.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 9.0.0

      • renderExpandPageBy

        public void renderExpandPageBy​(MarkupOutput out)
        Renders Expand Page by option
        Parameters:
        out - MarkupOutput
        Since:
        MicroStrategy Web 8.0.0

      • renderUseBMPGraphs

        public void renderUseBMPGraphs​(MarkupOutput out)
        Renders Use BMP Graphs option
        Parameters:
        out - MarkupOutput
        Since:
        MicroStrategy Web 8.0.0

      • renderEmbedFonts

        public void renderEmbedFonts​(MarkupOutput out)
        Renders Embed Fonts option
        Parameters:
        out - MarkupOutput
        Since:
        MicroStrategy Web 8.0.0

      • renderGridGraphSamePage

        public void renderGridGraphSamePage​(MarkupOutput out)
        Render checkbox to display the grid and graph on the same page.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 8.0.0

      • getPDFSavePropertiesEvent

        public WebEvent getPDFSavePropertiesEvent()
        Deprecated.
        use getSaveReportPropertiesEvent()
        Returns the event used to display the PDF version of the report/document.
        Since:
        MicroStrategy Web 8.0.1

      • getExportEventID

        protected java.lang.String getExportEventID()
        Description copied from class: AbstractOptionsTransform
        Returns the ID of the export event used when this transform is used for the Options Page (examples are Export, PDF and Print)
        This will be used to pass as the "eventToForwardTo" on the Save Report Properties page.
        Overrides:
        getExportEventID in class AbstractOptionsTransform
        Returns:
        The ID of the final event used when this transform is used for the Options Page (examples are Export, PDF and Print)
        Since:
        MicroStrategy Web 9.0.0