Skip to content

Latest commit

 

History

History
93 lines (70 loc) · 3.5 KB

README.md

File metadata and controls

93 lines (70 loc) · 3.5 KB
Raw

jrviewer-fx

jrviewer-fx is a Jasper report viewer written completely in JavaFx. It has the following features:

  • View and zoom all pages of a Jasper report document
  • Print immediately with or without print dialog
  • Export report to following formats: PDF, HTML, XLS, XLSX, DOCX ... (need POI library)
  • Static methods to merge multiple reports to a single report

Please note

  • The jreviewer-fx need access to com.sun.javafx and com.sun.prism packages, this is enabled in default

Maven dependency

   <dependency>
     <groupId>win.zqxu</groupId>
     <artifactId>jrviewer-fx</artifactId>
     <version>latest-version</version>
   </dependency>
  • Current latest version is 0.1.1

Please note

  • You need to add jasperreports dependency individually, this design is to avoid depends on a specific version
  • You may also want to add poi dependency to support export to XLS, XLSX, DOCX, ... formats

Known bugs

  • The print dialog can not be modality, need to upgrade Java to version 8 build 152 or later.

How to use

The main class of jrviewer-fx is win.zqxu.jrviewer.JRViewerFX, it can be used in the following ways:

  • Call static methods to preview, print or export report, like
   JasperPrint document = (JasperPrint) JRLoader.loadObject(new File("test.jasper"));
   JRViewerFX.preview(owner, document);
   // or
   JRViewerFX.print(document);
   // or
   JRViewerFX.printWithPrintDialog(owner, document);
   // or
   JRViewerFX.export(document, "/path/to/target_file");
   // more methods please see API documents
   // Merge multiple reports to a single report
   JasperPrint merged = JRViewerFX.merge(report1, report2, report3, ...);
   // or
   JasperPrint merged = JRViewerFX.merge("result report name", report1, report2, report3, ...);
  • Create an instance of JRViewerFX and reuse it
   JRViewerFX viewer = new JRViewerFX();
   viewer.setReport((JasperPrint) JRLoader.loadObject(new File("test.jasper")));
   viewer.print();
   // or
   viewer.printWithPrintDialog();
   
   viewer.setReport((JasperPrint) JRLoader.loadObject(new File("test2.jasper")));
   viewer.print();

  • Import jrviewer-fx into JavaFX Scene Builder

    Open Scene Builder and click settings button right of search box, then choose JAR/FXML Manager
    First add jasperreports then add jrviewer-fx, because the jrviewer-fx depends on jasperreports
    You can add library from maven repository or local jar file

    After you import jrviewer-fx into Scene Builder, you can find JRViewerFX in Custom section
    Just drag and drop the JRViewerFX onto your pane

International

  • Extract /win/zqxu/jrviewer/jrviewer-fx.properties from jrviewer-fx-.jar and place it under /win/zqxu/jrviewer in your project, then rename it to jrviewer-fx_<locale>.properties, like jrviewer-fx_zh_CN.properties, translate all text in it into your locale, that's it.

License

Version History

  • version 0.1.1:

    [fix] compatible with JasperReports early version like 6.1.0 etc.

  • version 0.1.0

    first version of jrviewr-fx