Class PreferencesPrintHeaderFooterTransform

    • Field Detail

      • pageNumberImage

        @Deprecated
        protected FormalParameter pageNumberImage
        Deprecated.
        image is not used anymore as we now use a pulldown
        Specifies the image on the header/footer editor's toolbar used for adding the page number to a header/footer section.
        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.
      • numberOfPagesImage

        @Deprecated
        protected FormalParameter numberOfPagesImage
        Deprecated.
        image is not used anymore as we now use a pulldown
        Specifies the image on the header/footer editor's toolbar used for adding the number of pages to a header/footer section.
        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.
      • dateImage

        @Deprecated
        protected FormalParameter dateImage
        Deprecated.
        image is not used anymore as we now use a pulldown
        Specifies the image on the header/footer editor's toolbar used for adding the date to a header/footer section.
        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.
      • timeImage

        @Deprecated
        protected FormalParameter timeImage
        Deprecated.
        image is not used anymore as we now use a pulldown
        Specifies the image on the header/footer editor's toolbar used for adding the time to a header/footer section.
        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.
      • projectNameImage

        @Deprecated
        protected FormalParameter projectNameImage
        Deprecated.
        image is not used anymore as we now use a pulldown
        Specifies the image on the header/footer editor's toolbar used for adding the project name to a header/footer section.
        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.
      • reportNameImage

        @Deprecated
        protected FormalParameter reportNameImage
        Deprecated.
        image is not used anymore as we now use a pulldown
        Specifies the image on the header/footer editor's toolbar used for adding the report name to a header/footer section.
        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.
      • templateNameImage

        @Deprecated
        protected FormalParameter templateNameImage
        Deprecated.
        image is not used anymore as we now use a pulldown
        Specifies the image on the header/footer editor's toolbar used for adding the template name to a header/footer section.
        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.
      • filterNameImage

        @Deprecated
        protected FormalParameter filterNameImage
        Deprecated.
        image is not used anymore as we now use a pulldown
        Specifies the image on the header/footer editor's toolbar used for adding the filter name to a header/footer section.
        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.
      • filterDetailsImage

        @Deprecated
        protected FormalParameter filterDetailsImage
        Deprecated.
        image is not used anymore as we now use a pulldown
        Specifies the image on the header/footer editor's toolbar used for adding the filter details to a header/footer section.
        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.
      • userNameImage

        @Deprecated
        protected FormalParameter userNameImage
        Deprecated.
        image is not used anymore as we now use a pulldown
        Specifies the image on the header/footer editor's toolbar used for adding the user name to a header/footer section.
        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.
      • pageByImage

        @Deprecated
        protected FormalParameter pageByImage
        Deprecated.
        image is not used anymore as we now use a pulldown
        Specifies the image on the header/footer editor's toolbar used for adding the page-by information to a header/footer section.
        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.
      • _hasReportProperties

        protected boolean _hasReportProperties
        Since:
        MicroStrategy Web 8.0.1
      • _propertyValues

        protected HashList _propertyValues
        Since:
        MicroStrategy Web 8.0.1
      • _projectPropertyValues

        protected HashList _projectPropertyValues
        Since:
        MicroStrategy Web 8.0.1
    • Constructor Detail

      • PreferencesPrintHeaderFooterTransform

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

      • generateAnchor

        protected AnchorTag generateAnchor​(WebEvent event)
        Overwrites the parent method by setting special attributes if the event is not provided
        Overrides:
        generateAnchor in class AbstractAppTransform
        Parameters:
        event - WebEvent instance from where the anchor will be constructed
        Returns:
        AnchorTag initialized instance with the information as provided
        Since:
        MicroStrategy Web 8.0.0
      • generateOptions

        protected void generateOptions​(MarkupOutput out)
        Generate the different options the user can add to the header/footer, such as date, page number, etc.
        Parameters:
        out - MarkupOutput instance where the HTML content will be saved.
        Since:
        MicroStrategy Web 8.0.0
      • renderMacroButtons

        public void renderMacroButtons​(MarkupOutput out)

        Renders the list of macros fields available for the headers and footers of a report. Each macro is rendered as a button, when the button is clicked, the macro's text is appended to the currently selected field.

        The list of available macros is obtained from the getButtonList() method.
        Since:
        MicroStrategy Web 8.0.1
      • canHavePageByMacro

        public boolean canHavePageByMacro()
        Returns true if the macro to add page-by information is available.
        Since:
        MicroStrategy Web 8.0.1
      • generateImageAnchor

        protected void generateImageAnchor​(MarkupOutput out,
                                           java.lang.String name,
                                           java.lang.String imageSource,
                                           java.lang.String tooltip)
        Generate an image anchor for the options for the print header/footer preferences, depending if the current environment is HTML or DHTML.
        Parameters:
        out - MarkupOutput instance where the HTML content generated will be saved.
        name - String name of the image to render
        imageSource - String location of the image to display
        tooltip - String with tooltip information about the button to render
        Since:
        MicroStrategy Web 8.0.0
      • renderHeaderLeft

        public void renderHeaderLeft​(MarkupOutput out)
        Generate the left header portion of the preferences dialog
        Parameters:
        out - MarkupOutput instance where the HTML output generated will be saved
        Since:
        MicroStrategy Web 7.5.1
      • renderHeaderCenter

        public void renderHeaderCenter​(MarkupOutput out)
        Render the center header portion of the preferences dialog
        Parameters:
        out - MarkupOutput instance where the HTML output generated will be saved
        Since:
        MicroStrategy Web 7.5.1
      • renderHeaderRight

        public void renderHeaderRight​(MarkupOutput out)
        Render the right header portion of the preferences dialog
        Parameters:
        out - MarkupOutput instance where the HTML output generated will be saved
        Since:
        MicroStrategy Web 7.5.1
      • renderFooterLeft

        public void renderFooterLeft​(MarkupOutput out)
        Render the left footer portion of the preferences dialog
        Parameters:
        out - MarkupOutput instance where the HTML output generated will be saved
        Since:
        MicroStrategy Web 7.5.1
      • renderFooterCenter

        public void renderFooterCenter​(MarkupOutput out)
        Render the center footer portion of the preferences dialog
        Parameters:
        out - MarkupOutput instance where the HTML output generated will be saved
        Since:
        MicroStrategy Web 7.5.1
      • renderFooterRight

        public void renderFooterRight​(MarkupOutput out)
        Render the right footer portion of the preferences dialog
        Parameters:
        out - MarkupOutput instance where the HTML output generated will be saved
        Since:
        MicroStrategy Web 7.5.1