Class PreferencesPrintTransform

    • Field Detail

      • portraitImage

        protected FormalParameter portraitImage
        Deprecated.
        Specifies the image used for the portrait option on the paper orientation print 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
        Deprecated.
        Specifies the image used for the landscape option on the paper orientation print 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.
      • printHeaderFooterGroupName

        protected FormalParameter printHeaderFooterGroupName
        Deprecated.
        Specifies the preferences group name of the print 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

      • PreferencesPrintTransform

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

      • initializeTransform

        public void initializeTransform​(Transformable data)
        Deprecated.
        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
      • canShowPaperOptions

        public boolean canShowPaperOptions()
        Deprecated.
        Determines if paper orientation and paper size options need to be displayed.
        Returns:
        true is in DHTML mode or if displaying advanced options.
        Since:
        MicroStrategy Web 8.0.1
      • isDhtmlPrintingEnabled

        public boolean isDhtmlPrintingEnabled()
        Deprecated.
        Determines if the DHTML printing is enabled.
        Returns:
        true if the preference is on, if DHTML is on and not using Netscape.
        Since:
        MicroStrategy Web 8.0.1
      • renderOrientation

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

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

        public void renderMaxAndDefaultRowsPerPage​(MarkupOutput out)
        Deprecated.
        Renders textboxes for the maximum and default rows per page.
        Parameters:
        out - the output object
      • renderMaxRowsPerPage

        public void renderMaxRowsPerPage​(MarkupOutput out)
        Deprecated.
        Renders textboxes for the maximum rows per page.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1
      • renderDefaultRowsPerPage

        public void renderDefaultRowsPerPage​(MarkupOutput out)
        Deprecated.
        Renders textboxes for the default rows per page.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1
      • renderMaxAndDefaultColsPerPage

        public void renderMaxAndDefaultColsPerPage​(MarkupOutput out)
        Deprecated.
        Renders textboxes for the maximum and default columns per page.
        Parameters:
        out - the output object
      • renderMaxColsPerPage

        public void renderMaxColsPerPage​(MarkupOutput out)
        Deprecated.
        Renders textboxes for the maximum columns per page.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1
      • renderDefaultColsPerPage

        public void renderDefaultColsPerPage​(MarkupOutput out)
        Deprecated.
        Renders textboxes for the default columns per page.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1
      • renderGridRowsPerPrintedPage

        public void renderGridRowsPerPrintedPage​(MarkupOutput out)
        Deprecated.
        Renders textbox for grid rows per page.
        Parameters:
        out - the output object
      • renderGridColsPerPrintedPage

        public void renderGridColsPerPrintedPage​(MarkupOutput out)
        Deprecated.
        Renders textbox for grid columns per page.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1
      • renderScaling

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

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

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

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

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

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

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

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

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

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

        public void renderMaxCellsAndGraphsPerBlock​(MarkupOutput out)
        Deprecated.
        Renders maximum number of cells and graphs per block.
        Parameters:
        out - the output object
      • renderMaxCellsPerBlock

        public void renderMaxCellsPerBlock​(MarkupOutput out)
        Deprecated.
        Renders maximum number of cells and graphs per block.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1
      • renderMaxGraphsPerBlock

        public void renderMaxGraphsPerBlock​(MarkupOutput out)
        Deprecated.
        Renders maximum number of cells and graphs per block.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1
      • renderHeaderAndFooterFile

        public void renderHeaderAndFooterFile​(MarkupOutput out)
        Deprecated.
        Renders textboxes for Administrator's header and footer files.
        Parameters:
        out - the output object
      • renderHeaderFile

        public void renderHeaderFile​(MarkupOutput out)
        Deprecated.
        Renders textboxes for Administrator's header and footer files.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1
      • renderFooterFile

        public void renderFooterFile​(MarkupOutput out)
        Deprecated.
        Renders textboxes for Administrator's header and footer files.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1
      • renderDisableDHTMLPrinting

        public void renderDisableDHTMLPrinting​(MarkupOutput out)
        Deprecated.
        Renders checkbox to disable DHTML printing.
        Parameters:
        out - the output object
      • renderPopUpPrintDialog

        public void renderPopUpPrintDialog​(MarkupOutput out)
        Deprecated.
        Renders checkbox for popup print dialog.
        Parameters:
        out - the output object
      • renderCoverPageFilterDetails

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

        public void renderOpenNewWindow​(MarkupOutput out)
        Deprecated.
        This preference has been moved to General Preferences
        Renders checkbox for opening a new window when printing. Displayed only in the preferences page.
        Parameters:
        out - the output object
      • renderGridGraphSamePage

        public void renderGridGraphSamePage​(MarkupOutput out)
        Deprecated.
        Render checkbox to display the grid and graph on the same page.
        Parameters:
        out - the output object
      • renderExpandPageBy

        public void renderExpandPageBy​(MarkupOutput out)
        Deprecated.
        Renders checkbox to expand pageby fields.
        Parameters:
        out - the output object
      • renderOptionsWhenPrint

        public void renderOptionsWhenPrint​(MarkupOutput out)
        Deprecated.
        Renders checkbox for showing the options page before printing.
        Parameters:
        out - the output object
      • renderAdvancedPrintButton

        public void renderAdvancedPrintButton​(MarkupOutput out)
        Deprecated.
        Renders button to display the advanced options. Displayed only on the options page.
        Parameters:
        out - the output object
      • transformFooter

        protected void transformFooter​(MarkupOutput out)
        Deprecated.
        Generates the footer of the Preferences dialog. Over ride the method in AbstractPreferenceTransform
        Overrides:
        transformFooter in class AbstractPreferencesTransform
        Parameters:
        out - where to create the output
      • renderDoNotPrompt

        public void renderDoNotPrompt​(MarkupOutput out)
        Deprecated.
        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
      • renderPrintButton

        public void renderPrintButton​(MarkupOutput out)
        Deprecated.
        Generates the submit input and related hidden inputs used to submit the information and print the report.
        Since:
        MicroStrategy Web 8.0.1
      • getTitle

        public java.lang.String getTitle()
        Deprecated.
        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.
      • getPrintEvent

        public WebEvent getPrintEvent()
        Deprecated.
        use getSaveReportPropertiesEvent()
        Returns the event used to show the printable version of the report.
        Since:
        MicroStrategy Web 8.0.1
      • getExportEventID

        protected java.lang.String getExportEventID()
        Deprecated.
        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