PdfDocument (iText - kernel 9.1.0 API)

java.lang.Object
- com.itextpdf.kernel.pdf.PdfDocument

All Implemented Interfaces:

Closeable, AutoCloseable
```
public class PdfDocument
extends Object
implements Closeable
```
Main enter point to work with PDF document.

Field Summary

Fields
Modifier and Type	Field and Description
`protected PdfCatalog`	`catalog` Document catalog.
`protected boolean`	`closed`
`protected boolean`	`closeReader`
`protected boolean`	`closeWriter`
`protected DefaultFontStrategy`	`defaultFontStrategy`
`protected DocumentInfoHelper`	`documentInfoHelper`
`protected FingerPrint`	`fingerPrint`
`protected boolean`	`flushUnusedObjects` flag determines whether to write unused objects to result document
`protected boolean`	`isClosing`
`protected PdfConformance`	`pdfConformance`
`protected IPdfPageFactory`	`pdfPageFactory`
`protected PdfVersion`	`pdfVersion` Document version.
`protected StampingProperties`	`properties`
`protected PdfReader`	`reader` PdfReader associated with the document.
`protected SerializeOptions`	`serializeOptions`
`protected int`	`structParentIndex`
`protected PdfStructTreeRoot`	`structTreeRoot`
`protected TagStructureContext`	`tagStructureContext`
`protected PdfDictionary`	`trailer` Document trailed.
`protected PdfWriter`	`writer` PdfWriter associated with the document.

Constructor Summary

