Last Updated: 

Convert HTML to PDF in Java using iText

In modern software development, there are often requirements to convert HTML content into PDF format. This can be useful in various scenarios such as generating reports, invoices, or creating printable versions of web pages. Java is a popular programming language, and iText is a well-known library that provides powerful tools for working with PDF documents. In this blog post, we will explore how to convert HTML to PDF in Java using iText.

Table of Contents#

  1. Core Concepts
  2. Typical Usage Scenarios
  3. Common Pitfalls
  4. Best Practices
  5. Code Examples
  6. Conclusion
  7. FAQ
  8. References

Core Concepts#

iText#

iText is a library for creating and manipulating PDF documents in Java (and also in.NET). It provides a wide range of features, including creating new PDF files, adding text, images, and other elements to existing PDFs, and more.

HTML to PDF Conversion#

When converting HTML to PDF, the process involves parsing the HTML content, understanding its structure (such as headings, paragraphs, lists), and then rendering it in a PDF format. iText uses XML Worker, which is an HTML to PDF converter integrated with iText, to handle this task. XML Worker can parse HTML and CSS and convert them into iText objects that can be added to a PDF document.

Typical Usage Scenarios#

Report Generation#

Businesses often need to generate reports in PDF format. These reports may contain data presented in tables, charts, and text, which can be easily represented in HTML. By converting the HTML-based report to PDF, it can be easily shared and printed.

Invoice Generation#

Invoices are commonly generated in PDF format for distribution to customers. HTML can be used to design the invoice layout, and then converted to PDF using iText for a professional and standardized look.

Archiving Web Pages#

Web pages can be converted to PDF for archiving purposes. This ensures that the content of the web page is preserved in a format that can be accessed even if the original web page is no longer available.

Common Pitfalls#

CSS Compatibility#

Not all CSS features are supported by XML Worker in iText. For example, some advanced CSS3 features like animations and transitions are not applicable in a static PDF document. This can lead to the PDF not looking exactly like the HTML page in a web browser.

Font Issues#

If the HTML uses custom fonts that are not available on the system where the conversion is taking place, the PDF may display the text in a default font. This can affect the visual appearance of the document.

Performance#

Converting large HTML files with complex structures can be time-consuming and resource-intensive. This can lead to slow performance, especially on systems with limited resources.

Best Practices#

Simplify CSS#

Use only the CSS features that are supported by iText's XML Worker. Stick to basic formatting such as font size, color, and alignment.

Embed Fonts#

To avoid font issues, embed the required fonts in the PDF document. iText provides methods to load and embed fonts in the PDF.

Optimize HTML#

Reduce the complexity of the HTML structure as much as possible. Remove any unnecessary elements or scripts that are not relevant to the content that needs to be converted.

Code Examples#

import com.itextpdf.html2pdf.HtmlConverter;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
 
public class HtmlToPdfConverter {
    public static void main(String[] args) {
        // Input HTML file path
        String htmlFilePath = "input.html";
        // Output PDF file path
        String pdfFilePath = "output.pdf";
 
        try {
            // Convert HTML to PDF
            HtmlConverter.convertToPdf(new File(htmlFilePath), new FileOutputStream(new File(pdfFilePath)));
            System.out.println("HTML converted to PDF successfully.");
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

In this example, we use the HtmlConverter class from iText to convert an HTML file to a PDF file. The convertToPdf method takes an InputStream or a File representing the HTML content and an OutputStream where the PDF will be written.

Conclusion#

Converting HTML to PDF in Java using iText is a powerful and useful feature that can be applied in many real-world scenarios. By understanding the core concepts, being aware of the common pitfalls, and following the best practices, developers can effectively use iText to generate high-quality PDF documents from HTML content.

FAQ#

Q: Can I convert HTML with JavaScript to PDF?#

A: JavaScript code in HTML will not be executed during the conversion process as PDF is a static format. You should rely on pure HTML and CSS for the content and styling.

Q: Is iText free to use?#

A: iText has both open-source and commercial versions. The open-source version has some limitations, while the commercial version provides additional features and support.

Q: How can I handle special characters in the HTML?#

A: Make sure that the HTML file is encoded correctly (e.g., UTF - 8). iText will handle the encoding during the conversion process.

References#

2025-10