Package de.elo.mover.main.pdf

Class PdfFileHelper

java.lang.Object

de.elo.mover.main.pdf.PdfFileHelper

public class PdfFileHelper
extends Object

Überschrift: PdfFileHelper.

Beschreibung: Hilfsmethoden für PDF-Dateien.

Copyright: Copyright (c) ELO Digital Office GmbH 2018 - 2022

Constructor Summary

Constructors

Constructor	Description
PdfFileHelper()

Method Summary

Modifier and Type	Method	Description
static void	addFileAttachment(File pdfFile, File attachFile, String attachName)	Fügt die Datei als Anhang in der PDF-Datei ein.
static void	appendPdfToPdf(File sourceFile, File targetFile, boolean appendStart)	Hängt die PDF-Datei an der angegebenen PDF-Datei an.
static ArrayList<File>	exportFileAttachments(File pdfFile, File targetDir)	Extrahiert die Dateianhänge der angegebenen PDF-Datei im angegebenen Verzeichnis und liefert die Liste mit den Anhängen zurück.
static Dimension	getDefaultResolution()	Liefert die Default-Auflösung (300 dpi) für PDF-Dateien zurück.
static HashMap<String,String>	getMetadata(File pdfFile)	Liefert eine HashMap mit den Metadaten der angegebenen PDF-Datei zurück.
static int	getNumberOfPages(File pdfFile)	Liefert die Seitenanzahl der angegebenen PDF-Datei zurück.
static BufferedImage	getPage(File pdfFile, int page)	Liefert die angegebene Dokumentenseite der PDF-Datei zurück.
static Dimension	getPageResolution(File pdfFile, int page)	Liefert die Auflösung der angegebenen PDF-Seite zurück.
static String	getPdfFilePageText(File file, int page)	Liefert den Text aus der angegebenen PDF-Seite zurück.
static String	getPdfFileText(File file)	Liefert den Text der angegebenen PDF-Datei als String zurück.
static Dimension	getResolution(File pdfFile)	Liefert die Auflösung der angegebenen PDF-Datei zurück.
static boolean	hasPdfExtension(File file)	Meldet zurück, ob die angegebene Datei eine PDF-Dateiendung hat.
static void	insertPictureInPdf(File sourceFile, File targetFile, int page, int x, int y)	Fügt das angegebene Bild in der angegebenen Datei ein.
static void	insertPictureInPdf2(File sourceFile, File targetFile, int page, int x, int y, int width, int height)	Fügt das angegebene Bild in der angegebenen PDF-Datei ein.
static void	insertTextInPdf(String text, File targetFile, int page, int x, int y, int textSize, int colorRed, int colorGreen, int colorBlue, float transparent, int skew)	Fügt den Text in der angegebenen PDF-Datei ein.
static void	insertTextInPdf2(String text, File targetFile, int page, int x, int y, int textSize, File textFontFile, int colorRed, int colorGreen, int colorBlue, float transparent, int skew)	Fügt den Text in der angegebenen PDF-Datei ein.
static boolean	isAllPdfs(List<File> files)	Liefert true zurück, wenn die Liste nur PDF-Dateien enthält.
static boolean	isSignedPdfFile(File pdfFile)	Meldet zurück, ob die angegebene PDF-Datei signiert ist.
static boolean	isXfaPdfFile(File pdfFile)	Meldet zurück, ob die angegebene PDF-Datei eine XFA PDF-Datei ist.
static void	mergePdfFiles(File[] sourcePdfFiles, File outputFile)	Klammert die angegebenen PDF-Dateien in der angegebenen Ausgabedatei.
static void	removePage(File pdfFile, int page)	Löscht die Seite in der angegebenen Datei.
static void	saveFilePage(File sourcePdfFile, int pageNr, File targetFile)	Speichert die Seite der PDF-Datei in der angegebenen Zieldatei.
static void	setCropBox(File pdfFile, float lowerLeftX, float lowerLeftY, float upperRightX, float upperRightY)	Setzt den angegebenen abzuschneidenden Rechteck für alle Dokumentseiten.
static File[]	splitPdfFile(File pdfFile)	Entklammert die angegebene PDF-Datei und liefert eine Liste mit einseitigen Dateien oder null zurück.
static File[]	splitPdfFileBySeparPage(File pdfFile)	Trennt die angegebene PDF-Datei nach ELO-Trennseiten und liefert eine Liste mit den Ergebnisdateien zurück.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PdfFileHelper

public PdfFileHelper()

Method Details

mergePdfFiles

public static void mergePdfFiles(File[] sourcePdfFiles,
 File outputFile)
                          throws IOException,
Exception

Klammert die angegebenen PDF-Dateien in der angegebenen Ausgabedatei.

Parameters:

sourcePdfFiles - Liste mit PDF-Dateien

outputFile - Ausgabedatei

Throws:

IOException

Exception

splitPdfFile

public static File[] splitPdfFile(File pdfFile)
                           throws IOException,
Exception

