Portable Document Format (PDF) files are the standard for sharing and preserving documents across the internet and other platforms, but working with them programmatically in Java is not straightforward. Java does not natively support the PDF file format, so to interact with them you will need to either build your own custom parsing engine, or use an off-the-shelf library.
Building your own PDF library can take years if not decades due to the sheer complexity of the format and the fact that there are many non-conforming and badly produced files that exist. The good news is that with an off-the-shelf solution you do not have to face any of these challenges, and you can build a proof of concept for your application in a matter of days. We have been building and maintaining the PDF library JPedal, which allows you to get started immediately and solve the problems that actually matter.
This guide provides an overview of common problems that developers face when working with PDFs and how to solve them using the JPedal PDF library.
What is JPedal?
JPedal is a pure Java PDF Library that makes it easy for Java developers to work with PDF Documents. JPedal is developed and maintained by a team with over 20 years of experience with Java and the PDF file format. It has a comprehensive feature set which includes viewing, rendering, printing, processing, manipulating, extracting content, interaction, and debugging.
Viewer
Rendering PDFs within an application requires a viewer capable of displaying pages accurately while supporting navigation, zooming, and other interactions. Developers typically embed PDF viewers into desktop applications.
Common challenges include ensuring high fidelity rendering, and handling large documents with ease. The following tutorials demonstrate how to implement and customize PDF viewing functionality in Java applications.
Render and rasterize
Rendering and rasterization involves converting PDFs into images. This process is commonly used for generating thumbnails or previews.
Developers often use these workflows in content management systems and document pipelines. Key considerations include image quality, resolution (DPI), performance, and memory usage. The following tutorials show how to convert PDF pages into different image formats.
Printing PDF documents from Java applications involves using the Java Print Service.
Typical use cases include newspaper creation, batch printing workflows, and document distribution. The following tutorial shows how to configure and execute PDF printing from Java.
Process
PDF processing refers to automated operations applied to documents, often in bulk. These tasks include merging, splitting, sanitizing, digital signing, and transforming files as part of larger workflows.
Developers encounter these requirements in document pipelines and backend services. Challenges include maintaining document integrity, handling broken files, and ensuring performance at scale. The tutorials below cover common processing operations and how to implement them.
- How to sign PDF files in Java (Tutorial)
- How to extract embedded files from a PDF in Java (Tutorial)
- How to attach files to a PDF in Java (Tutorial)
- PDF Merge in Java (Tutorial)
- How to remove unused objects from PDF file (Tutorial)
- How to sanitize PDF files: Removing Hidden Risks
- How to translate PDF files in Java (Tutorial)
- How to split a PDF file in Java
- How to remove blank pages from a PDF
- How to flatten PDF layers
- How to crop a PDF file in Java
- How to remove text from a PDF file in Java
Manipulate
PDF manipulation involves modifying the structure or content of a PDF document. This includes adding or removing elements, rearranging pages, and updating existing content.
These operations are common in document editing tools and workflow automation systems. The tutorials below demonstrate how to perform common modification tasks.
- How to Add Images to PDF files in Java (Tutorial)
- How to draw shapes in PDF files in Java (Tutorial)
- How to copy bookmarks from one PDF to another
- How to remove a page from a PDF file in Java
- How to Duplicate Pages in a PDF in Java
- How to N-up Pages in PDF Files in Java
- How to manipulate PDF documents in Java (Tutorial)
- How to reorder pages in a PDF
Extract content
PDF content extraction focuses on retrieving structured or unstructured data from PDF documents, including text, images, metadata, and marked content.
This is a common requirement in data processing pipelines, document analysis, and format conversion (i.e, PDF to Markdown). Developers often need to handle inconsistent layouts and text encoding issues. The tutorials below show how to extract and transform PDF content into common interchange formats.
- How to extract images from a PDF file
- How to extract clipped Images from a PDF file
- How to extract text from PDF files
- How to convert PDF files to ePUB
- How to extract structured text from PDF files
- How to extract text from a PDF as Markdown
- How to extract text from a PDF as JSON
- How to extract text from PDF files as YAML (Tutorial)
- How to read PDF metadata
- How to search a PDF file
Interaction
PDF interaction includes working with annotations, form fields, and navigational elements such as bookmarks. These features enable user input and dynamic document behaviour.
Developers implement these capabilities in applications that require user feedback such as form processing or document reviewing. The following tutorials explain how to create, modify, and extract interactive elements from PDFs.
- How to create or edit Annotations in a PDF file
- How to extract PDF file form data
- How to add bookmarks to PDF files in Java
Debug
Debugging PDF files involves inspecting their internal structure, content streams, and rendering behavior to identify issues. This is useful for when dealing with broken files or unexpected behaviour.
Typical scenarios include troubleshooting rendering errors using single step debugging, validating COS syntax, and inspecting the internal structure of a file. The tutorials below provide useful ways to inspect and diagnose PDFs that do not render correctly.
- JPedal PDF Inspector/Debugger
- JPedal PDF Inspector/Debugger pt. 2
- How to debug PDF files
- How to find PDF page size
Download JPedal
Download a JPedal trial jar to see how it works.
The JPedal PDF library allows you to solve these problems in Java
//Convenience static method (see class for additional options)
ExtractClippedImages.writeAllClippedImagesToDir("inputFileOrDirectory", "outputDir", "outputImageFormat", new String[] {"imageHeightAsFloat", "subDirectoryForHeight"});
final PdfManipulator pdf = new PdfManipulator();
pdf.loadDocument(new File("inputFile.pdf"));
pdf.addPage(1, PaperSize.A4_LANDSCAPE);
pdf.addText(1, "Hello World", 10, 10, BaseFont.HelveticaBold, 12, 1, 0.3f, 0.2f);
pdf.addImage(1, new BufferedImage(), new float[] {0, 0, 100, 100});
pdf.rotatePage(1, 90);
pdf.apply();
pdf.writeDocument(new File("outputFile.pdf"));Viewer viewer = new Viewer();
viewer.setupViewer();
viewer.executeCommand(ViewerCommands.OPENFILE, "pdfFile.pdf");
//Convenience static method (see class for additional options)
ExtractTextAsWordList.writeAllWordlistsToDir("inputFileOrDirectory", "outputDir", -1);
PdfMerge.mergeFiles(new File("inputFile1.pdf"), new File("inputFile2.pdf"), new File("outputFile.pdf"));
PdfManipulator.splitInHalf(new File("inputFile.pdf"), new File("outputFolder"), pageToSplitAt);PrintPdfPages print = new PrintPdfPages("C:/pdfs/mypdf.pdf");
if (print.openPDFFile()) {
print.printAllPages("Printer Name");
}//Convenience static method (see class for additional options)
ExtractClippedImages.writeAllClippedImagesToDir("inputFileOrDirectory", "outputDir", "outputImageFormat", new String[] {"imageHeightAsFloat", "subDirectoryForHeight"});
//Convenience static method (see class for additional options)
ArrayList resultsForPages = FindTextInRectangle.findTextOnAllPages("/path/to/file.pdf", "textToFind");
java -jar jpedal.jar --inspect "inputFile.pdf"PdfSigner.signPdf(
"inputFile.pdf",
"outputFile.pdf",
"keystorePassword",
"keystoreFile.p12",
"signerName",
"signerLocation",
"signingReason",
ACCESS_PERMISSION.P1
);What is JPedal?
JPedal is a commercial Java PDF Library that makes it easy for Java developers to work with PDF Documents in Java.
Why use JPedal?
JPedal makes it much easier to work with PDF files from Java. Because we have been actively developing our Java PDF Toolkit for over 20 years, it works with all those problem PDF files out there.
What licenses are available?
We have 2 licenses available:
'Server' for on premises and cloud servers and 'OEM' for use in a named end user applications. Both are one time fees with options support renewal after 12 months.
How to use JPedal?
Want to learn more about JPedal and how to use it, we have plenty of tutorials and guides to help you.