Constructors
Constructor and Description
`PdfDocument(PdfReader reader)` Open PDF document in reading mode.
`PdfDocument(PdfReader reader, DocumentProperties properties)` Open PDF document in reading mode.
`PdfDocument(PdfReader reader, PdfWriter writer)` Opens PDF document in the stamping mode.
`PdfDocument(PdfReader reader, PdfWriter writer, StampingProperties properties)` Open PDF document in stamping mode.
`PdfDocument(PdfWriter writer)` Open PDF document in writing mode.
`PdfDocument(PdfWriter writer, DocumentProperties properties)` Open PDF document in writing mode.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAssociatedFile(String description, PdfFileSpec fs)` Adds file associated with PDF document as a whole and identifies the relationship between them.
`void`	`addEventHandler(String type, AbstractPdfDocumentEventHandler handler)` Adds new event handler.
`void`	`addFileAttachment(String key, PdfFileSpec fs)` Adds file attachment at document level.
`PdfFont`	`addFont(PdfFont font)` Adds a `PdfFont` instance to this document so that this font is flushed automatically on document close.
`void`	`addNamedDestination(PdfString key, PdfObject value)` This methods adds new name in the Dests NameTree.
`void`	`addNamedDestination(String key, PdfObject value)` This methods adds new name in the Dests NameTree.
`PdfPage`	`addNewPage()` Creates and adds new page to the end of document.
`PdfPage`	`addNewPage(int index)` Creates and inserts new page to the document.
`PdfPage`	`addNewPage(int index, PageSize pageSize)` Creates and inserts new page to the document.
`PdfPage`	`addNewPage(PageSize pageSize)` Creates and adds new page with the specified page size.
`void`	`addOutputIntent(PdfOutputIntent outputIntent)` Adds `PdfOutputIntent` that shall specify the colour characteristics of output devices on which the document might be rendered.
`PdfPage`	`addPage(int index, PdfPage page)` Inserts page to the document.
`PdfPage`	`addPage(PdfPage page)` Adds page to the end of document.
`protected void`	`checkAndAddPage(int index, PdfPage page)` Checks page before adding and add.
`protected void`	`checkAndAddPage(PdfPage page)` Checks page before adding.
`protected void`	`checkClosingStatus()` checks whether a method is invoked at the closed document
`void`	`checkIsoConformance(IValidationContext validationContext)`
`void`	`close()` Close PDF document.
`List<PdfPage>`	`copyPagesTo(int pageFrom, int pageTo, PdfDocument toDocument)` Copies a range of pages from current document to `toDocument` appending copied pages to the end.
`List<PdfPage>`	`copyPagesTo(int pageFrom, int pageTo, PdfDocument toDocument, int insertBeforePage)` Copies a range of pages from current document to `toDocument`.
`List<PdfPage>`	`copyPagesTo(int pageFrom, int pageTo, PdfDocument toDocument, int insertBeforePage, IPdfPageExtraCopier copier)` Copies a range of pages from current document to `toDocument`.
`List<PdfPage>`	`copyPagesTo(int pageFrom, int pageTo, PdfDocument toDocument, IPdfPageExtraCopier copier)` Copies a range of pages from current document to `toDocument` appending copied pages to the end.
`List<PdfPage>`	`copyPagesTo(List<Integer> pagesToCopy, PdfDocument toDocument)` Copies a range of pages from current document to `toDocument` appending copied pages to the end.
`List<PdfPage>`	`copyPagesTo(List<Integer> pagesToCopy, PdfDocument toDocument, int insertBeforePage)` Copies a range of pages from current document to `toDocument`.
`List<PdfPage>`	`copyPagesTo(List<Integer> pagesToCopy, PdfDocument toDocument, int insertBeforePage, IPdfPageExtraCopier copier)` Copies a range of pages from current document to `toDocument`.
`List<PdfPage>`	`copyPagesTo(List<Integer> pagesToCopy, PdfDocument toDocument, IPdfPageExtraCopier copier)` Copies a range of pages from current document to `toDocument` appending copied pages to the end.
`PdfIndirectReference`	`createNextIndirectReference()` Creates next available indirect reference.
`void`	`dispatchEvent(AbstractPdfDocumentEvent event)` Dispatches an event.
`PdfFont`	`findFont(String fontProgram, String encoding)` Find `PdfFont` from loaded fonts with corresponding fontProgram and encoding or CMAP.
`void`	`flushCopiedObjects(PdfDocument sourceDoc)` Flush all copied objects and remove them from copied cache.
`protected void`	`flushFonts()` Flushes all newly added or loaded fonts.
`protected void`	`flushObject(PdfObject pdfObject, boolean canBeInObjStm)` Flush an object.
`PdfArray`	`getAssociatedFiles()` Returns files associated with PDF document.
`PdfCatalog`	`getCatalog()` Gets PDF catalog.
`PdfConformance`	`getConformance()` Get the `PdfConformance`
`PdfFont`	`getDefaultFont()` Gets default font for the document: Helvetica, WinAnsi.
`PageSize`	`getDefaultPageSize()` Gets default page size.
`com.itextpdf.commons.utils.DIContainer`	`getDiContainer()` Gets the container containing all available dependencies.
`protected Collection<PdfFont>`	`getDocumentFonts()` List all newly added or loaded fonts
`long`	`getDocumentId()` Obtains numeric document id.
`com.itextpdf.commons.actions.sequence.SequenceId`	`getDocumentIdWrapper()` Obtains document id as a `SequenceId`.
`PdfDocumentInfo`	`getDocumentInfo()` Gets document information dictionary.
`PdfEncryptedPayloadDocument`	`getEncryptedPayloadDocument()` Gets the encrypted payload of this document, or returns `null` if this document isn't an unencrypted wrapper document.
`FingerPrint`	`getFingerPrint()` Returns the object containing the registered products.
`PdfPage`	`getFirstPage()` Get the first page of the document.
`PdfFont`	`getFont(PdfDictionary dictionary)` Create a new instance of `PdfFont` or load already created one.
`PdfPage`	`getLastPage()` Gets the last page of the document.
`MemoryLimitsAwareHandler`	`getMemoryLimitsAwareHandler()` Gets current memory limits handler
`PdfString`	`getModifiedDocumentId()` Gets modified document id
`int`	`getNextStructParentIndex()` Gets next parent index of tagged document.
`int`	`getNumberOfPages()` Gets number of pages of the document.
`int`	`getNumberOfPdfObjects()` Get number of indirect objects in the document.
`PdfString`	`getOriginalDocumentId()` Gets original document id
`PdfOutline`	`getOutlines(boolean updateOutlines)` This method returns a complete outline tree of the whole document.
`PdfPage`	`getPage(int pageNum)` Gets the page by page number.
`PdfPage`	`getPage(PdfDictionary pageDictionary)` Gets the `PdfPage` instance by `PdfDictionary`.
`protected IPdfPageFactory`	`getPageFactory()` Returns the factory for creating page instances.
`String[]`	`getPageLabels()` This method retrieves the page labels from a document as an array of String objects.
`int`	`getPageNumber(PdfDictionary pageDictionary)` Gets page number by `PdfDictionary`.
`int`	`getPageNumber(PdfPage page)` Gets page number by page.
`PdfObject`	`getPdfObject(int objNum)` Gets PdfObject by object number.
`PdfVersion`	`getPdfVersion()` Gets PDF version.
`PdfReader`	`getReader()` Gets `PdfReader` associated with the document.
`SerializeOptions`	`getSerializeOptions()` Gets a persistent XMP metadata serialization options.
`PdfStructTreeRoot`	`getStructTreeRoot()` Gets `PdfStructTreeRoot` of tagged document.
`TagStructureContext`	`getTagStructureContext()` Gets document `TagStructureContext`.
`PdfDictionary`	`getTrailer()` Gets document trailer.
`PdfWriter`	`getWriter()` Gets `PdfWriter` associated with the document.
`XMPMeta`	`getXmpMetadata()` Gets XMP Metadata.
`XMPMeta`	`getXmpMetadata(boolean createNew)` Gets XMP Metadata or create a new one.
`byte[]`	`getXmpMetadataBytes()` Gets XMP Metadata.
`byte[]`	`getXmpMetadataBytes(boolean createNew)` Gets XMP Metadata or create a new one.
`boolean`	`hasEventHandler(AbstractPdfDocumentEventHandler handler)` Checks if provided event handler assigned for this document.
`boolean`	`hasOutlines()` Indicates if the document has any outlines
`void`	`initializeOutlines()` This method initializes an outline tree of the document and sets outline mode to true.
`protected void`	`initTagStructureContext()` Initialize `TagStructureContext`.
`boolean`	`isAppendMode()` Returns `true` if the document is opened in append mode, and `false` otherwise.
`boolean`	`isClosed()` Gets close status of the document.
`boolean`	`isCloseReader()` Checks, whether `close()` method will close associated PdfReader.
`boolean`	`isCloseWriter()` Checks, whether `close()` method will close associated PdfWriter.
`boolean`	`isClosing()` Checks if the document closing has been started or not.
`boolean`	`isFlushUnusedObjects()` Checks, whether `close()` will flush unused objects, e.g.
`boolean`	`isTagged()` Gets tagged status of the document.
`List<PdfIndirectReference>`	`listIndirectReferences()` Gets static copy of cross reference table.
`void`	`markStreamAsEmbeddedFile(PdfStream stream)` Marks `PdfStream` object as embedded file stream.
`void`	`movePage(int pageNumber, int insertBefore)` Moves page to new place in same document with all it tag structure
`boolean`	`movePage(PdfPage page, int insertBefore)` Moves page to new place in same document with all it tag structure
`protected void`	`open(PdfVersion newPdfVersion)` Initializes document.
`boolean`	`registerProduct(com.itextpdf.commons.actions.data.ProductData productData)` Registers a product for debugging purposes.
`void`	`removeAllHandlers()` Removes all event handlers for this document.
`void`	`removeEventHandler(AbstractPdfDocumentEventHandler handler)` Removes event handler.
`void`	`removePage(int pageNum)` Removes page from the document by page number.
`boolean`	`removePage(PdfPage page)` Removes the first occurrence of the specified page from this document, if it is present.
`void`	`setCloseReader(boolean closeReader)` Sets, whether `close()` method shall close associated PdfReader.
`void`	`setCloseWriter(boolean closeWriter)` Sets, whether `close()` method shall close associated PdfWriter.
`void`	`setDefaultPageSize(PageSize pageSize)` Sets default page size.
`void`	`setEncryptedPayload(PdfFileSpec fs)` Sets an encrypted payload, making this document an unencrypted wrapper document.
`void`	`setFlushUnusedObjects(boolean flushUnusedObjects)` Sets, whether `close()` shall flush unused objects, e.g.
`void`	`setSerializeOptions(SerializeOptions serializeOptions)` Sets a persistent XMP metadata serialization options.
`PdfDocument`	`setTagged()` Specifies that document shall contain tag structure.
`void`	`setUserProperties(boolean userProperties)` Sets the flag indicating the presence of structure elements that contain user properties attributes.
`protected void`	`setXmpMetadata(byte[] xmpMetadata)` Sets the XMP Metadata.
`void`	`setXmpMetadata(XMPMeta xmpMeta)` Sets the XMP Metadata.
`void`	`setXmpMetadata(XMPMeta xmpMeta, SerializeOptions serializeOptions)` Sets the XMP Metadata.
`protected void`	`storeDestinationToReaddress(PdfDestination destination, Consumer<PdfDestination> onPageAvailable, Consumer<PdfDestination> onPageNotAvailable)` Save destinations in a temporary storage for further copying.
`protected void`	`tryInitTagStructure(PdfDictionary str)` Initializes the new instance of document's structure tree root `PdfStructTreeRoot`.
`protected XMPMeta`	`updateDefaultXmpMetadata()` Update XMP metadata values from `PdfDocumentInfo`.
`protected void`	`updateXmpMetadata()` Updates XMP metadata.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - properties
```
protected final StampingProperties properties
```
  - writer
```
protected PdfWriter writer
```
    PdfWriter associated with the document. Not null if document opened either in writing or stamping mode.
  - reader
```
protected PdfReader reader
```
    PdfReader associated with the document. Not null if document is opened either in reading or stamping mode.
  - catalog
```
protected PdfCatalog catalog
```
    Document catalog.
  - trailer
```
protected PdfDictionary trailer
```
    Document trailed.
  - pdfVersion
```
protected PdfVersion pdfVersion
```
    Document version.
  - pdfConformance
```
protected PdfConformance pdfConformance
```
  - fingerPrint
```
protected FingerPrint fingerPrint
```
  - serializeOptions
```
protected SerializeOptions serializeOptions
```
  - structTreeRoot
```
protected PdfStructTreeRoot structTreeRoot
```
  - structParentIndex
```
protected int structParentIndex
```
  - closeReader
```
protected boolean closeReader
```
  - closeWriter
```
protected boolean closeWriter
```
  - isClosing
```
protected boolean isClosing
```
  - closed
```
protected boolean closed
```
  - flushUnusedObjects
```
protected boolean flushUnusedObjects
```
    flag determines whether to write unused objects to result document
  - tagStructureContext
```
protected TagStructureContext tagStructureContext
```
  - documentInfoHelper
```
protected DocumentInfoHelper documentInfoHelper
```
  - defaultFontStrategy
```
protected DefaultFontStrategy defaultFontStrategy
```
  - pdfPageFactory
```
protected IPdfPageFactory pdfPageFactory
```
- Constructor Detail
  - PdfDocument
```
public PdfDocument(PdfReader reader)
```
    Open PDF document in reading mode.
    
    Parameters:
    
    reader - PDF reader.
  - PdfDocument
```
public PdfDocument(PdfReader reader,
                   DocumentProperties properties)
