PdfDocument (iText 7 7.0.0 API)

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

All Implemented Interfaces:

IEventDispatcher, Closeable, Serializable, AutoCloseable

Direct Known Subclasses:

PdfADocument
```
public class PdfDocument
extends Object
implements IEventDispatcher, Closeable, Serializable
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected PdfCatalog`	`catalog` Document catalog.
`protected boolean`	`closed`
`protected boolean`	`closeReader`
`protected boolean`	`closeWriter`
`protected PdfPage`	`currentPage` Currently active page.
`protected PageSize`	`defaultPageSize` Default page size.
`protected Set<PdfFont>`	`documentFonts`
`protected EventDispatcher`	`eventDispatcher`
`protected boolean`	`flushUnusedObjects` flag determines whether to write unused objects to result document
`protected PdfDocumentInfo`	`info` Document info.
`protected boolean`	`isClosing`
`protected PdfVersion`	`pdfVersion` Document version.
`protected StampingProperties`	`properties`
`protected PdfReader`	`reader` PdfReader associated with the document.
`protected int`	`structParentIndex`
`protected PdfStructTreeRoot`	`structTreeRoot`
`protected TagStructureContext`	`tagStructureContext`
`protected PdfDictionary`	`trailer` Document trailed.
`protected boolean`	`userProperties`
`protected PdfWriter`	`writer` PdfWriter associated with the document.
`protected byte[]`	`xmpMetadata` XMP Metadata for the document.

Constructor Summary

