Class HTMLRenderOption

    • Constructor Detail

      • HTMLRenderOption

        public HTMLRenderOption​(IRenderOption options)
        Constructor
      • HTMLRenderOption

        public HTMLRenderOption​(java.util.HashMap options)
      • HTMLRenderOption

        public HTMLRenderOption()
        Default constructor.
    • Method Detail

      • setInstanceIDs

        public void setInstanceIDs​(java.util.List instanceIDs)
        Specified by:
        setInstanceIDs in interface IHTMLRenderOption
        Parameters:
        instanceIDs - The instanceIDs to set.
      • setEmbeddable

        public void setEmbeddable​(boolean embeddable)
        sets whether the HTML output can be embedded directly into an HTML page
        Specified by:
        setEmbeddable in interface IHTMLRenderOption
        Parameters:
        embeddable - whether the HTML output can be embedded directly into an HTML page
      • getEmbeddable

        public boolean getEmbeddable()
        Specified by:
        getEmbeddable in interface IHTMLRenderOption
        Returns:
        whether the output is embeddable
      • setUserAgent

        public void setUserAgent​(java.lang.String userAgent)
        Specified by:
        setUserAgent in interface IHTMLRenderOption
        Parameters:
        userAgent - the user agent of the request
      • getUserAgent

        public java.lang.String getUserAgent()
        Specified by:
        getUserAgent in interface IHTMLRenderOption
        Returns:
        the user agent for the request
      • setUrlEncoding

        public void setUrlEncoding​(java.lang.String encoding)
        Set the URL encoding for the request.
        Specified by:
        setUrlEncoding in interface IHTMLRenderOption
      • getUrlEncoding

        public java.lang.String getUrlEncoding()
        Specified by:
        getUrlEncoding in interface IHTMLRenderOption
        Returns:
        the user agent for the request
      • setIncludeSelectionHandle

        @Deprecated
        public void setIncludeSelectionHandle​(boolean option)
        Deprecated.
        includeSelectionHandle is replaced by eanableMetadata flag.
        Specified by:
        setIncludeSelectionHandle in interface IHTMLRenderOption
      • getIncludeSelectionHandle

        @Deprecated
        public boolean getIncludeSelectionHandle()
        Deprecated.
        includeSelectionHandle is replaced by eanableMetadata flag.
        Specified by:
        getIncludeSelectionHandle in interface IHTMLRenderOption
      • setHtmlTitle

        public void setHtmlTitle​(java.lang.String htmlTitle)
        Specified by:
        setHtmlTitle in interface IHTMLRenderOption
        Parameters:
        htmlTile -
      • getHtmlTitle

        public java.lang.String getHtmlTitle()
        Specified by:
        getHtmlTitle in interface IHTMLRenderOption
        Returns:
        the default html title
      • setEnableMetadata

        public void setEnableMetadata​(boolean enableMetadata)
        Sets the flag which indicating if metadata should be output.
        Specified by:
        setEnableMetadata in interface IHTMLRenderOption
        Parameters:
        enableMetadata - the flag
      • setDisplayFilterIcon

        public void setDisplayFilterIcon​(boolean displayFilterIcon)
        Sets the flag indicationg that if filter icons should be displayed.
        Specified by:
        setDisplayFilterIcon in interface IHTMLRenderOption
        Parameters:
        displayFilterIcon - the flag
      • setDisplayGroupIcon

        public void setDisplayGroupIcon​(boolean displayGroupIcon)
        Sets the flag indicationg that if group expand/collapse icons should be displayed.
        Specified by:
        setDisplayGroupIcon in interface IHTMLRenderOption
        Parameters:
        displayGroupIcon - the flag
      • getImageDirectory

        public java.lang.String getImageDirectory()
        returns the image directory that engine stores images and charts into
        Specified by:
        getImageDirectory in interface IHTMLRenderOption
        Returns:
        the image directory.
      • setImageDirectory

        public void setImageDirectory​(java.lang.String imageDirectory)
        sets the image directory that engine stores images and charts into
        Specified by:
        setImageDirectory in interface IHTMLRenderOption
        Parameters:
        imageDirectory - the image directory that engine stores images and charts into
      • getBaseImageURL

        public java.lang.String getBaseImageURL()
        returns the base url for creating image URL
        Specified by:
        getBaseImageURL in interface IHTMLRenderOption
        Returns:
        Rreturn the abse image url
      • setBaseImageURL

        public void setBaseImageURL​(java.lang.String baseImageURL)
        sets the base image URL for image handling
        Specified by:
        setBaseImageURL in interface IHTMLRenderOption
        Parameters:
        baseImageURL - the base image URL
      • setWrapTemplateTable

        public void setWrapTemplateTable​(boolean wrapTemplateTable)
        Sets the flag indicationg that if the top-level table should be wrapped.
        Parameters:
        wrapTemplateTable - the flag
      • getWrapTemplateTable

        public boolean getWrapTemplateTable()
        Returns:
        the group expand/collapse icon flag value.
      • setLayoutPreference

        public void setLayoutPreference​(java.lang.String layoutPreference)
        Sets the flag indicationg that if the table should be outed as fixed.
        Parameters:
        layoutPreference - the flag
      • getLayoutPreference

        public java.lang.String getLayoutPreference()
        Returns:
        the table layout fixed flag value.
      • setEnableAgentStyleEngine

        public void setEnableAgentStyleEngine​(boolean enableAgentStyleEngine)
        Sets the flag indicationg that agentStyleEngine is enabled or not.
        Parameters:
        enableAgentStyleEngine - True: means the HTML emitter will output the BIRT styles directly to the report and depends on the browser to implement the style calculation. False: means the HTML emitter will use BIRT style engine to calculate the styles and output the result to the report.
      • getEnableAgentStyleEngine

        public boolean getEnableAgentStyleEngine()
        Returns:
        the agentStyleEngine enabled flag value.
      • setOutputMasterPageMargins

        public void setOutputMasterPageMargins​(boolean outputMasterPageMargins)
        Sets the flag indicationg that output the master page's margins for the auto layout report or not.
        Parameters:
        outputMasterPageMargins - True: means the HTML emitter will output the master page's margins for auto report. False: means the HTML emitter won't output the master page's margins for auto report.
      • getOutputMasterPageMargins

        public boolean getOutputMasterPageMargins()
        Returns:
        the outputMasterPageMargins flag value.
      • setHTMLIDNamespace

        public void setHTMLIDNamespace​(java.lang.String id)
        sets the HTML ID namespace.
        Parameters:
        id - the viewer id
      • getHTMLIDNamespace

        public java.lang.String getHTMLIDNamespace()
        Returns:
        the HTML ID namespace.
      • setHTMLIndent

        public void setHTMLIndent​(boolean indent)
        Sets the flag indicating that if the HTML should be indented.
        Parameters:
        indent - the flag
      • getHTMLIndent

        public boolean getHTMLIndent()
        Returns:
        the HTML indent flag value. The default value is true.
      • setMetadataFilter

        public void setMetadataFilter​(IMetadataFilter filter)
      • setEnableInlineStyle

        public void setEnableInlineStyle​(boolean inlineStyleFlag)
        Sets the flag indicating that Trying to use inline style instead of CSS class style. This option only works when the report is embeddable.
        Parameters:
        inlineStyleFlag - the flag
      • getEnableInlineStyle

        public boolean getEnableInlineStyle()
        Returns:
        the inline style flag value. The default value is false. True: Try to using the inline style to instead of style class. Fals: Try to use the style class to compress the HTML source.
      • setViewportMeta

        public void setViewportMeta​(java.lang.String viewport)
        set the viewport meta information.
        Parameters:
        viewport -
      • getViewportMeta

        public java.lang.String getViewportMeta()
        Returns:
        the viewport meta information.
      • isEnableCompactMode

        public boolean isEnableCompactMode()
        Description copied from interface: IHTMLRenderOption
        returns whether to use compact mode for the HTML output, whose default value is false.
        Specified by:
        isEnableCompactMode in interface IHTMLRenderOption
        Returns:
      • setEnableCompactMode

        public void setEnableCompactMode​(boolean enableCompactMode)
        Description copied from interface: IHTMLRenderOption
        sets whether to use compact mode for the HTML output. If the compact mode was used, text indents and new line separators will be ignored.
        Specified by:
        setEnableCompactMode in interface IHTMLRenderOption
      • setBirtJsUrl

        public void setBirtJsUrl​(java.lang.String birtJsUrl)
        set the URL of head.js file
        Parameters:
        headJsUrl -
      • getBirtJsUrl

        public java.lang.String getBirtJsUrl()
        get the URL of head.js file
        Returns:
        the URL of head.js file