extractPages

Code

IPdfResult extractPages(String sourcePdfFileName, String targetPdfFileName, int pageIndex)
IPdfResult extractPages(String sourcePdfFileName, String targetPdfFileName,	int pageIndexStart, int pageIndexEnd)
IPdfResult extractPages(String sourcePdfFileName, String targetPdfFileName,	List<Integer> pageIndexes)

Beschreibung

Extrahiert einzelne Seiten aus einer PDF-Datei und speichert diese in einem neuen PDF-Dokument ab.

Parameter

• sourcePdfFileName
  Name der auszulesenden PDF-Datei (mit vollständiger Pfadangabe).

• targetPdfFileName
  Name der zu generierenden PDF-Datei (mit vollständiger Pfadangabe).

• Varianten weiterer Parameter zur Definition der zu extrahierenden Seiten. 
  Die Nummerierung der Seiten beginnt mit 1. 

  • Einzelne Seite
    pageIndex - Index der Seite, die extrahiert werden soll  

  • Von-Bis Seitenbereich 
    pageIndexStart - Index der Seite, ab der extrahiert werden soll  
    pageIndexEnd - Index der Seite, bis zu der einschließlich extrahiert werden soll  

  • Individueller Seitenbereich 
    Liste von Indizes - alle enthaltenen Seiten werden genau in dieser Reihenfolge extrahiert. Dies ermöglicht auch eine Umsortierung der PDF-Datei

Rückgabe

Ergebnis der PDF Extraktion
Folgende Methoden stehen in dem Rückgabeobjekt IPdfResult zur Verfügung:

• String getFileName()
  Name der generierten PDF-Datei (mit vollständiger Pfadangabe). Der übergebene Dateiname (newPdfFileName) wird auf Gültigkeit geprüft und falls notwendig korrigiert. Ungültige Zeichen werden durch das Zeichen _ ersetzt und die Dateiendung pdf wird sofern notwendig angehängt. 

• boolean isSuccessful()
  War die PDF Extraktion erfolgreich?

• String getErrorCode()
  Liefert den Fehlercode, falls die PDF Extraktion nicht erfolgreich war. Mit Hilfe der Fehlercodes können individuelle Ausgaben im Skripting hinterlegt werden.
  Folgende Fehlercodes stehen als Konstanten in der Klasse PdfConstants zur Verfügung

  • PdfConstants.PDF_ERRORCODE_NOTSUPPORTED_FILETYPE
    Dieser Dateityp wird bei der PDF Extraktion nicht unterstützt.

  • PdfConstants.PDF_ERRORCODE_FILENOTFOUND
    Eine der übergebenen Pdf-Dateien ist nicht vorhanden.

  • PdfConstants.PDF_ERRORCODE_NOTSUPPORTED_PDFFORMAT
    Das PDF Format einer übergebenen Datei wird nicht unterstützt.

  • PdfConstants.PDF_ERRORCODE_GENERAL
    Ein allgemeiner Fehler ist bei der PDF Extraktion aufgetreten.

Beispiele

String path = "c:\\Test\\";
String sourcePdfFileName = path + "TestExtractPages.pdf";

// Extract first page 
PdfUtils.extractPages(sourcePdfFileName, path + "FirstPage.pdf",  1);

 // Extract 3 pages from index 2 to index 4
PdfUtils.extractPages(sourcePdfFileName, path + "AllPages.pdf",  2, 4);

  // Extract 3 pages from index 3 to index 1 (reverse order)
List pageIndexes = List.of(3, 2, 1);
PdfUtils.extractPages(sourcePdfFileName, path + "Reorder.pdf",  pageIndexes);