Constructors
Constructor and Description
`PdfDocument(PdfReader reader)` 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.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEventHandler(String type, IEventHandler handler)` Adds new event handler.
`void`	`addFileAttachment(String description, byte[] fileStore, String fileDisplay, PdfName mimeType, PdfDictionary fileParameter, PdfName afRelationshipValue)`
`void`	`addFileAttachment(String description, PdfFileSpec fs)`
`void`	`addFileAttachment(String description, String file, String fileDisplay, PdfName mimeType, PdfName afRelationshipValue)`
`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)`
`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)`
`protected void`	`checkAndAddPage(PdfPage page)`
`protected void`	`checkClosingStatus()` checks whether a method is invoked at the closed document
`protected void`	`checkIsoConformance()`
`void`	`checkIsoConformance(Object obj, IsoKey key)`
`void`	`checkIsoConformance(Object obj, IsoKey key, PdfResources resources)`
`void`	`checkShowTextIsoConformance(Object gState, PdfResources resources)`
`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(Event event)` Dispatches an event.
`void`	`dispatchEvent(Event event, boolean delayed)` Dispatches a delayed event.
`protected void`	`flushFonts()`
`protected void`	`flushObject(PdfObject pdfObject, boolean canBeInObjStm)`
`PdfCatalog`	`getCatalog()` Gets PDF catalog.
`protected Counter`	`getCounter()`
`PageSize`	`getDefaultPageSize()` Gets default page size.
`protected Set<PdfFont>`	`getDocumentFonts()` List all newly added or loaded fonts
`PdfDocumentInfo`	`getDocumentInfo()` Gets document information dictionary.
`PdfPage`	`getFirstPage()` Get the first page of the document.
`PdfPage`	`getLastPage()` Gets the last page of the document.
`Integer`	`getNextStructParentIndex()`
`int`	`getNumberOfPages()` Gets number of pages of the document.
`int`	`getNumberOfPdfObjects()`
`PdfOutline`	`getOutlines(boolean updateOutlines)`
`PdfPage`	`getPage(int pageNum)` Gets the page by page number.
`PdfPage`	`getPage(PdfDictionary pageDictionary)` Gets the `PdfPage` instance by `PdfDictionary`.
`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)`
`PdfVersion`	`getPdfVersion()` Gets PDF version.
`PdfReader`	`getReader()` Gets `PdfReader` associated with the document.
`PdfStructTreeRoot`	`getStructTreeRoot()`
`TagStructureContext`	`getTagStructureContext()` Gets document `TagStructureContext`.
`PdfDictionary`	`getTrailer()` Gets document trailer.
`PdfWriter`	`getWriter()` Gets `PdfWriter` associated with the document.
`byte[]`	`getXmpMetadata()` Gets XMPMetadata.
`byte[]`	`getXmpMetadata(boolean createNew)` Gets XMPMetadata or create a new one.
`boolean`	`hasEventHandler(String type)` Checks if event dispatcher as an event handler assigned for a certain event type.
`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()`
`boolean`	`isAppendMode()` Returns `true` if the document is opened in append mode, and `false` otherwise.
`boolean`	`isClosed()`
`boolean`	`isCloseReader()`
`boolean`	`isCloseWriter()`
`boolean`	`isFlushUnusedObjects()`
`boolean`	`isTagged()`
`List<PdfIndirectReference>`	`listIndirectReferences()`
`protected void`	`markObjectAsMustBeFlushed(PdfObject pdfObject)`
`protected void`	`open(PdfVersion newPdfVersion)` Initializes document.
`void`	`removeAllHandlers()` Remove all event handlers.
`void`	`removeEventHandler(String type, IEventHandler handler)` Removes event handler.
`PdfPage`	`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)`
`void`	`setCloseWriter(boolean closeWriter)`
`void`	`setDefaultPageSize(PageSize pageSize)` Sets default page size.
`void`	`setFlushUnusedObjects(boolean flushUnusedObjects)`
`void`	`setTagged()`
`void`	`setUserProperties(boolean userProperties)` Sets the flag indicating the presence of structure elements that contain user properties attributes.
`protected void`	`setXmpMetadata(byte[] xmpMetadata)` Use this method to set the XMP Metadata.
`void`	`setXmpMetadata(XMPMeta xmpMeta)`
`void`	`setXmpMetadata(XMPMeta xmpMeta, SerializeOptions serializeOptions)`
`protected void`	`storeLinkAnnotation(PdfPage page, PdfLinkAnnotation annotation)`
`protected XMPMeta`	`updateDefaultXmpMetadata()`
`protected void`	`updateXmpMetadata()`

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

- Field Detail
  - currentPage
```
protected PdfPage currentPage
```
    Currently active page.
  - defaultPageSize
```
protected PageSize defaultPageSize
```
    Default page size. New page by default will be created with this size.
  - eventDispatcher
```
protected EventDispatcher eventDispatcher
```
  - 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.
  - xmpMetadata
```
protected byte[] xmpMetadata
```
    XMP Metadata for the document.
  - catalog
```
protected PdfCatalog catalog
```
    Document catalog.
  - trailer
```
protected PdfDictionary trailer
```
    Document trailed.
  - info
```
protected PdfDocumentInfo info
```
    Document info.
  - pdfVersion
```
protected PdfVersion pdfVersion
```
    Document version.
  - properties
```
protected final StampingProperties properties
```
  - structTreeRoot
```
protected PdfStructTreeRoot structTreeRoot
```
  - structParentIndex
```
protected int structParentIndex
```
  - userProperties
```
protected boolean userProperties
```
  - 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
  - documentFonts
```
protected Set<PdfFont> documentFonts
```
  - tagStructureContext
```
protected TagStructureContext tagStructureContext
```
- Constructor Detail
  - PdfDocument
```
public PdfDocument(PdfReader reader)
```
    Open PDF document in reading mode.
    
    Parameters:
    
    reader - PDF reader.
  - PdfDocument
```
public PdfDocument(PdfWriter writer)
```
    Open PDF document in writing mode. Document has no pages when initialized.
    
    Parameters:
    
    writer - PDF writer
  - 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
  - setXmpMetadata
```
protected void setXmpMetadata(byte[] xmpMetadata)
```
    Use this method to set the XMP Metadata.
    
    Parameters:
    
    xmpMetadata - The xmpMetadata to set.
  - setXmpMetadata
```
public void setXmpMetadata(XMPMeta xmpMeta,
                           SerializeOptions serializeOptions)
                    throws XMPException
```
    Throws:
    
    XMPException
  - setXmpMetadata
```
public void setXmpMetadata(XMPMeta xmpMeta)
                    throws XMPException
```
    Throws:
    
    XMPException
  - getXmpMetadata
```
public byte[] getXmpMetadata()
```
    Gets XMPMetadata.
  - getXmpMetadata
```
public byte[] getXmpMetadata(boolean createNew)
```
    Gets XMPMetadata or create a new one.
    
    Parameters:
    
    createNew - if true, create a new empty XMPMetadata if it did not present.
    
    Returns:
    
    existed or newly created XMPMetadata byte array.
  - getPdfObject
```
public PdfObject getPdfObject(int objNum)
```
  - getNumberOfPdfObjects
```
public int getNumberOfPdfObjects()
```
  - getPage
```
public PdfPage getPage(int pageNum)
```
    Gets the page by page number.
    
    Parameters:
    
    pageNum - page number.
    
    Returns:
    
    page by page number.
  - 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.
  - 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.
  - 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 PdfPage removePage(int pageNum)
```
    Removes page from the document by page number.
    
    Parameters:
    
    pageNum - the one-based index of the PdfPage to be removed
    
    Returns:
    
    the page that was removed from the list
  - getDocumentInfo