```
    Open PDF document in reading mode.
    
    Parameters:
    
    reader - PDF reader.
    
    properties - document properties
  - PdfDocument
```
public PdfDocument(PdfWriter writer)
```
    Open PDF document in writing mode. Document has no pages when initialized.
    
    Parameters:
    
    writer - PDF writer
  - PdfDocument
```
public PdfDocument(PdfWriter writer,
                   DocumentProperties properties)
```
    Open PDF document in writing mode. Document has no pages when initialized.
    
    Parameters:
    
    writer - PDF writer
    
    properties - document properties
  - PdfDocument
```
public PdfDocument(PdfReader reader,
                   PdfWriter writer)
```
    Opens PDF document in the stamping mode.
    
    Parameters:
    
    reader - PDF reader.
    
    writer - PDF writer.
  - PdfDocument
```
public PdfDocument(PdfReader reader,
                   PdfWriter writer,
                   StampingProperties properties)
```
    Open PDF document in stamping mode.
    
    Parameters:
    
    reader - PDF reader.
    
    writer - PDF writer.
    
    properties - properties of the stamping process
- Method Detail
  - isClosing
```
public boolean isClosing()
```
    Checks if the document closing has been started or not.
    
    Returns:
    
    true if closing process has been started, otherwise false
  - setXmpMetadata
```
public void setXmpMetadata(XMPMeta xmpMeta,
                           SerializeOptions serializeOptions)
                    throws XMPException
```
    Sets the XMP Metadata.
    The XMP Metadata values are synchronized with information dictionary.
    
    Parameters:
    
    xmpMeta - the xmpMetadata to set
    
    serializeOptions - serialization options
    
    Throws:
    
    XMPException - on serialization errors
  - setXmpMetadata
```
public void setXmpMetadata(XMPMeta xmpMeta)
                    throws XMPException
```
    Sets the XMP Metadata.
    The XMP Metadata values are synchronized with information dictionary.
    serializeOptions will be used for serialization, they can be changed by setSerializeOptions(SerializeOptions).
    
    Parameters:
    
    xmpMeta - the xmpMetadata to set
    
    Throws:
    
    XMPException - on serialization errors
  - setXmpMetadata
```
protected void setXmpMetadata(byte[] xmpMetadata)
```
    Sets the XMP Metadata.
    The XMP Metadata values are synchronized with information dictionary.
    
    Parameters:
    
    xmpMetadata - the xmpMetadata bytes to set
  - getXmpMetadata
```
public XMPMeta getXmpMetadata()
                       throws XMPException
```
    Gets XMP Metadata.
    XMP Metadata is lazy initialized. It will be initialized during the first call of this method.
    To update XMP Metadata of the document, use setXmpMetadata(XMPMeta) method.
    
    Returns:
    
    existed XMP Metadata
    
    Throws:
    
    XMPException - on serialization errors
  - getXmpMetadata
```
public XMPMeta getXmpMetadata(boolean createNew)
                       throws XMPException