Entklammert die angegebene PDF-Datei und liefert eine Liste mit einseitigen Dateien oder null zurück.

Parameters:

pdfFile - PDF-Datei

Returns:

Liste mit einseitigen PDF-Dateien

Throws:

IOException

Exception

splitPdfFileBySeparPage

public static File[] splitPdfFileBySeparPage(File pdfFile)
                                      throws Exception

Trennt die angegebene PDF-Datei nach ELO-Trennseiten und liefert eine Liste mit den Ergebnisdateien zurück.

Parameters:

pdfFile - PDF-Datei

Returns:

Liste mit getrennten PDF-Dateien

Throws:

Exception

hasPdfExtension

public static boolean hasPdfExtension(File file)
                               throws Exception

Meldet zurück, ob die angegebene Datei eine PDF-Dateiendung hat.

Parameters:

file - Datei

Returns:

Datei hat die Dateiendung pdf

Throws:

Exception

isAllPdfs

public static boolean isAllPdfs(List<File> files)
                         throws Exception

Liefert true zurück, wenn die Liste nur PDF-Dateien enthält.

Parameters:

files - Liste mit Dateien

Returns:

Nur PDF-Dateien enthalten

Throws:

Exception

insertPictureInPdf

public static void insertPictureInPdf(File sourceFile,
 File targetFile,
 int page,
 int x,
 int y)
                               throws IOException,
Exception

Fügt das angegebene Bild in der angegebenen Datei ein.

Parameters:

sourceFile - Datei, die eingebettet wird

targetFile - Zieldatei

page - Dokumentenseite, in der die angegebene Datei eingebettet wird

x - Relative x-Position (Eingabe zwischen 0 und 1000)

y - Relative y-Position (Eingabe zwischen 0 und 1000)

Throws:

IOException

Exception

insertPictureInPdf2

public static void insertPictureInPdf2(File sourceFile,
 File targetFile,
 int page,
 int x,
 int y,
 int width,
 int height)
                                throws IOException,
Exception

Fügt das angegebene Bild in der angegebenen PDF-Datei ein.

Parameters:

sourceFile - Datei, die eingebettet wird

targetFile - Zieldatei

page - Dokumentenseite, in der die angegebene Datei eingebettet wird

x - Relative x-Position (Eingabe zwischen 0 und 1000)

y - Relative y-Position (Eingabe zwischen 0 und 1000)

width - Breite des Bildes

height - Höhe des Bildes

Throws:

IOException

Exception

insertTextInPdf

public static void insertTextInPdf(String text,
 File targetFile,
 int page,
 int x,
 int y,
 int textSize,
 int colorRed,
 int colorGreen,
 int colorBlue,
 float transparent,
 int skew)
                            throws Exception

Fügt den Text in der angegebenen PDF-Datei ein.

Parameters:

text - Einzufügender Text

targetFile - PDF-Datei, in der der Text eingefügt wird

page - Dokumentenseite, in der der Text eingefügt wird

x - Relative x-Position (Eingabe zwischen 0 und 1000)

y - Relative y-Position (Eingabe zwischen 0 und 1000)

textSize - Textgröße

colorRed - Anteil der roten Farbe (Eingabe zwischen 0 und 255)

colorGreen - Anteil der grünen Farbe (Eingabe zwischen 0 und 255)

colorBlue - Anteil der blauen Farbe (Eingabe zwischen 0 und 255)

transparent - Transparenz (Eingabe zwischen 0 und 1)

skew - Drehwinkel

Throws:

Exception

insertTextInPdf2

public static void insertTextInPdf2(String text,
 File targetFile,
 int page,
 int x,
 int y,
 int textSize,
 File textFontFile,
 int colorRed,
 int colorGreen,
 int colorBlue,
 float transparent,
 int skew)
                             throws Exception

Fügt den Text in der angegebenen PDF-Datei ein.

Parameters:

text - Einzufügender Text

targetFile - PDF-Datei, in der der Text eingefügt wird

page - Dokumentenseite, in der der Text eingefügt wird

x - Relative x-Position (Eingabe zwischen 0 und 1000)

y - Relative y-Position (Eingabe zwischen 0 und 1000)

textSize - Textgröße

textFontFile - Datei mit der Schriftart

colorRed - Anteil der roten Farbe (Eingabe zwischen 0 und 255)

colorGreen - Anteil der grünen Farbe (Eingabe zwischen 0 und 255)

colorBlue - Anteil der blauen Farbe (Eingabe zwischen 0 und 255)

transparent - Transparenz (Eingabe zwischen 0 und 1)

skew - Drehwinkel

Throws:

Exception

getPdfFileText

public static String getPdfFileText(File file)
                             throws IOException,
Exception

Liefert den Text der angegebenen PDF-Datei als String zurück.

Parameters:

file - PDF-Datei

Returns:

Text in der Datei

Throws:

IOException

Exception

getPdfFilePageText

public static String getPdfFilePageText(File file,
 int page)
                                 throws IOException,