```
public PdfDocumentInfo getDocumentInfo()
```
    Gets document information dictionary.
    
    Returns:
    
    document information dictionary.
  - getDefaultPageSize
```
public PageSize getDefaultPageSize()
```
    Gets default page size.
    
    Returns:
    
    default page size.
  - setDefaultPageSize
```
public void setDefaultPageSize(PageSize pageSize)
```
    Sets default page size.
    
    Parameters:
    
    pageSize - page size to be set as default.
  - addEventHandler
```
public void addEventHandler(String type,
                            IEventHandler handler)
```
    Description copied from interface: IEventDispatcher
    
    Adds new event handler.
    
    Specified by:
    
    addEventHandler in interface IEventDispatcher
    
    Parameters:
    
    type - a type of event to be handled.
    
    handler - event handler.
  - dispatchEvent
```
public void dispatchEvent(Event event)
```
    Description copied from interface: IEventDispatcher
    
    Dispatches an event.
    
    Specified by:
    
    dispatchEvent in interface IEventDispatcher
  - dispatchEvent
```
public void dispatchEvent(Event event,
                          boolean delayed)
```
    Description copied from interface: IEventDispatcher
    
    Dispatches a delayed event. Sometimes event cannot be handled immediately because event handler has not been set yet. In this case event is placed into event ques of dispatcher and is waiting until handler is assigned.
    
    Specified by:
    
    dispatchEvent in interface IEventDispatcher
  - hasEventHandler
```
public boolean hasEventHandler(String type)
```
    Description copied from interface: IEventDispatcher
    
    Checks if event dispatcher as an event handler assigned for a certain event type.
    
    Specified by:
    
    hasEventHandler in interface IEventDispatcher
    
    Returns:
  - removeEventHandler
```
public void removeEventHandler(String type,
                               IEventHandler handler)
```
    Description copied from interface: IEventDispatcher
    
    Removes event handler.
    
    Specified by:
    
    removeEventHandler in interface IEventDispatcher
  - removeAllHandlers
```
public void removeAllHandlers()
```
    Description copied from interface: IEventDispatcher
    
    Remove all event handlers.
    
    Specified by:
    
    removeAllHandlers in interface IEventDispatcher
  - 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()
```
  - isTagged
```
public boolean isTagged()
```
  - setTagged
```
public void setTagged()
```
  - getStructTreeRoot
```
public PdfStructTreeRoot getStructTreeRoot()
```
  - getNextStructParentIndex
```
public Integer 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.
    
    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
    
    Throws:
    
    PdfException
  - 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. Use this method if you want to copy pages across tagged documents. This will keep resultant PDF structure consistent.
    
    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.
    
    copier - a copier which bears a special copy logic. May be NULL
    
    Returns:
    
    list of copied pages
    
    Throws:
    
    PdfException
  - 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. Use this method if you want to copy pages across tagged documents. This will keep resultant PDF structure consistent.
    
    Parameters:
    
    pageFrom -
    
    pageTo -
    
    toDocument -
    
    Returns:
    
    list of copied pages
    
    Throws:
    
    PdfException
  - 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. Use this method if you want to copy pages across tagged documents. This will keep resultant PDF structure consistent.
    
    Parameters:
    
    pageFrom -
    
    pageTo -
    
    toDocument -
    
    copier - a copier which bears a special copy logic. May be NULL
    
    Returns:
    
    list of copied pages
    
    Throws:
    
    PdfException
  - 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.
    
    Parameters:
    
    pagesToCopy - list of pages to be copied. TreeSet for the order of the pages to be natural.
    
    toDocument - a document to copy pages to.
    
    insertBeforePage - a position where to insert copied pages.
    
    Returns:
    
    list of copied pages
    
    Throws:
    
    PdfException
  - 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.
    
    Parameters:
    
    pagesToCopy - list of pages to be copied. TreeSet for the order of the pages to be natural.
    
    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
    
    Returns:
    
    list of copied pages
    
    Throws:
    
    PdfException
  - 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.
    
    Parameters:
    
    pagesToCopy - list of pages to be copied. TreeSet for the order of the pages to be natural.
    
    toDocument - a document to copy pages to.
    
    Returns:
    
    list of copied pages
    
    Throws:
    
    PdfException
  - 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.
    
    Parameters:
    
    pagesToCopy - list of pages to be copied. TreeSet for the order of the pages to be natural.
    
    toDocument - a document to copy pages to.
    
    copier - a copier which bears a special copy logic
    
    Returns:
    
    list of copied pages
    
    Throws:
    
    PdfException
  - isCloseReader
```
public boolean isCloseReader()
```
  - setCloseReader
```
public void setCloseReader(boolean closeReader)
```
  - isCloseWriter
