Interface IHTMLRenderOption

All Superinterfaces:
IRenderOption, ITaskOption
All Known Implementing Classes:
HTMLEmitterConfig, HTMLRenderOption

public interface IHTMLRenderOption extends IRenderOption
Interface of constants of the HTML Render Opitons. This interface is implemented only by: HTMLRenderOption so far. The implementation classes should have the methods in order to support then HTML render options, including getter and setter.
  • Field Details

    • HTML_TYPE

      static final String HTML_TYPE
      Define the type of the html content, it can be one of: HTML or HTML_NOCSS.
      See Also:
    • HTML

      static final String HTML
      Output a complete HTML
      See Also:
    • HTML_NOCSS

      static final String HTML_NOCSS
      Output a HTML fragement without CSS defination.
      See Also:
    • USER_AGENT

      static final String USER_AGENT
      The agent used to render the html output.
      See Also:
    • URL_ENCODING

      static final String URL_ENCODING
      for some case, the user needs to define the resource encoding. It is used to encoding the hyperlinks which refers to the local resource. The value is a encode name, such as "utf-8".
      See Also:
    • INSTANCE_ID_LIST

      static final String INSTANCE_ID_LIST
      The list used to contain the active object ids. The value is a List object. The active objects including: Tempalate, Table, Chart, Label. the object in the list is a string, which is : bookmark, type, id.
      See Also:
    • MASTER_PAGE_CONTENT

      static final String MASTER_PAGE_CONTENT
      Should the report contains page header and footer The value is a Boolean object, default is Boolean.TRUE Only effect if the HTML_Pagination is true
      See Also:
    • HTML_INCLUDE_SELECTION_HANDLE

      @Deprecated static final String HTML_INCLUDE_SELECTION_HANDLE
      Deprecated.
      use METADATA
      Should we output the selection handle with the active object. The value is a Boolean Object, the default is Boolean.FALSE.
      See Also:
    • HTML_RTL_FLAG

      static final String HTML_RTL_FLAG
      Should we output HTML as RtL. The value is an Boolean Object, the default is Boolean.FALSE.
      See Also:
    • HTML_TITLE

      static final String HTML_TITLE
      Output the HTML default title. value???
      See Also:
    • HTML_ENABLE_METADATA

      static final String HTML_ENABLE_METADATA
      Should the output contain metadata. This value is a Boolean Object. And if it's set to be Boolean.TRUE., the output will contains metadata include: Instance id, type and so on The default value is Boolean.FALSE
      See Also:
    • HTML_DISPLAY_FILTER_ICON

      static final String HTML_DISPLAY_FILTER_ICON
      Should the output display the filter icon. Only effect if the enable metadata is setting to Boolea.TRUE. The default value is Boolean.FALSE
      See Also:
    • HTML_DISPLAY_GROUP_ICON

      static final String HTML_DISPLAY_GROUP_ICON
      Should the output display the group icon. Only effect if the enable metadata is setting to Boolea.TRUE. The default value is Boolean.FALSE
      See Also:
    • IMAGE_DIRECTROY

      static final String IMAGE_DIRECTROY
      See Also:
    • BASE_IMAGE_URL

      static final String BASE_IMAGE_URL
      See Also:
    • LAYOUT_PREFERENCE_FIXED

      static final String LAYOUT_PREFERENCE_FIXED
      See Also:
    • LAYOUT_PREFERENCE_AUTO

      static final String LAYOUT_PREFERENCE_AUTO
      See Also:
    • HTML_VIEWPORT_META

      static final String HTML_VIEWPORT_META
      See Also:
    • HTML_WRAP_TEMPLATE_TABLE

      static final String HTML_WRAP_TEMPLATE_TABLE
      Should the top-level template table be wrapped. Only effect if the enable metadata is setting to Boolea.TRUE. The default value is Boolean.FALSE
      See Also:
    • HTML_LAYOUT_PREFERENCE

      static final String HTML_LAYOUT_PREFERENCE
      Should the table be outed as fixed. The default value is Boolean.FALSE
      See Also:
    • HTML_ENABLE_AGENTSTYLE_ENGINE

      static final String HTML_ENABLE_AGENTSTYLE_ENGINE
      Should the HTML emitter output the BIRT styles directly to the report. The default value is Boolean.FALSE 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.
      See Also:
    • HTML_OUTPUT_MASTER_PAGE_MARGINS

      static final String HTML_OUTPUT_MASTER_PAGE_MARGINS
      Should the HTML emitter output the master page's margins. This property is only works for the auto layout report. The fixed report will always output the master page's margins. The default value is Boolean.FALSE 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.
      See Also:
    • HTML_ID_NAMESPACE

      static final String HTML_ID_NAMESPACE
      HTMLIDNamespace is used to solve the name conflict problem when embedding multiple reports into one page.
      See Also:
    • HTML_INDENT

      static final String HTML_INDENT
      whether or not the HTML is indented. The default value is true.
      See Also:
    • METADATA_FILTER

      static final String METADATA_FILTER
      A filter for metadata.
      See Also:
    • HTML_ENABLE_INLINE_STYLE

      static final String HTML_ENABLE_INLINE_STYLE
      Using inline style or not. This option only works when the report is embeddable. True: Try to using the inline style to instead of style class. False: Try to use the style class to compress the HTML source.
      See Also:
    • HTML_ENABLE_COMPACT_MODE

      static final String HTML_ENABLE_COMPACT_MODE
      Using compact mode or not. If compact mode is enabled, text indents and new line separators will be ignored in html output.
      See Also:
    • BIRT_JS_URL_KEY

      static final String BIRT_JS_URL_KEY
      the URL of head.js file
      See Also:
  • Method Details

    • getInstanceIDs

      List getInstanceIDs()
      Returns:
      Returns the instanceIDs.
    • setInstanceIDs

      void setInstanceIDs(List instanceIDs)
      Parameters:
      instanceIDs - The instanceIDs to set.
    • setEmbeddable

      void setEmbeddable(boolean embeddable)
      sets whether the HTML output can be embedded directly into an HTML page
      Parameters:
      embeddable - whether the HTML output can be embedded directly into an HTML page
    • getEmbeddable

      boolean getEmbeddable()
      Returns:
      whether the output is embeddable
    • setUserAgent

      void setUserAgent(String userAgent)
      Parameters:
      userAgent - the user agent of the request
    • getUserAgent

      String getUserAgent()
      Returns:
      the user agent for the request
    • setUrlEncoding

      void setUrlEncoding(String encoding)
    • getUrlEncoding

      String getUrlEncoding()
      Returns:
      the user agent for the request
    • setMasterPageContent

      void setMasterPageContent(boolean show)
      Set master page content.
      Parameters:
      show -
    • getMasterPageContent

      boolean getMasterPageContent()
      Get master page content.
      Returns:
    • setHtmlPagination

      void setHtmlPagination(boolean paginate)
      Set Html pagination.
      Parameters:
      paginate -
    • getHtmlPagination

      boolean getHtmlPagination()
      Get Html pagination.
      Returns:
    • setIncludeSelectionHandle

      @Deprecated void setIncludeSelectionHandle(boolean option)
      Deprecated.
      includeSelectionHandle is replaced by eanableMetadata flag.
    • getIncludeSelectionHandle

      @Deprecated boolean getIncludeSelectionHandle()
      Deprecated.
      includeSelectionHandle is replaced by eanableMetadata flag.
    • setHtmlRtLFlag

      void setHtmlRtLFlag(boolean flag)
      Set Html RTL flag.
      Parameters:
      flag -
    • getHtmlRtLFlag

      boolean getHtmlRtLFlag()
      Get Html RTL flag.
      Returns:
    • setHtmlTitle

      void setHtmlTitle(String htmlTitle)
      Parameters:
      htmlTile -
    • getHtmlTitle

      String getHtmlTitle()
      Returns:
      the default html title
    • setPageFooterFloatFlag

      void setPageFooterFloatFlag(boolean flag)
      Set page footer float flag.
      Parameters:
      flag -
    • getPageFooterFloatFlag

      boolean getPageFooterFloatFlag()
      Get page footer float flag.
      Returns:
    • setEnableMetadata

      void setEnableMetadata(boolean enableMetadata)
      Sets the flag which indicating if metadata should be output.
      Parameters:
      enableMetadata - the flag
    • getEnableMetadata

      boolean getEnableMetadata()
      Returns:
      the enable metadata flag value.
    • setDisplayFilterIcon

      void setDisplayFilterIcon(boolean displayFilterIcon)
      Sets the flag indicationg that if filter icons should be displayed.
      Parameters:
      displayFilterIcon - the flag
    • getDisplayFilterIcon

      boolean getDisplayFilterIcon()
      Returns:
      the display filter icon flag value.
    • setDisplayGroupIcon

      void setDisplayGroupIcon(boolean displayFilterIcon)
      Sets the flag indicationg that if group expand/collapse icons should be displayed.
      Parameters:
      displayFilterIcon - the flag
    • getDisplayGroupIcon

      boolean getDisplayGroupIcon()
      Returns:
      the group expand/collapse icon flag value.
    • getImageDirectory

      String getImageDirectory()
      returns the image directory that engine stores images and charts into
      Returns:
      the image directory.
    • setImageDirectory

      void setImageDirectory(String imageDirectory)
      sets the image directory that engine stores images and charts into
      Parameters:
      imageDirectory - the image directory that engine stores images and charts into
    • getBaseImageURL

      String getBaseImageURL()
      returns the base url for creating image URL
      Returns:
      Rreturn the abse image url
    • setBaseImageURL

      void setBaseImageURL(String baseImageURL)
      sets the base image URL for image handling
      Parameters:
      baseImageURL - the base image URL
    • isEnableCompactMode

      boolean isEnableCompactMode()
      returns whether to use compact mode for the HTML output, whose default value is false.
      Returns:
    • setEnableCompactMode

      void setEnableCompactMode(boolean enableCompactMode)
      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.
      Parameters:
      enableCompactMode -