Class PdfUADocument

java.lang.Object
com.itextpdf.kernel.pdf.PdfDocument
com.itextpdf.pdfua.PdfUADocument
All Implemented Interfaces:
IEventDispatcher, Closeable, AutoCloseable

public class PdfUADocument extends PdfDocument
Creates a Pdf/UA document. This class is an extension of PdfDocument and adds the necessary configuration for PDF/UA conformance. It will add necessary validation to guide the user to create a PDF/UA compliant document.
  • Field Details

    • pdfPageFactory

      private static final IPdfPageFactory pdfPageFactory
    • LOGGER

      private static final org.slf4j.Logger LOGGER
    • config

      private PdfUAConfig config
    • warnedOnPageFlush

      private boolean warnedOnPageFlush
  • Constructor Details

    • PdfUADocument

      public PdfUADocument(PdfWriter writer, PdfUAConfig config)
      Creates a PdfUADocument instance.
      Parameters:
      writer - The writer to write the PDF document.
      config - The configuration for the PDF/UA document.
    • PdfUADocument

      public PdfUADocument(PdfWriter writer, DocumentProperties properties, PdfUAConfig config)
      Creates a PdfUADocument instance.
      Parameters:
      writer - The writer to write the PDF document.
      properties - The properties for the PDF document.
      config - The configuration for the PDF/UA document.
    • PdfUADocument

      public PdfUADocument(PdfReader reader, PdfWriter writer, PdfUAConfig config)
      Creates a PdfUADocument instance.
      Parameters:
      reader - The reader to read the PDF document.
      writer - The writer to write the PDF document.
      config - The configuration for the PDF/UA document.
    • PdfUADocument

      public PdfUADocument(PdfReader reader, PdfWriter writer, StampingProperties properties, PdfUAConfig config)
      Creates a PdfUADocument instance.
      Parameters:
      reader - The reader to read the PDF document.
      writer - The writer to write the PDF document.
      properties - The properties for the PDF document.
      config - The configuration for the PDF/UA document.
  • Method Details

    • getConformanceLevel

      public IConformanceLevel getConformanceLevel()
      {inheritDoc}
      Overrides:
      getConformanceLevel in class PdfDocument
      Returns:
      the IConformanceLevel will be null if the document does not have a conformance level specified
    • getPageFactory

      protected IPdfPageFactory getPageFactory()
      Description copied from class: PdfDocument
      Returns the factory for creating page instances.
      Overrides:
      getPageFactory in class PdfDocument
      Returns:
      The PageFactory for the PDF/UA document.
    • isClosing

      boolean isClosing()
      Returns if the document is in the closing state.
      Returns:
      true if the document is closing, false otherwise.
    • warnOnPageFlush

      void warnOnPageFlush()
      Warns the user that the page is being flushed. Will only warn once.
    • disablePageFlushingWarning

      public void disablePageFlushingWarning()
      Disables the warning for page flushing.
    • setupUAConfiguration

      private void setupUAConfiguration(PdfUAConfig config)
    • configureWriterProperties

      private static PdfWriter configureWriterProperties(PdfWriter writer)