```
public boolean isCloseWriter()
```
  - setCloseWriter
```
public void setCloseWriter(boolean closeWriter)
```
  - isFlushUnusedObjects
```
public boolean isFlushUnusedObjects()
```
  - setFlushUnusedObjects
```
public void setFlushUnusedObjects(boolean flushUnusedObjects)
```
  - getOutlines
```
public PdfOutline getOutlines(boolean updateOutlines)
```
  - 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 PdfSpec 12.3.2.3 for more info.
    
    Throws:
    
    PdfException
  - listIndirectReferences
```
public List<PdfIndirectReference> listIndirectReferences()
```
  - getTrailer
```
public PdfDictionary getTrailer()
```
    Gets document trailer.
    
    Returns:
    
    document trailer.
  - addOutputIntent
```
public void addOutputIntent(PdfOutputIntent outputIntent)
```
  - checkIsoConformance
```
public void checkIsoConformance(Object obj,
                                IsoKey key)
```
  - checkIsoConformance
```
public void checkIsoConformance(Object obj,
                                IsoKey key,
                                PdfResources resources)
```
  - checkShowTextIsoConformance
```
public void checkShowTextIsoConformance(Object gState,
                                        PdfResources resources)
```
  - addFileAttachment
```
public void addFileAttachment(String description,
                              byte[] fileStore,
                              String fileDisplay,
                              PdfName mimeType,
                              PdfDictionary fileParameter,
                              PdfName afRelationshipValue)
```
  - addFileAttachment
```
public void addFileAttachment(String description,
                              String file,
                              String fileDisplay,
                              PdfName mimeType,
                              PdfName afRelationshipValue)
                       throws FileNotFoundException
```
    Throws:
    
    FileNotFoundException
  - addFileAttachment
```
public void addFileAttachment(String description,
                              PdfFileSpec fs)
```
  - 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
  - initTagStructureContext
```
protected void initTagStructureContext()
```
  - storeLinkAnnotation
```
protected void storeLinkAnnotation(PdfPage page,
                                   PdfLinkAnnotation annotation)
```
  - checkIsoConformance
```
protected void checkIsoConformance()
```
  - markObjectAsMustBeFlushed
```
protected void markObjectAsMustBeFlushed(PdfObject pdfObject)
```
  - flushObject
```
protected void flushObject(PdfObject pdfObject,
                           boolean canBeInObjStm)
                    throws IOException
```
    Throws:
    
    IOException
  - 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
    
    Throws:
    
    PdfException
  - updateXmpMetadata
```
protected void updateXmpMetadata()
```
  - updateDefaultXmpMetadata
```
protected XMPMeta updateDefaultXmpMetadata()
                                    throws XMPException
```
    Throws:
    
    XMPException
  - getDocumentFonts
```
protected Set<PdfFont> getDocumentFonts()
```
    List all newly added or loaded fonts
    
    Returns:
    
    List of PdfFonts.
  - flushFonts
```
protected void flushFonts()
```
  - checkAndAddPage
```
protected void checkAndAddPage(int index,
                               PdfPage page)
```
  - checkAndAddPage
```
protected void checkAndAddPage(PdfPage page)
```
  - checkClosingStatus
```
protected void checkClosingStatus()
```
    checks whether a method is invoked at the closed document
    
    Throws:
    
    PdfException
  - getCounter
```
protected Counter getCounter()
```

Class PdfDocument

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

currentPage

defaultPageSize

eventDispatcher

writer

reader

xmpMetadata

catalog

trailer

info

pdfVersion

properties

structTreeRoot

structParentIndex

userProperties

closeReader

closeWriter

isClosing

closed

flushUnusedObjects

documentFonts

tagStructureContext

Constructor Detail

PdfDocument

PdfDocument

PdfDocument

PdfDocument

Method Detail

setXmpMetadata

setXmpMetadata

setXmpMetadata

getXmpMetadata

getXmpMetadata

getPdfObject

getNumberOfPdfObjects

getPage

getPage

getFirstPage

getLastPage

addNewPage

addNewPage

addNewPage

addNewPage

addPage

addPage

getNumberOfPages

getPageNumber

getPageNumber

removePage

removePage

getDocumentInfo

getDefaultPageSize

setDefaultPageSize

addEventHandler

dispatchEvent

dispatchEvent

hasEventHandler

removeEventHandler

removeAllHandlers

getWriter

getReader

isAppendMode

createNextIndirectReference

getPdfVersion

getCatalog

close

isClosed

isTagged

setTagged

getStructTreeRoot

getNextStructParentIndex

getTagStructureContext

copyPagesTo

copyPagesTo

copyPagesTo