Package org.idempiere.ui.zk.report

Interface IReportViewerRenderer

All Known Implementing Classes:
CSVReportViewerRenderer, HTMLReportViewerRenderer, PDFReportViewerRenderer, PSReportViewerRenderer, SSVReportViewerRenderer, TabDelimitedReportViewerRenderer, XLSReportViewerRenderer, XLSXReportViewerRenderer, XMLReportViewerRenderer
public interface IReportViewerRenderer
Service interface for rendering of report viewer content.
Implementation must be thread safe.

  • Method Details

    • getId

      String getId()
      Get id of renderer
      Returns:
      renderer id (PDF, HTML, etc)

    • getExportLabel

      String getExportLabel()
      Renderer label for export output type selection
      Returns:
      label for export output type selection

    • getPreviewLabel

      default String getPreviewLabel()
      Renderer label for preview output type selection
      Returns:
      label for preview output type selection

    • getContentType

      String getContentType()
      Get MIME content type (text/html, etc)
      Returns:
      MIME content type

    • getFileExtension

      String getFileExtension()
      Output file extension (without dot)
      Returns:
      output file extension (html, csv, xls, etc)

    • isExport

      boolean isExport()
      Is renderer support export
      Returns:
      true if renderer support export

    • isPreview

      boolean isPreview(boolean roleCanExport)
      Is renderer support preview
      Parameters:
      roleCanExport - true if role can export
      Returns:
      true if renderer support preview

    • renderMedia

      org.zkoss.util.media.AMedia renderMedia(ZkReportViewer viewer, boolean export)
      Render output media for report
      Parameters:
      viewer -
      export -
      Returns:
      media

    • isSameContentForExportAndPreview

      default boolean isSameContentForExportAndPreview()
      Is export and preview generate the exact same output
      Returns:
      true if export and preview generate the exact same output

    • makePrefix

      default String makePrefix(String name)
      Create file name prefix from name
      Parameters:
      name -
      Returns:
      file name prefix from name