Skip to content
This repository has been archived by the owner on Aug 15, 2021. It is now read-only.

Dansoftowner/PDFViewerFX

Repository files navigation

PDFViewerFX

GitHub last commit GitHub issues GitHub

A library for displaying/viewing pdf documents inside your javaFX application

This library is actually a javaFX wrapper for Mozilla's PDF.js javascript library, but with this library you don't have to deal with any javascript code, so you can just use a java object to view pdf documents in javaFX.

How to get it?

Releases are available through JitPack:

Maven

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>
<dependency>
    <groupId>com.github.Dansoftowner</groupId>
    <artifactId>PDFViewerFX</artifactId>
    <version>0.8</version>
</dependency>

Gradle

repositories {
    ...
    maven { url 'https://jitpack.io' }
}
dependencies {
    implementation 'com.github.Dansoftowner:PDFViewerFX:0.8'
}

Usage

First, you have to import the necessary class:

import com.dansoftware.pdfdisplayer.PDFDisplayer;
PDFDisplayer displayer = new PDFDisplayer();

primaryStage.setScene(new Scene(displayer.toNode())); // to create the javaFX object from the displayer, you have to use the toNode() function 
primaryStage.show();

/*
 * This method creates a FileInputStream and than wraps it into a
 * BufferedInputStream, and then read the data from it.
*/
displayer.loadPDF(new File("path/to/your/file.pdf"));

You can also load the pdf from a java.net.URL object:

/*
 * This method calls the URL.openStream() function to get the InputStream then wraps it into a
 * BufferedInputStream, and then read the data from it.
*/
displayer.loadPDF(new URL("https://www.tutorialspoint.com/jdbc/jdbc_tutorial.pdf"));

Or you can read the data from any kind of InputStream:

InputStream inputStream = getAnInputStream(); //just for representation
displayer.loadPDF(inputStream);

You can use the constructors as well:

PDFDisplayer(URL); //reads the data from the URL
PDFDisplayer(File); //reads the data from the File
PDFDisplayer(InputStream) //reads the data from the InputStream 

More operations, tutorials

If you want to deal with some other useful functions from this library, just go to the wiki page!

Projects using PDFViewerFX

If this library is used by your project, let me know in the Discussions and I will mention that in this section.

  • Document Archiver - Archive all your documents in a consistent way, which enables you to retrieve them later fast and easy.

Screenshots

alt text

alt text

alt text