wt-pdf-viewer

Pdf viewer for Vaadin based on pdf.js v1.8.188 web viewer.

Features:

• Sidebar with thumbnails, document outline and attachments
• Text search in PDF text
• Previous page, next page and jump to arbitrary page
• Zooming out up to 10%, automatic zoom, zoom to actual size, fit page, full width
• Full-screen presentation Mode
• Document print
• Document download
• Rotation clockwise and counterclockwise
• Hand tool for comfortable scrolling
• Document properties
• Can show multiple pdf files on the same screen (e.g. javascripts wont fight)

Screenshot

Dependency

WT PDF Viewer is distributed via Vaadin addons maven repository (named directory). Add both dependency and Vaadin addons repository into pom.xml:

<dependency>
   <groupId>com.whitestein.vaadin.widgets</groupId>
   <artifactId>wt-pdf-viewer</artifactId>
   <version>1.0</version>
</dependency>

<repositories>
   <!-- Vaadin addons repository -->
   <repository>
      <id>vaadin-addons</id>
      <url>http://maven.vaadin.com/vaadin-addons</url>
   </repository>
</repositories>

Enable Printing

Call the wtPdfViewerPrintSupport mixin from top level of your styles.scss file. It must be called from top level; otherwise printing won't work correctly.

@import "pdfdemotheme.scss";
@import "addons.scss";
// add import of pdf viewer styles
@import "../../../VAADIN/themes/wtpdfviewer/wtpdfviewer.scss";

.pdfdemotheme {
  @include addons;
  @include pdfdemotheme;
}
// add printing styles
@include wtPdfViewerPrintSupport

Java API

Create component and show a PDF file in it:

WTPdfViewer pdfViewer = new WTPdfViewer();

// get file stream
String filename = "some-pdf-file.pdf";
InputStream dataStream = getClass().getClassLoader().getResourceAsStream(filename);

// show file in pdf viewer
pdfViewer.setResource(new StreamResource(new InputStreamSource(dataStream), filename));

// boilerplate StreamSource implementation
class InputStreamSource implements StreamSource {

	private final InputStream data;

	public InputStreamSource(InputStream data) {
		super();
		this.data = data;
	}

	@Override
	public InputStream getStream() {
		return data;
	}

}

Change visible page from Java code:

WTPdfViewer pdfViewer = new WTPdfViewer();

// basic paging
pdfViewer.firstPage();
pdfViewer.lastPage();
pdfViewer.previousPage();
pdfViewer.nextPage();

// jump to fifth page	
pdfViewer.setPage(5);

Demo Project

Demo project is in the wt-pdf-viewer-demo repository.

Development Instructions

The JavaScript viewer is in pdf.viewer.js file. The viewer uses pdf.js and pdf.worker.js files as pdf parsing engine. They are all generated from wt-vaadin-pdf.js. All three files are copied as is, do not make changes into then. If you need them to work differently, change wt-vaadin-pdf.js so that it generates whatever is necessary.

The wt-vaadin-pdf.js project is able to generate both minimized and non-minized version of javascript files. The minimized version is recommended, because the files are huge.

• 'gulp minified-pre' command generates minimized files in build/minified directory.
• 'gulp generic' command generates non-minimized files in build/generic directory.

Minimized files locations:

• viewer: build/minified/web/viewer.js,
• pdf perser: build/minified/build/pdf.js,
• worker: build/minified/build/pdf.worker.js.

Non-minimized files locations:

• viewer: build/generic/web/viewer.js,
• pdf perser: build/generic/build/pdf.js,
• worker: build/generic/build/pdf.worker.js.

Stylesheet wtpdfviewer.scss has minor changes against generated build/web/viewer.css - styles are packed into mixins.

GWT-Related Stuff

• To recompile the test widget set, run mvn vaadin:compile; if you think the widget-set changes were not picked up by the Vaadin plugin, run mvn clean package or try compiling with mvn vaadin:compile -Dgwt.compiler.force=true
• To use superdevmode, run "mvn vaadin:run-codeserver" and open superdevmode like any other project

Creating Releases

1. Push all changes to Github.
2. Prepare release: mvn clean release:prepare -Dusername=<Github Username> -Dpassword=<Github Password>
3. Perform release: mvn clean release:perform -Dusername=<Github Username> -Dpassword=<Github Password>
4. Upload the generated ZIP file from the target/checkout/target directory to https://vaadin.com/directory service.