```
    Gets XMP Metadata or create a new one.
    XMP Metadata is lazy initialized. It will be initialized during the first call of this method.
    To update XMP Metadata of the document, use setXmpMetadata(XMPMeta) method.
    
    Parameters:
    
    createNew - if true, create a new empty XMP Metadata if it did not present
    
    Returns:
    
    existed or newly created XMP Metadata
    
    Throws:
    
    XMPException - on serialization errors
  - getXmpMetadataBytes
```
public byte[] getXmpMetadataBytes()
```
    Gets XMP Metadata.
    XMP Metadata is lazy initialized. It will be initialized during the first call of this method.
    To update XMP Metadata of the document, use setXmpMetadata(XMPMeta) method.
    
    Returns:
    
    existed XMP Metadata bytes
  - getXmpMetadataBytes
```
public byte[] getXmpMetadataBytes(boolean createNew)
```
    Gets XMP Metadata or create a new one.
    XMP Metadata is lazy initialized. It will be initialized during the first call of this method.
    To update XMP Metadata of the document, use setXmpMetadata(XMPMeta) method.
    
    Parameters:
    
    createNew - if true, create a new empty XMP Metadata if it did not present
    
    Returns:
    
    existed or newly created XMP Metadata byte array
  - getPdfObject
```
public PdfObject getPdfObject(int objNum)
```
    Gets PdfObject by object number.
    
    Parameters:
    
    objNum - object number.
    
    Returns:
    
    PdfObject or null, if object not found.
  - getNumberOfPdfObjects
```
public int getNumberOfPdfObjects()
```
    Get number of indirect objects in the document.
    
    Returns:
    
    number of indirect objects.
  - getPage
```
public PdfPage getPage(int pageNum)
```
    Gets the page by page number.
    
    Parameters:
    
    pageNum - page number.
    
    Returns:
    
    page by page number.
    
    Throws:
    
    PdfException - in case the page tree is broken
  - getPage
```
public PdfPage getPage(PdfDictionary pageDictionary)
```
    Gets the PdfPage instance by PdfDictionary.
    
    Parameters:
    
    pageDictionary - PdfDictionary that present page.
    
    Returns:
    
    page by PdfDictionary.
  - getFirstPage
```
public PdfPage getFirstPage()
```
    Get the first page of the document.
    
    Returns:
    
    first page of the document.
  - getLastPage
```
public PdfPage getLastPage()
```
    Gets the last page of the document.
    
    Returns:
    
    last page.
  - getMemoryLimitsAwareHandler
```
public MemoryLimitsAwareHandler getMemoryLimitsAwareHandler()
```
    Gets current memory limits handler
    
    Returns:
    
    MemoryLimitsAwareHandler instance
  - markStreamAsEmbeddedFile
```
public void markStreamAsEmbeddedFile(PdfStream stream)
```
    Marks PdfStream object as embedded file stream. Note that this method is for internal usage. To add an embedded file to the PDF document please use specialized API for file attachments. (e.g. addFileAttachment(String, PdfFileSpec), PdfPage.addAnnotation(PdfAnnotation))
    
    Parameters:
    
    stream - to be marked as embedded file stream
  - addNewPage
```
public PdfPage addNewPage()
```
    Creates and adds new page to the end of document.
    
    Returns:
    
    added page
  - addNewPage
```
public PdfPage addNewPage(PageSize pageSize)
```
    Creates and adds new page with the specified page size.
    
    Parameters:
    
    pageSize - page size of the new page
    
    Returns:
    
    added page
  - addNewPage
```
public PdfPage addNewPage(int index)
```
    Creates and inserts new page to the document.
    
    Parameters:
    
    index - position to addPage page to
    
    Returns:
    
    inserted page
    
    Throws:
    
    PdfException - in case page is flushed
  - addNewPage
```
public PdfPage addNewPage(int index,
                          PageSize pageSize)
```
    Creates and inserts new page to the document.
    
    Parameters:
    
    index - position to addPage page to
    
    pageSize - page size of the new page
    
    Returns:
    
    inserted page
    
    Throws:
    
    PdfException - in case page is flushed
  - addPage
```
public PdfPage addPage(PdfPage page)
```
    Adds page to the end of document.
    
    Parameters:
    
    page - page to add.
    
    Returns:
    
    added page.
    
    Throws:
    
    PdfException - in case page is flushed
  - addPage
```
public PdfPage addPage(int index,
                       PdfPage page)
```
    Inserts page to the document.
    
    Parameters:
    
    index - position to addPage page to
    
    page - page to addPage
    
    Returns:
    
    inserted page
    
    Throws:
    
    PdfException - in case page is flushed
  - getNumberOfPages
```
public int getNumberOfPages()
```
    Gets number of pages of the document.
    
    Returns:
    
    number of pages.
  - getPageNumber
```
public int getPageNumber(PdfPage page)
```
    Gets page number by page.
    
    Parameters:
    
    page - the page.
    
    Returns:
    
    page number.
  - getPageNumber
```
public int getPageNumber(PdfDictionary pageDictionary)
```
    Gets page number by PdfDictionary.
    
    Parameters:
    
    pageDictionary - PdfDictionary that present page.
    
    Returns:
    
    page number by PdfDictionary.
  - movePage
```
public boolean movePage(PdfPage page,
                        int insertBefore)
```
    Moves page to new place in same document with all it tag structure
    
    Parameters:
    
    page - page to be moved in document if present
    
    insertBefore - indicates before which page new one will be inserted to
    
    Returns:
    
    true if this document contained the specified page
  - movePage
```
public void movePage(int pageNumber,
                     int insertBefore)
