PDF-Viewer

Der PDF-Viewer ermöglicht die Anzeige und Interaktion mit PDF-Dokumenten.

Overview

Intro

Üblicherweise kommt der PDF-Viewer überall dort zum Einsatz, wo Nutzer in der Anwendung PDF-Dateien generieren und weiterverarbeiten. Der PDF-Viewer hilft im Anwendungsbereich PDF-Dateien klar und gut erkennbar darstellen zu können.

1 PDF Viewer

Verwendung

👍 Do	👎 Don't
... wenn nur einzelne PDFs generiert werden müssen. ...wenn PDFs versendet, gedruckt oder gespeichert werden müssen. ... wenn PDFs nicht weiter bearbeitet werden müssen.	... wenn Online Signaturen oder Signaturstempel vorliegen. ... wenn ein Zusammenspiel mit ZUGFeRD und XRechnung notwendig ist.

Der PDF-Viewer soll verwendet werden, wenn PDFs in Anwendungen angezeigt, versendet oder heruntergeladen werden müssen.

Muss das PDF bearbeitet oder eine große PDF-Datei generiert werden, soll der PDF-Viewer  nicht  verwendet werden. Für solche Fälle ist der CIB PDF-Viewer vorgesehen, welcher bereits in OK.FINN genutzt und in Zukunft in der kompletten AKDB ausgerollt werden soll. Der CIB PDF-Viewer ermöglicht es, in der Anwendung PDF-Dateien zu generieren, anzuzeigen und ausführlich zu bearbeiten.

Guidelines

Aufbau

Die wichtigsten Zustände der Komponente können über die Varianten bestimmt werden.

In der PDF-Viewer Toolleiste (1) lässt sich das Ein- und Ausblenden der Seitenleiste, sowie der Zoom steuern. Über ein Inputfield lässt sich eine beliebige Seitenzahl eingeben, auf die der Viewer sofort springt. Mit den Chevron Icons lässt sich in dem PDF blättern. Die Action-Icons für “Drucken”, “Weiterleiten” und “Herunterladen” lassen sich, je nach Notwendigkeit ein- oder ausblenden.

	PDF Toolbar: Seitenübersicht eingeklappt
	PDF Toolbar: Seitenübersicht ausgeklappt

Im Dokument-Bereich lässt sich eine Seitenübersicht (2) linksbündig ein und ausblenden, sowie Splitlayout (4) aktivieren oder deaktivieren. Je nach Zoomstufe werden eine horizontale und vertikale Scrollbar (3) eingeblendet.

4 Aufbau PDF

Anordnung & Gruppierung

Embedded-View inkl. Split Layout

Die Komponente beinhaltet klickbare Icons, eine Zoomfunktion über ein Drop-down-Menü, die Anzeige von der Gesamtseitenzahl und der aktuellen Seitenzahl mit schneller Seitenauswahl und Blättern-Funktion. Optional kann eine Seitenübersicht am linken Seitenrand ein- oder ausgeklappt werden. Dank Split-View ist die Komponente separat vom Arbeitsbereich und kann flexibel links oder rechts eingefügt werden. Der PDF-Viewer kann über den gesamten Arbeitsbereich skaliert werden.

Download und Split Layout enabled

Embedded-View ohne Download-Funktion

Diese Komponente ermöglicht Zoom über voreingestellte Stufen per Drop-down-Menü und zeigt die Gesamtseitenzahl und aktuelle Seitenzahl mit schneller Seitenauswahl und Blättern-Funktion an. Eine Seitenübersicht kann optional am linken Seitenrand ein- oder ausgeklappt werden. Diese Variante wird zur reinen Anzeige eines PDF genutzt. Das PDF kann nicht heruntergeladen, weitergeleitet oder gedruckt werden. Funktionale Icons sind ausgeblendet.

Download disabled

Varianten/Typen

Seitenübersicht eingeklappt, Splitview enabled

Seitenübersicht ausgeklappt, Splitview enabled

Seitenübersicht eingeklappt, Splitview disabled

Seitenübersicht ausgeklappt, Splitview disabled

Verhalten

Der PDF-Viewer wird zum Anzeigen, Versenden und Herunterladen von PDFs in Anwendungen empfohlen.

Für Bearbeitungen oder Generierung großer PDF-Dateien sollte stattdessen der CIB PDF-Viewer verwendet werden, der bereits in OK.FINN implementiert ist und zukünftig in der gesamten AKDB eingeführt werden soll.

Barrierefreiheit

Tastaturbedienung

Über die Tabulatortaste ("Tab") lässt sich in der Funktionsleiste im Kopfbereich zwischen den Icon-Buttons, der Zoomauswahl, der "Blättern" Funktion und der schnellen Seitenauswahl navigieren. Mit "Enter" lassen sich die Icon-Buttons klicken, bzw. das Drop-Down für den Zoom öffnen. Im Drop-Down mit den Pfeiltasten den gewünschten Zoom auswählen und mit "Enter" bestätigen. In der schnellen Seitenauswahl kein eine beliebige Seitenzahl eingegeben werden, welche sofort aufgerufen wird.

Scrollen im PDF-Dokument ist über die Pfeiltasten möglich.

Code Examples

Install

Maven

<dependency>
    <groupId>org.vaadin.addons.componentfactory</groupId>
    <artifactId>vcf-pdf-viewer-flow</artifactId>
</dependency>

Import

import org.vaadin.addons.componentfactory.pdfviewer.PdfViewer;

Variants

Default

Display a PDF from a stream resource.

StreamResource resource = new StreamResource("document.pdf",
    () -> getClass().getResourceAsStream("/documents/document.pdf"));

PdfViewer pdfViewer = new PdfViewer();
pdfViewer.setSrc(resource);
pdfViewer.setHeight("600px");

From URL

PdfViewer pdfViewer = new PdfViewer();
pdfViewer.setSrc("https://example.com/document.pdf");
pdfViewer.setHeight("600px");