Exception

Liefert den Text aus der angegebenen PDF-Seite zurück.

Parameters:

file - PDF-Datei

page - Dokumentseite

Returns:

Text aus der Dokumentseite

Throws:

IOException

Exception

appendPdfToPdf

public static void appendPdfToPdf(File sourceFile,
 File targetFile,
 boolean appendStart)
                           throws Exception

Hängt die PDF-Datei an der angegebenen PDF-Datei an.

Parameters:

sourceFile - PDF-Datei, die angehängt wird

targetFile - Ziel-Datei, an der die PDF-Datei angehängt wird

appendStart - Am Dokumentanfang anhängen

Throws:

Exception

getNumberOfPages

public static int getNumberOfPages(File pdfFile)
                            throws Exception

Liefert die Seitenanzahl der angegebenen PDF-Datei zurück.

Parameters:

pdfFile - PDF-Datei

Returns:

Seitenanzahl

Throws:

Exception

removePage

public static void removePage(File pdfFile,
 int page)
                       throws Exception

Löscht die Seite in der angegebenen Datei.

Parameters:

pdfFile - PDF-Datei

page - Seite

Throws:

Exception

getResolution

public static Dimension getResolution(File pdfFile)
                               throws Exception

Liefert die Auflösung der angegebenen PDF-Datei zurück.

Parameters:

pdfFile - PDF-Datei

Returns:

Auflösung der Datei

Throws:

Exception

getPageResolution

public static Dimension getPageResolution(File pdfFile,
 int page)
                                   throws Exception

Liefert die Auflösung der angegebenen PDF-Seite zurück.

Parameters:

pdfFile - PDF-Datei

page - Dokumentseite (beginnend bei 1)

Returns:

Auflösung der Dokumentseite

Throws:

Exception

getDefaultResolution

public static Dimension getDefaultResolution()

Liefert die Default-Auflösung (300 dpi) für PDF-Dateien zurück.

Returns:

Default-Auflösung

addFileAttachment

public static void addFileAttachment(File pdfFile,
 File attachFile,
 String attachName)
                              throws Exception

Fügt die Datei als Anhang in der PDF-Datei ein.

Parameters:

pdfFile - PDF-Datei

attachFile - Anhangdatei

attachName - Name des Dateianhangs (ohne die Dateiendung)

Throws:

Exception

exportFileAttachments

public static ArrayList<File> exportFileAttachments(File pdfFile,
 File targetDir)
                                             throws Exception

Extrahiert die Dateianhänge der angegebenen PDF-Datei im angegebenen Verzeichnis und liefert die Liste mit den Anhängen zurück.

Parameters:

pdfFile - PDF-Datei

targetDir - Zielverzeichnis

Returns:

Liste mit den Dateianhängen

Throws:

Exception

getPage

public static BufferedImage getPage(File pdfFile,
 int page)
                             throws Exception

Liefert die angegebene Dokumentenseite der PDF-Datei zurück.

Parameters:

pdfFile - PDF-Datei

page - Nummer der Dokumentenseite

Returns:

Dokumentenseite als BufferedImage

Throws:

Exception

setCropBox

public static void setCropBox(File pdfFile,
 float lowerLeftX,
 float lowerLeftY,
 float upperRightX,
 float upperRightY)
                       throws Exception

Setzt den angegebenen abzuschneidenden Rechteck für alle Dokumentseiten.

Parameters:

pdfFile - PDF-Datei

lowerLeftX - Untere linke horizontale Position

lowerLeftY - Untere linke vertikale Position

upperRightX - Obere rechte horizontale Position

upperRightY - Obere rechte vertikale Position

Throws:

Exception

saveFilePage

public static void saveFilePage(File sourcePdfFile,
 int pageNr,
 File targetFile)
                         throws Exception

Speichert die Seite der PDF-Datei in der angegebenen Zieldatei.

Parameters:

sourcePdfFile - PDF-Datei, deren Seite gespeichert wird

pageNr - Nummer der Dokumentenseite

targetFile - Zieldatei

Throws:

Exception

getMetadata

public static HashMap<String,String> getMetadata(File pdfFile)
                                          throws Exception

Liefert eine HashMap mit den Metadaten der angegebenen PDF-Datei zurück.

Parameters:

pdfFile - PDF-Datei

Returns:

HashMap mit den Metadaten

Throws:

Exception

isSignedPdfFile

public static boolean isSignedPdfFile(File pdfFile)
                               throws Exception

Meldet zurück, ob die angegebene PDF-Datei signiert ist.

Parameters:

pdfFile - PDF-Datei

Returns:

PDF-Datei ist signiert

Throws:

Exception

isXfaPdfFile

public static boolean isXfaPdfFile(File pdfFile)
                            throws Exception

Meldet zurück, ob die angegebene PDF-Datei eine XFA PDF-Datei ist.

Parameters:

pdfFile - PDF-Datei

Returns:

PDF-Datei ist eine XFA-Datei

Throws:

Exception