```
    Moves page to new place in same document with all it tag structure
    
    Parameters:
    
    pageNumber - number of Page that will be moved
    
    insertBefore - indicates before which page new one will be inserted to
  - removePage
```
public boolean removePage(PdfPage page)
```
    Removes the first occurrence of the specified page from this document, if it is present. Returns true if this document contained the specified element (or equivalently, if this document changed as a result of the call).
    
    Parameters:
    
    page - page to be removed from this document, if present
    
    Returns:
    
    true if this document contained the specified page
  - removePage
```
public void removePage(int pageNum)
```
    Removes page from the document by page number.
    
    Parameters:
    
    pageNum - the one-based index of the PdfPage to be removed
  - getDiContainer
```
public com.itextpdf.commons.utils.DIContainer getDiContainer()
```
    Gets the container containing all available dependencies.
    
    Returns:
    
    the container containing all available dependencies.
  - getDocumentInfo
```
public PdfDocumentInfo getDocumentInfo()
```
    Gets document information dictionary.
    info is lazy initialized. It will be initialized during the first call of this method.
    The information dictionary values are synchronized with document XMP Metadata.
    
    Returns:
    
    document information dictionary.
  - getOriginalDocumentId
```
public PdfString getOriginalDocumentId()
```
    Gets original document id
    In order to set originalDocumentId WriterProperties.setInitialDocumentId(com.itextpdf.kernel.pdf.PdfString) should be used
    
    Returns:
    
    original document id
  - getModifiedDocumentId
```
public PdfString getModifiedDocumentId()
```
    Gets modified document id
    In order to set modifiedDocumentId WriterProperties.setModifiedDocumentId(com.itextpdf.kernel.pdf.PdfString) should be used
    
    Returns:
    
    modified document id
  - getDefaultPageSize
```
public PageSize getDefaultPageSize()
```
    Gets default page size. New pages by default are created with this size.
    
    Returns:
    
    default page size
  - setDefaultPageSize
```
public void setDefaultPageSize(PageSize pageSize)
```
    Sets default page size. New pages by default will be created with this size.
    
    Parameters:
    
    pageSize - page size to be set as default
  - addEventHandler
```
public void addEventHandler(String type,
                            AbstractPdfDocumentEventHandler handler)
```
    Adds new event handler.
    
    Parameters:
    
    type - a type of event to be handled
    
    handler - event handler
  - dispatchEvent
```
public void dispatchEvent(AbstractPdfDocumentEvent event)
```
    Dispatches an event.
    
    Parameters:
    
    event - the AbstractPdfDocumentEvent to be dispatched
  - hasEventHandler
```
public boolean hasEventHandler(AbstractPdfDocumentEventHandler handler)
```
    Checks if provided event handler assigned for this document.
    
    Parameters:
    
    handler - the AbstractPdfDocumentEventHandler to check
    
    Returns:
    
    true if event handler is assigned for this document, false otherwise
  - removeEventHandler
```
public void removeEventHandler(AbstractPdfDocumentEventHandler handler)
```
    Removes event handler.
    
    Parameters:
    
    handler - AbstractPdfDocumentEventHandler event handler to remove for this document
  - removeAllHandlers
```
public void removeAllHandlers()
```
    Removes all event handlers for this document.
  - getWriter
```
public PdfWriter getWriter()
```
    Gets PdfWriter associated with the document.
    
    Returns:
    
    PdfWriter associated with the document.
  - getReader
```
public PdfReader getReader()
```
    Gets PdfReader associated with the document.
    
    Returns:
    
    PdfReader associated with the document.
  - isAppendMode
```
public boolean isAppendMode()
```
    Returns true if the document is opened in append mode, and false otherwise.
    
    Returns:
    
    true if the document is opened in append mode, and false otherwise.
  - createNextIndirectReference
```
public PdfIndirectReference createNextIndirectReference()
```
    Creates next available indirect reference.
    
    Returns:
    
    created indirect reference.
  - getPdfVersion
```
public PdfVersion getPdfVersion()
```
    Gets PDF version.
    
    Returns:
    
    PDF version.
  - getCatalog
```
public PdfCatalog getCatalog()
```
    Gets PDF catalog.
    
    Returns:
    
    PDF catalog.
  - close
```
public void close()
```
    Close PDF document.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
  - isClosed
```
public boolean isClosed()
```
    Gets close status of the document.
    
    Returns:
    
    true, if the document has already been closed, otherwise false.
  - isTagged
```
public boolean isTagged()
```
    Gets tagged status of the document.
    
    Returns:
    
    true, if the document has tag structure, otherwise false.
  - setTagged
```
public PdfDocument setTagged()
```
    Specifies that document shall contain tag structure. See ISO 32000-1, section 14.8 "Tagged PDF"
    
    Returns:
    
    this PdfDocument instance
  - getStructTreeRoot
```
public PdfStructTreeRoot getStructTreeRoot()
```
    Gets PdfStructTreeRoot of tagged document.
    
    Returns:
    
    PdfStructTreeRoot in case document is tagged, otherwise it returns null.
    
    See Also:
    
    isTagged(), getNextStructParentIndex()
  - getNextStructParentIndex
```
public int getNextStructParentIndex()
```
    Gets next parent index of tagged document.
    
    Returns:
    
    -1 if document is not tagged, or >= 0 if tagged.
    
    See Also:
    
    isTagged(), getNextStructParentIndex()
  - getTagStructureContext
```
public TagStructureContext getTagStructureContext()
```
    Gets document TagStructureContext. The document must be tagged, otherwise an exception will be thrown.
    
    Returns:
    
    document TagStructureContext.
  - copyPagesTo
```
public List<PdfPage> copyPagesTo(int pageFrom,
                                 int pageTo,
                                 PdfDocument toDocument,
                                 int insertBeforePage)
```
    Copies a range of pages from current document to toDocument. Use this method if you want to copy pages across tagged documents. This will keep resultant PDF structure consistent.
    If outlines destination names are the same in different documents, all such outlines will lead to a single location in the resultant document. In this case iText will log a warning. This can be avoided by renaming destinations names in the source document.
    
    Parameters:
    
    pageFrom - start of the range of pages to be copied.
    
    pageTo - end of the range of pages to be copied.
    
    toDocument - a document to copy pages to.
    
    insertBeforePage - a position where to insert copied pages.
    
    Returns:
    
    list of copied pages
  - getConformance
```
public PdfConformance getConformance()
```
    Get the PdfConformance
    
    Returns:
    
    the document conformance
  - copyPagesTo
```
public List<PdfPage> copyPagesTo(int pageFrom,
                                 int pageTo,
                                 PdfDocument toDocument,
                                 int insertBeforePage,
                                 IPdfPageExtraCopier copier)
```
    Copies a range of pages from current document to toDocument. This range is inclusive, both page and pageTo are included in list of copied pages. Use this method if you want to copy pages across tagged documents. This will keep resultant PDF structure consistent.
    If outlines destination names are the same in different documents, all such outlines will lead to a single location in the resultant document. In this case iText will log a warning. This can be avoided by renaming destinations names in the source document.
    
    Parameters:
    
    pageFrom - 1-based start of the range of pages to be copied.
    
    pageTo - 1-based end (inclusive) of the range of pages to be copied. This page is included in list of copied pages.
    
    toDocument - a document to copy pages to.
    
    insertBeforePage - a position where to insert copied pages.
    
    copier - a copier which bears a special copy logic. May be null. It is recommended to use the same instance of IPdfPageExtraCopier for the same output document.
    
    Returns:
    
    list of new copied pages
  - copyPagesTo
```
public List<PdfPage> copyPagesTo(int pageFrom,
                                 int pageTo,
                                 PdfDocument toDocument)
```
    Copies a range of pages from current document to toDocument appending copied pages to the end. This range is inclusive, both page and pageTo are included in list of copied pages. Use this method if you want to copy pages across tagged documents. This will keep resultant PDF structure consistent.
    If outlines destination names are the same in different documents, all such outlines will lead to a single location in the resultant document. In this case iText will log a warning. This can be avoided by renaming destinations names in the source document.
    
    Parameters:
    
    pageFrom - 1-based start of the range of pages to be copied.
    
    pageTo - 1-based end (inclusive) of the range of pages to be copied. This page is included in list of copied pages.
    
    toDocument - a document to copy pages to.
    
    Returns:
    
    list of new copied pages
  - copyPagesTo
```
public List<PdfPage> copyPagesTo(int pageFrom,
                                 int pageTo,
                                 PdfDocument toDocument,
                                 IPdfPageExtraCopier copier)
```
    Copies a range of pages from current document to toDocument appending copied pages to the end. This range is inclusive, both page and pageTo are included in list of copied pages. Use this method if you want to copy pages across tagged documents. This will keep resultant PDF structure consistent.
    If outlines destination names are the same in different documents, all such outlines will lead to a single location in the resultant document. In this case iText will log a warning. This can be avoided by renaming destinations names in the source document.
    
    Parameters:
    
    pageFrom - 1-based start of the range of pages to be copied.
    
    pageTo - 1-based end (inclusive) of the range of pages to be copied. This page is included in list of copied pages.
    
    toDocument - a document to copy pages to.
    
    copier - a copier which bears a special copy logic. May be null. It is recommended to use the same instance of IPdfPageExtraCopier for the same output document.
    
    Returns:
    
    list of new copied pages.
  - copyPagesTo
```
public List<PdfPage> copyPagesTo(List<Integer> pagesToCopy,
                                 PdfDocument toDocument,
                                 int insertBeforePage)
```
    Copies a range of pages from current document to toDocument. Use this method if you want to copy pages across tagged documents. This will keep resultant PDF structure consistent.
    If outlines destination names are the same in different documents, all such outlines will lead to a single location in the resultant document. In this case iText will log a warning. This can be avoided by renaming destinations names in the source document.
    
    Parameters:
    
    pagesToCopy - list of pages to be copied.
    
    toDocument - a document to copy pages to.
    
    insertBeforePage - a position where to insert copied pages.
    
    Returns:
    
    list of new copied pages
  - copyPagesTo
```
public List<PdfPage> copyPagesTo(List<Integer> pagesToCopy,
                                 PdfDocument toDocument,
                                 int insertBeforePage,
                                 IPdfPageExtraCopier copier)
```
    Copies a range of pages from current document to toDocument. Use this method if you want to copy pages across tagged documents. This will keep resultant PDF structure consistent.
    If outlines destination names are the same in different documents, all such outlines will lead to a single location in the resultant document. In this case iText will log a warning. This can be avoided by renaming destinations names in the source document.
    
    Parameters:
    
    pagesToCopy - list of pages to be copied.
    
    toDocument - a document to copy pages to.
    
    insertBeforePage - a position where to insert copied pages.
    
    copier - a copier which bears a special copy logic. May be null. It is recommended to use the same instance of IPdfPageExtraCopier for the same output document.
    
    Returns:
    
    list of new copied pages
  - copyPagesTo
```
public List<PdfPage> copyPagesTo(List<Integer> pagesToCopy,
                                 PdfDocument toDocument)
```
    Copies a range of pages from current document to toDocument appending copied pages to the end. Use this method if you want to copy pages across tagged documents. This will keep resultant PDF structure consistent.
    If outlines destination names are the same in different documents, all such outlines will lead to a single location in the resultant document. In this case iText will log a warning. This can be avoided by renaming destinations names in the source document.
    
    Parameters:
    
    pagesToCopy - list of pages to be copied.
    
    toDocument - a document to copy pages to.
    
    Returns:
    
    list of copied pages
  - copyPagesTo
```
public List<PdfPage> copyPagesTo(List<Integer> pagesToCopy,
                                 PdfDocument toDocument,
                                 IPdfPageExtraCopier copier)
```
    Copies a range of pages from current document to toDocument appending copied pages to the end. Use this method if you want to copy pages across tagged documents. This will keep resultant PDF structure consistent.
    If outlines destination names are the same in different documents, all such outlines will lead to a single location in the resultant document. In this case iText will log a warning. This can be avoided by renaming destinations names in the source document.
    
    Parameters:
    
    pagesToCopy - list of pages to be copied.
    
    toDocument - a document to copy pages to.
    
    copier - a copier which bears a special copy logic. May be null. It is recommended to use the same instance of IPdfPageExtraCopier for the same output document.
    
    Returns:
    
    list of copied pages
  - flushCopiedObjects
```
public void flushCopiedObjects(PdfDocument sourceDoc)
```
    Flush all copied objects and remove them from copied cache.
    Note, if you will copy objects from the same document, duplicated objects will be created. That's why usually this method is meant to be used when all copying from source document is finished. For other cases one can also consider other flushing mechanisms, e.g. pages-based flushing.
    
    Parameters:
    
    sourceDoc - source document
  - isCloseReader
```
public boolean isCloseReader()
```
    Checks, whether close() method will close associated PdfReader.
    
    Returns:
    
    true, close() method is going to close associated PdfReader, otherwise false.
  - setCloseReader
```
public void setCloseReader(boolean closeReader)
```
    Sets, whether close() method shall close associated PdfReader.
    
    Parameters:
    
    closeReader - true, close() method shall close associated PdfReader, otherwise false.
  - isCloseWriter
```
public boolean isCloseWriter()
```
    Checks, whether close() method will close associated PdfWriter.
    
    Returns:
    
    true, close() method is going to close associated PdfWriter, otherwise false.
  - setCloseWriter
```
public void setCloseWriter(boolean closeWriter)
```
    Sets, whether close() method shall close associated PdfWriter.
    
    Parameters:
    
    closeWriter - true, close() method shall close associated PdfWriter, otherwise false.
  - isFlushUnusedObjects
```
public boolean isFlushUnusedObjects()
```
    Checks, whether close() will flush unused objects, e.g. unreachable from PDF Catalog. By default - false.
    
    Returns:
    
    false, if close() shall not flush unused objects, otherwise true.
  - setFlushUnusedObjects
```
public void setFlushUnusedObjects(boolean flushUnusedObjects)
```
    Sets, whether close() shall flush unused objects, e.g. unreachable from PDF Catalog.
    
    Parameters:
    
    flushUnusedObjects - false, if close() shall not flush unused objects, otherwise true.
  - getOutlines
```
public PdfOutline getOutlines(boolean updateOutlines)
```
    This method returns a complete outline tree of the whole document.
    
    Parameters:
    
    updateOutlines - if the flag is true, the method reads the whole document and creates outline tree. If the flag is false, the method gets cached outline tree (if it was cached via calling getOutlines method before).
    
    Returns:
    
    fully initialize PdfOutline object.
  - initializeOutlines
```
public void initializeOutlines()
```
    This method initializes an outline tree of the document and sets outline mode to true.
  - addNamedDestination
```
public void addNamedDestination(String key,
                                PdfObject value)
```
    This methods adds new name in the Dests NameTree. It throws an exception, if the name already exists.
    
    Parameters:
    
    key - Name of the destination.
    
    value - An object destination refers to. Must be an array or a dictionary with key /D and array. See ISO 32000-1 12.3.2.3 for more info.
  - addNamedDestination
```
public void addNamedDestination(PdfString key,
                                PdfObject value)
```
    This methods adds new name in the Dests NameTree. It throws an exception, if the name already exists.
    
    Parameters:
    
    key - Name of the destination.
    
    value - An object destination refers to. Must be an array or a dictionary with key /D and array. See ISO 32000-1 12.3.2.3 for more info.
  - listIndirectReferences
```
public List<PdfIndirectReference> listIndirectReferences()
```
    Gets static copy of cross reference table.
    
    Returns:
    
    a static copy of cross reference table
  - getTrailer
```
public PdfDictionary getTrailer()
```
    Gets document trailer.
    
    Returns:
    
    document trailer.
  - addOutputIntent
```
public void addOutputIntent(PdfOutputIntent outputIntent)
```
    Adds PdfOutputIntent that shall specify the colour characteristics of output devices on which the document might be rendered.
    
    Parameters:
    
    outputIntent - PdfOutputIntent to add.
    
    See Also:
    
    PdfOutputIntent
  - checkIsoConformance
```
public void checkIsoConformance(IValidationContext validationContext)
```
  - addFileAttachment
```
public void addFileAttachment(String key,
                              PdfFileSpec fs)
```
    Adds file attachment at document level.
    
    Parameters:
    
    key - name of the destination.
    
    fs - PdfFileSpec object.
  - addAssociatedFile
```
public void addAssociatedFile(String description,
                              PdfFileSpec fs)
```
    Adds file associated with PDF document as a whole and identifies the relationship between them.
    Associated files may be used in Pdf/A-3 and Pdf 2.0 documents. The method is very similar to addFileAttachment(String, PdfFileSpec). However, besides adding file description to Names tree, it adds file to array value of the AF key in the document catalog.
    For associated files their associated file specification dictionaries shall include the AFRelationship key
    
    Parameters:
    
    description - the file description
    
    fs - file specification dictionary of associated file
    
    See Also:
    
    addFileAttachment(String, PdfFileSpec)
  - getAssociatedFiles
```
public PdfArray getAssociatedFiles()
```
    Returns files associated with PDF document.
    
    Returns:
    
    associated files array.
  - getEncryptedPayloadDocument
```
public PdfEncryptedPayloadDocument getEncryptedPayloadDocument()
```
    Gets the encrypted payload of this document, or returns null if this document isn't an unencrypted wrapper document.
    
    Returns:
    
    encrypted payload of this document.
  - setEncryptedPayload
```
public void setEncryptedPayload(PdfFileSpec fs)
```
    Sets an encrypted payload, making this document an unencrypted wrapper document. The file spec shall include the AFRelationship key with a value of EncryptedPayload, and shall include an encrypted payload dictionary.
    
    Parameters:
    
    fs - encrypted payload file spec. PdfEncryptedPayloadFileSpecFactory can produce one.
  - getPageLabels
```
public String[] getPageLabels()
```
    This method retrieves the page labels from a document as an array of String objects.
    
    Returns:
    
    String list of page labels if they were found, or null otherwise
  - hasOutlines
```
public boolean hasOutlines()
```
    Indicates if the document has any outlines
    
    Returns:
    
    true, if there are outlines and false otherwise.
  - setUserProperties
```
public void setUserProperties(boolean userProperties)
```
    Sets the flag indicating the presence of structure elements that contain user properties attributes.
    
    Parameters:
    
    userProperties - the user properties flag
  - getFont
```
public PdfFont getFont(PdfDictionary dictionary)
```
    Create a new instance of PdfFont or load already created one.
    
    Parameters:
    
    dictionary - PdfDictionary that presents PdfFont.
    
    Returns:
    
    instance of PdfFont
    Note, PdfFont which created with PdfFontFactory.createFont(PdfDictionary) won't be cached until it will be added to PdfCanvas or PdfResources.
  - getDefaultFont
```
public PdfFont getDefaultFont()
```
    Gets default font for the document: Helvetica, WinAnsi. One instance per document.
    
    Returns:
    
    instance of PdfFont or null on error.
  - addFont
```
public PdfFont addFont(PdfFont font)
```
    Adds a PdfFont instance to this document so that this font is flushed automatically on document close. As a side effect, the underlying font dictionary is made indirect if it wasn't the case yet
    
    Parameters:
    
    font - a PdfFont instance to add
    
    Returns:
    
    the same PdfFont instance.
  - registerProduct
```
public boolean registerProduct(com.itextpdf.commons.actions.data.ProductData productData)
```
    Registers a product for debugging purposes.
    
    Parameters:
    
    productData - product to be registered.
    
    Returns:
    
    true if the product hadn't been registered before.
  - getFingerPrint
```
public FingerPrint getFingerPrint()
```
    Returns the object containing the registered products.
    
    Returns:
    
    fingerprint object
  - findFont
```
public PdfFont findFont(String fontProgram,
                        String encoding)
```
    Find PdfFont from loaded fonts with corresponding fontProgram and encoding or CMAP.
    
    Parameters:
    
    fontProgram - a font name or path to a font program
    
    encoding - an encoding or CMAP
    
    Returns:
    
    the font instance, or null if font wasn't found
  - getDocumentId
```
public long getDocumentId()
```
    Obtains numeric document id.
    
    Returns:
    
    document id
  - getDocumentIdWrapper
```
public com.itextpdf.commons.actions.sequence.SequenceId getDocumentIdWrapper()
```
    Obtains document id as a SequenceId.
    
    Returns:
    
    document id
  - getSerializeOptions
```
public SerializeOptions getSerializeOptions()
```
    Gets a persistent XMP metadata serialization options.
    
    Returns:
    
    serialize options
  - setSerializeOptions
```
public void setSerializeOptions(SerializeOptions serializeOptions)
```
    Sets a persistent XMP metadata serialization options.
    
    Parameters:
    
    serializeOptions - serialize options
  - initTagStructureContext
```
protected void initTagStructureContext()
```
    Initialize TagStructureContext.
  - storeDestinationToReaddress
```
protected void storeDestinationToReaddress(PdfDestination destination,
                                           Consumer<PdfDestination> onPageAvailable,
                                           Consumer<PdfDestination> onPageNotAvailable)
```
    Save destinations in a temporary storage for further copying.
    
    Parameters:
    
    destination - the PdfDestination to be updated itself.
    
    onPageAvailable - a destination consumer that will handle the copying when the destination still resolves, it gets the new destination as input
    
    onPageNotAvailable - a destination consumer that will handle the copying when the destination is not available, it gets the original destination as input
  - flushObject
```
protected void flushObject(PdfObject pdfObject,
                           boolean canBeInObjStm)
                    throws IOException
```
    Flush an object.
    
    Parameters:
    
    pdfObject - object to flush.
    
    canBeInObjStm - indicates whether object can be placed into object stream.
    
    Throws:
    
    IOException - on error.
  - open
```
protected void open(PdfVersion newPdfVersion)
```
    Initializes document.
    
    Parameters:
    
    newPdfVersion - new pdf version of the resultant file if stamper is used and the version needs to be changed, or null otherwise
  - updateXmpMetadata
```
protected void updateXmpMetadata()
```
    Updates XMP metadata. Shall be overridden.
  - updateDefaultXmpMetadata
```
protected XMPMeta updateDefaultXmpMetadata()
                                    throws XMPException
```
    Update XMP metadata values from PdfDocumentInfo.
    
    Returns:
    
    the XMPMetadata
    
    Throws:
    
    XMPException - if the file is not well-formed XML or if parsing fails.
  - getDocumentFonts
```
protected Collection<PdfFont> getDocumentFonts()
```
    List all newly added or loaded fonts
    
    Returns:
    
    List of PdfFont.
  - flushFonts
```
protected void flushFonts()
```
    Flushes all newly added or loaded fonts.
  - checkAndAddPage
```
protected void checkAndAddPage(int index,
                               PdfPage page)
```
    Checks page before adding and add.
    
    Parameters:
    
    index - one-base index of the page.
    
    page - PdfPage to add.
  - checkAndAddPage
```
protected void checkAndAddPage(PdfPage page)
```
    Checks page before adding.
    
    Parameters:
    
    page - PdfPage to add.
  - checkClosingStatus
```
protected void checkClosingStatus()
```
    checks whether a method is invoked at the closed document
  - getPageFactory
```
protected IPdfPageFactory getPageFactory()
```
    Returns the factory for creating page instances.
    
    Returns:
    
    implementation of IPdfPageFactory for current document
  - tryInitTagStructure
```
protected void tryInitTagStructure(PdfDictionary str)
```
    Initializes the new instance of document's structure tree root PdfStructTreeRoot. See ISO 32000-1, section 14.7.2 Structure Hierarchy.
    
    Parameters:
    
    str - dictionary to create structure tree root

Class PdfDocument

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

properties

writer

reader

catalog

trailer

pdfVersion

pdfConformance

fingerPrint

serializeOptions

structTreeRoot

structParentIndex

closeReader

closeWriter

isClosing

closed

flushUnusedObjects

tagStructureContext

documentInfoHelper

defaultFontStrategy

pdfPageFactory

Constructor Detail

PdfDocument

PdfDocument

PdfDocument

PdfDocument

PdfDocument

PdfDocument

Method Detail

isClosing

setXmpMetadata

setXmpMetadata

setXmpMetadata

getXmpMetadata

getXmpMetadata

getXmpMetadataBytes

getXmpMetadataBytes

getPdfObject

getNumberOfPdfObjects

getPage

getPage

getFirstPage

getLastPage

getMemoryLimitsAwareHandler

markStreamAsEmbeddedFile

addNewPage

addNewPage

addNewPage

addNewPage

addPage

addPage

getNumberOfPages

getPageNumber

getPageNumber

movePage

movePage

removePage

removePage

getDiContainer

getDocumentInfo

getOriginalDocumentId

getModifiedDocumentId

getDefaultPageSize

setDefaultPageSize

addEventHandler

dispatchEvent

hasEventHandler

removeEventHandler

removeAllHandlers

getWriter

getReader

isAppendMode

createNextIndirectReference

getPdfVersion

getCatalog