PDDocument (Apache PDFBox 1.8.10 API)

java.lang.Object
- org.apache.pdfbox.pdmodel.PDDocument

All Implemented Interfaces:

Pageable, Closeable, AutoCloseable

Direct Known Subclasses:

ConformingPDDocument
```
public class PDDocument
extends Object
implements Pageable, Closeable
```
This is the in-memory representation of the PDF document. You need to call close() on this object when you are done using it!!
This class implements the Pageable interface, but since PDFBox version 1.3.0 you should be using the PDPageable adapter instead (see PDFBOX-788).

Version:

$Revision: 1.47 $

Author:

Ben Litchfield

Field Summary
- Fields inherited from interface java.awt.print.Pageable
  UNKNOWN_NUMBER_OF_PAGES

Constructor Summary

Constructors
Constructor and Description
`PDDocument()` Constructor, creates a new PDF Document with no pages.
`PDDocument(COSDocument doc)` Constructor that uses an existing document.
`PDDocument(COSDocument doc, BaseParser usedParser)` Constructor that uses an existing document.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addPage(PDPage page)` This will add a page to the document.
`void`	`addSignature(PDSignature sigObject, SignatureInterface signatureInterface)` Add a signature.
`void`	`addSignature(PDSignature sigObject, SignatureInterface signatureInterface, SignatureOptions options)` This will add a signature to the document.
`void`	`addSignatureField(List<PDSignatureField> sigFields, SignatureInterface signatureInterface, SignatureOptions options)` This will add a signaturefield to the document.
`void`	`clearWillEncryptWhenSaving()` Deprecated. Do not rely on this method anymore. It is the responsability of COSWriter to hold this state.
`void`	`close()` This will close the underlying COSDocument object.
`void`	`decrypt(String password)` This will decrypt a document.
`void`	`encrypt(String ownerPassword, String userPassword)` This will mark a document to be encrypted.
`AccessPermission`	`getCurrentAccessPermission()` Returns the access permissions granted when the document was decrypted.
`COSDocument`	`getDocument()` This will get the low level document.
`PDDocumentCatalog`	`getDocumentCatalog()` This will get the document CATALOG.
`Long`	`getDocumentId()`
`PDDocumentInformation`	`getDocumentInformation()` This will get the document info dictionary.
`PDEncryptionDictionary`	`getEncryptionDictionary()` This will get the encryption dictionary for this document.
`PDSignature`	`getLastSignatureDictionary()` This will return the last signature.
`int`	`getNumberOfPages()`
`String`	`getOwnerPasswordForEncryption()` Deprecated. Do not rely on this method anymore.
`int`	`getPageCount()` Deprecated. Use the getNumberOfPages method instead!
`PageFormat`	`getPageFormat(int pageIndex)` Deprecated. Use the `PDPageable` adapter class
`Map<String,Integer>`	`getPageMap()` This will return the Map containing the mapping from object-ids to pagenumbers.
`Printable`	`getPrintable(int pageIndex)`
`SecurityHandler`	`getSecurityHandler()` Get the security handler that is used for document encryption.
`List<PDSignature>`	`getSignatureDictionaries()` Retrieve all signature dictionaries from the document.
`PDSignature`	`getSignatureDictionary()` Deprecated. use `getLastSignatureDictionary()` instead.
`List<PDSignatureField>`	`getSignatureFields()` Retrieve all signature fields from the document.
`String`	`getUserPasswordForEncryption()` Deprecated. Do not rely on this method anymore.
`PDPage`	`importPage(PDPage page)` This will import and copy the contents from another location.
`boolean`	`isAllSecurityToBeRemoved()` Indicates if all security is removed or not when writing the pdf.
`boolean`	`isEncrypted()` This will tell if this document is encrypted or not.
`boolean`	`isOwnerPassword(String password)` Deprecated.
`boolean`	`isUserPassword(String password)` Deprecated.
`static PDDocument`	`load(File file)` This will load a document from a file.
`static PDDocument`	`load(File file, RandomAccess scratchFile)` This will load a document from a file.
`static PDDocument`	`load(InputStream input)` This will load a document from an input stream.
`static PDDocument`	`load(InputStream input, boolean force)` This will load a document from an input stream.
`static PDDocument`	`load(InputStream input, RandomAccess scratchFile)` This will load a document from an input stream.
`static PDDocument`	`load(InputStream input, RandomAccess scratchFile, boolean force)` This will load a document from an input stream.
`static PDDocument`	`load(String filename)` This will load a document from a file.
`static PDDocument`	`load(String filename, boolean force)` This will load a document from a file.
`static PDDocument`	`load(String filename, RandomAccess scratchFile)` This will load a document from a file.
`static PDDocument`	`load(URL url)` This will load a document from a url.
`static PDDocument`	`load(URL url, boolean force)` This will load a document from a url.
`static PDDocument`	`load(URL url, RandomAccess scratchFile)` This will load a document from a url.
`static PDDocument`	`loadNonSeq(File file, RandomAccess scratchFile)` Parses PDF with non sequential parser.
`static PDDocument`	`loadNonSeq(File file, RandomAccess scratchFile, String password)` Parses PDF with non sequential parser.
`static PDDocument`	`loadNonSeq(InputStream input, RandomAccess scratchFile)` Parses PDF with non sequential parser.
`static PDDocument`	`loadNonSeq(InputStream input, RandomAccess scratchFile, String password)` Parses PDF with non sequential parser.
`void`	`openProtection(DecryptionMaterial pm)` Tries to decrypt the document in memory using the provided decryption material.
`void`	`print()` This will send the PDF document to a printer.
`void`	`print(PrinterJob printJob)`
`void`	`protect(ProtectionPolicy pp)` Protects the document with the protection policy pp.
`boolean`	`removePage(int pageNumber)` Remove the page from the document.
`boolean`	`removePage(PDPage page)` Remove the page from the document.
`void`	`save(File file)` Save the document to a file.
`void`	`save(OutputStream output)` This will save the document to an output stream.
`void`	`save(String fileName)` Save the document to a file.
`void`	`saveIncremental(InputStream input, OutputStream output)` Save the pdf as incremental.
`void`	`saveIncremental(String fileName)` Save the pdf as incremental.
`void`	`setAllSecurityToBeRemoved(boolean removeAllSecurity)` Activates/Deactivates the removal of all security when writing the pdf.
`void`	`setDocumentId(Long docId)`
`void`	`setDocumentInformation(PDDocumentInformation info)` This will set the document information for this document.
`void`	`setEncryptionDictionary(PDEncryptionDictionary encDictionary)` This will set the encryption dictionary for this document.
`boolean`	`setSecurityHandler(SecurityHandler secHandler)` Sets security handler if none is set already.
`void`	`silentPrint()` This will send the PDF to the default printer without prompting the user for any printer settings.
`void`	`silentPrint(PrinterJob printJob)` This will send the PDF to the default printer without prompting the user for any printer settings.
`boolean`	`wasDecryptedWithOwnerPassword()` Deprecated. use `getCurrentAccessPermission` instead
`boolean`	`willEncryptWhenSaving()` Deprecated. Do not rely on this method anymore. It is the responsibility of COSWriter to hold this state

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

- Constructor Detail
  - PDDocument
```
public PDDocument()
```
    Constructor, creates a new PDF Document with no pages. You need to add at least one page for the document to be valid.
  - PDDocument
```
public PDDocument(COSDocument doc)
```
    Constructor that uses an existing document. The COSDocument that is passed in must be valid.
    
    Parameters:
    doc - The COSDocument that this document wraps.
  - PDDocument
```
public PDDocument(COSDocument doc,
          BaseParser usedParser)
```
    Constructor that uses an existing document. The COSDocument that is passed in must be valid.
    
    Parameters:
    doc - The COSDocument that this document wraps.
    usedParser - the parser which is used to read the pdf
- Method Detail
  - getPageMap
```
public final Map<String,Integer> getPageMap()
```
    This will return the Map containing the mapping from object-ids to pagenumbers.
    
    Returns:
    the pageMap
  - addPage
```
public void addPage(PDPage page)
```
    This will add a page to the document. This is a convenience method, that will add the page to the root of the hierarchy and set the parent of the page to the root.
    
    Parameters:
    page - The page to add to the document.
  - addSignature
```
public void addSignature(PDSignature sigObject,
                SignatureInterface signatureInterface)
                  throws IOException,
                         SignatureException
```
    Add a signature.
    
    Parameters:
    sigObject - is the PDSignature model
    signatureInterface - is a interface which provides signing capabilities
    
    Throws:
    
    IOException - if there is an error creating required fields
    
    SignatureException - if something went wrong
  - addSignature
```
public void addSignature(PDSignature sigObject,
                SignatureInterface signatureInterface,
                SignatureOptions options)
                  throws IOException,
                         SignatureException
```
    This will add a signature to the document.
    
    Parameters:
    sigObject - is the PDSignature model
    signatureInterface - is a interface which provides signing capabilities
    options - signature options
    
    Throws:
    
    IOException - if there is an error creating required fields
    
    SignatureException - if something went wrong
  - addSignatureField
```
public void addSignatureField(List<PDSignatureField> sigFields,
                     SignatureInterface signatureInterface,
                     SignatureOptions options)
                       throws IOException,
                              SignatureException
```
    This will add a signaturefield to the document.
    
    Parameters:
    sigFields - are the PDSignatureFields that should be added to the document
    signatureInterface - is a interface which provides signing capabilities
    options - signature options
    
    Throws:
    
    IOException - if there is an error creating required fields
    
    SignatureException
  - removePage
```
public boolean removePage(PDPage page)
```
    Remove the page from the document.
    
    Parameters:
    page - The page to remove from the document.
    
    Returns:
    true if the page was found false otherwise.
  - removePage
```
public boolean removePage(int pageNumber)
```
    Remove the page from the document.
    
    Parameters:
    pageNumber - 0 based index to page number.
    
    Returns:
    true if the page was found false otherwise.
  - importPage
```
public PDPage importPage(PDPage page)
                  throws IOException
```
    This will import and copy the contents from another location. Currently the content stream is stored in a scratch file. The scratch file is associated with the document. If you are adding a page to this document from another document and want to copy the contents to this document's scratch file then use this method otherwise just use the addPage method.
    
    Parameters:
    page - The page to import.
    
    Returns:
    The page that was imported.
    
    Throws:
    
    IOException - If there is an error copying the page.
  - getDocument
```
public COSDocument getDocument()
```
    This will get the low level document.
    
    Returns:
    The document that this layer sits on top of.
  - getDocumentInformation
```
public PDDocumentInformation getDocumentInformation()
```
    This will get the document info dictionary. This is guaranteed to not return null.
    
    Returns:
    The documents /Info dictionary
  - setDocumentInformation
```
public void setDocumentInformation(PDDocumentInformation info)
```
    This will set the document information for this document.
    
    Parameters:
    info - The updated document information.
  - getDocumentCatalog
```
public PDDocumentCatalog getDocumentCatalog()
```
    This will get the document CATALOG. This is guaranteed to not return null.
    
    Returns:
    The documents /Root dictionary
  - isEncrypted
```
public boolean isEncrypted()
```
    This will tell if this document is encrypted or not.
    
    Returns:
    true If this document is encrypted.
  - getEncryptionDictionary
```
public PDEncryptionDictionary getEncryptionDictionary()
                                               throws IOException
```
    This will get the encryption dictionary for this document. This will still return the parameters if the document was decrypted. If the document was never encrypted then this will return null. As the encryption architecture in PDF documents is plugable this returns an abstract class, but the only supported subclass at this time is a PDStandardEncryption object.
    
    Returns:
    The encryption dictionary(most likely a PDStandardEncryption object)
    
    Throws:
    
    IOException - If there is an error determining which security handler to use.
  - setEncryptionDictionary
```
public void setEncryptionDictionary(PDEncryptionDictionary encDictionary)
                             throws IOException
```
    This will set the encryption dictionary for this document.
    
    Parameters:
    encDictionary - The encryption dictionary(most likely a PDStandardEncryption object)
    
    Throws:
    
    IOException - If there is an error determining which security handler to use.
  - getSignatureDictionary
```
@Deprecated
public PDSignature getSignatureDictionary()
                                   throws IOException
```
    Deprecated. use getLastSignatureDictionary() instead.
    
    This will return the last signature.
    
    Returns:
    the last signature as PDSignature.
    
    Throws:
    
    IOException - if no document catalog can be found.
  - getLastSignatureDictionary
```
public PDSignature getLastSignatureDictionary()
                                       throws IOException
```
    This will return the last signature.
    
    Returns:
    the last signature as PDSignature.
    
    Throws:
    
    IOException - if no document catalog can be found.
  - getSignatureFields
```
public List<PDSignatureField> getSignatureFields()
                                          throws IOException
```
    Retrieve all signature fields from the document.
    
    Returns:
    a List of PDSignatureFields
    
    Throws:
    
    IOException - if no document catalog can be found.
  - getSignatureDictionaries
```
public List<PDSignature> getSignatureDictionaries()
                                           throws IOException
```
    Retrieve all signature dictionaries from the document.
    
    Returns:
    a List of PDSignatures
    
    Throws:
    
    IOException - if no document catalog can be found.
  - isUserPassword
```
@Deprecated
public boolean isUserPassword(String password)
                       throws IOException,
                              CryptographyException
```
    Deprecated.
    
    This will determine if this is the user password. This only applies when the document is encrypted and uses standard encryption.
    
    Parameters:
    password - The plain text user password.
    
    Returns:
    true If the password passed in matches the user password used to encrypt the document.
    
    Throws:
    
    IOException - If there is an error determining if it is the user password.
    
    CryptographyException - If there is an error in the encryption algorithms.
  - isOwnerPassword
```
@Deprecated
public boolean isOwnerPassword(String password)
                        throws IOException,
                               CryptographyException
```
    Deprecated.
    
    This will determine if this is the owner password. This only applies when the document is encrypted and uses standard encryption.
    
    Parameters:
    password - The plain text owner password.
    
    Returns:
    true If the password passed in matches the owner password used to encrypt the document.
    
    Throws:
    
    IOException - If there is an error determining if it is the user password.
    
    CryptographyException - If there is an error in the encryption algorithms.
  - decrypt
```
public void decrypt(String password)
             throws CryptographyException,
                    IOException
```
    This will decrypt a document. This method is provided for compatibility reasons only. User should use the new security layer instead and the openProtection method especially.
    
    Parameters:
    password - Either the user or owner password.
    
    Throws:
    
    CryptographyException - If there is an error decrypting the document.
    
    IOException - If there is an error getting the stream data.
  - wasDecryptedWithOwnerPassword
```
@Deprecated
public boolean wasDecryptedWithOwnerPassword()
```
    Deprecated. use getCurrentAccessPermission instead
    
    This will tell if the document was decrypted with the master password. This entry is invalid if the PDF was not decrypted.
    
    Returns:
    true if the pdf was decrypted with the master password.
  - encrypt
```
public void encrypt(String ownerPassword,
           String userPassword)
             throws CryptographyException,
                    IOException
```
    This will mark a document to be encrypted. The actual encryption will occur when the document is saved. This method is provided for compatibility reasons only. User should use the new security layer instead and the openProtection method especially.
    
    Parameters:
    ownerPassword - The owner password to encrypt the document.
    userPassword - The user password to encrypt the document.
    
    Throws:
    
    CryptographyException - If an error occurs during encryption.
    
    IOException - If there is an error accessing the data.
  - getOwnerPasswordForEncryption
```
@Deprecated
public String getOwnerPasswordForEncryption()
```
    Deprecated. Do not rely on this method anymore.
    
    The owner password that was passed into the encrypt method. You should never use this method. This will not longer be valid once encryption has occured.
    
    Returns:
    The owner password passed to the encrypt method.
  - getUserPasswordForEncryption
```
@Deprecated
public String getUserPasswordForEncryption()
```
    Deprecated. Do not rely on this method anymore.
    
    The user password that was passed into the encrypt method. You should never use this method. This will not longer be valid once encryption has occured.
    
    Returns:
    The user password passed to the encrypt method.
  - willEncryptWhenSaving
```
@Deprecated
public boolean willEncryptWhenSaving()
```
    Deprecated. Do not rely on this method anymore. It is the responsibility of COSWriter to hold this state
    
    Internal method do determine if the document will be encrypted when it is saved.
    
    Returns:
    True if encrypt has been called and the document has not been saved yet.
  - clearWillEncryptWhenSaving
```
@Deprecated
public void clearWillEncryptWhenSaving()
```
    Deprecated. Do not rely on this method anymore. It is the responsability of COSWriter to hold this state.
    
    This shoule only be called by the COSWriter after encryption has completed.
  - load
```
public static PDDocument load(URL url)
                       throws IOException
```
    This will load a document from a url.
    
    Parameters:
    url - The url to load the PDF from.
    
    Returns:
    The document that was loaded.
    
    Throws:
    
    IOException - If there is an error reading from the stream.
  - load
```
public static PDDocument load(URL url,
              boolean force)
                       throws IOException
```
    This will load a document from a url. Used for skipping corrupt pdf objects
    
    Parameters:
    url - The url to load the PDF from.
    force - When true, the parser will skip corrupt pdf objects and will continue parsing at the next object in the file
    
    Returns:
    The document that was loaded.
    
    Throws:
    
    IOException - If there is an error reading from the stream.
  - load
```
public static PDDocument load(URL url,
              RandomAccess scratchFile)
                       throws IOException
```
    This will load a document from a url.
    
    Parameters:
    url - The url to load the PDF from.
    scratchFile - A location to store temp PDFBox data for this document.
    
    Returns:
    The document that was loaded.
    
    Throws:
    
    IOException - If there is an error reading from the stream.
  - load
```
public static PDDocument load(String filename)
                       throws IOException
```
    This will load a document from a file.
    
    Parameters:
    filename - The name of the file to load.
    
    Returns:
    The document that was loaded.
    
    Throws:
    
    IOException - If there is an error reading from the stream.
  - load
```
public static PDDocument load(String filename,
              boolean force)
                       throws IOException
```
    This will load a document from a file. Allows for skipping corrupt pdf objects
    
    Parameters:
    filename - The name of the file to load.
    force - When true, the parser will skip corrupt pdf objects and will continue parsing at the next object in the file
    
    Returns:
    The document that was loaded.
    
    Throws:
    
    IOException - If there is an error reading from the stream.
  - load
```
public static PDDocument load(String filename,
              RandomAccess scratchFile)
                       throws IOException
```
    This will load a document from a file.
    
    Parameters:
    filename - The name of the file to load.
    scratchFile - A location to store temp PDFBox data for this document.
    
    Returns:
    The document that was loaded.
    
    Throws:
    
    IOException - If there is an error reading from the stream.
  - load
```
public static PDDocument load(File file)
                       throws IOException
```
    This will load a document from a file.
    
    Parameters:
    file - The name of the file to load.
    
    Returns:
    The document that was loaded.
    
    Throws:
    
    IOException - If there is an error reading from the stream.
  - load
```
public static PDDocument load(File file,
              RandomAccess scratchFile)
                       throws IOException
```
    This will load a document from a file.
    
    Parameters:
    file - The name of the file to load.
    scratchFile - A location to store temp PDFBox data for this document.
    
    Returns:
    The document that was loaded.
    
    Throws:
    
    IOException - If there is an error reading from the stream.
  - load
```
public static PDDocument load(InputStream input)
                       throws IOException
```
    This will load a document from an input stream.
    
    Parameters:
    input - The stream that contains the document.
    
    Returns:
    The document that was loaded.
    
    Throws:
    
    IOException - If there is an error reading from the stream.
  - load
```
public static PDDocument load(InputStream input,
              boolean force)
                       throws IOException
```
    This will load a document from an input stream. Allows for skipping corrupt pdf objects
    
    Parameters:
    input - The stream that contains the document.
    force - When true, the parser will skip corrupt pdf objects and will continue parsing at the next object in the file
    
    Returns:
    The document that was loaded.
    
    Throws:
    
    IOException - If there is an error reading from the stream.
  - load
```
public static PDDocument load(InputStream input,
              RandomAccess scratchFile)
                       throws IOException
```
    This will load a document from an input stream.
    
    Parameters:
    input - The stream that contains the document.
    scratchFile - A location to store temp PDFBox data for this document.
    
    Returns:
    The document that was loaded.
    
    Throws:
    
    IOException - If there is an error reading from the stream.
  - load
```
public static PDDocument load(InputStream input,
              RandomAccess scratchFile,
              boolean force)
                       throws IOException
```
    This will load a document from an input stream. Allows for skipping corrupt pdf objects
    
    Parameters:
    input - The stream that contains the document.
    scratchFile - A location to store temp PDFBox data for this document.
    force - When true, the parser will skip corrupt pdf objects and will continue parsing at the next object in the file
    
    Returns:
    The document that was loaded.
    
    Throws:
    
    IOException - If there is an error reading from the stream.
  - loadNonSeq
```
public static PDDocument loadNonSeq(File file,
                    RandomAccess scratchFile)
                             throws IOException
```
    Parses PDF with non sequential parser.
    
    Parameters:
    file - file to be loaded
    scratchFile - location to store temp PDFBox data for this document
    
    Returns:
    loaded document
    
    Throws:
    
    IOException - in case of a file reading or parsing error
  - loadNonSeq
```
public static PDDocument loadNonSeq(File file,
                    RandomAccess scratchFile,
                    String password)
                             throws IOException
```
    Parses PDF with non sequential parser.
    
    Parameters:
    file - file to be loaded
    scratchFile - location to store temp PDFBox data for this document
    password - password to be used for decryption
    
    Returns:
    loaded document
    
    Throws:
    
    IOException - in case of a file reading or parsing error
  - loadNonSeq
```
public static PDDocument loadNonSeq(InputStream input,
                    RandomAccess scratchFile)
                             throws IOException
```
    Parses PDF with non sequential parser.
    
    Parameters:
    input - stream that contains the document.
    scratchFile - location to store temp PDFBox data for this document
    
    Returns:
    loaded document
    
    Throws:
    
    IOException - in case of a file reading or parsing error
  - loadNonSeq
```
public static PDDocument loadNonSeq(InputStream input,
                    RandomAccess scratchFile,
                    String password)
                             throws IOException
```
    Parses PDF with non sequential parser.
    
    Parameters:
    input - stream that contains the document.
    scratchFile - location to store temp PDFBox data for this document
    password - password to be used for decryption
    
    Returns:
    loaded document
    
    Throws:
    
    IOException - in case of a file reading or parsing error
  - save
```
public void save(String fileName)
          throws IOException,
                 COSVisitorException
```
    Save the document to a file.
    
    Parameters:
    fileName - The file to save as.
    
    Throws:
    
    IOException - If there is an error saving the document.
    
    COSVisitorException - If an error occurs while generating the data.
  - save
```
public void save(File file)
          throws IOException,
                 COSVisitorException
```
    Save the document to a file.
    
    Parameters:
    file - The file to save as.
    
    Throws:
    
    IOException - If there is an error saving the document.
    
    COSVisitorException - If an error occurs while generating the data.
  - save
```
public void save(OutputStream output)
          throws IOException,
                 COSVisitorException
```
    This will save the document to an output stream.
    
    Parameters:
    output - The stream to write to.
    
    Throws:
    
    IOException - If there is an error writing the document.
    
    COSVisitorException - If an error occurs while generating the data.
  - saveIncremental
```
public void saveIncremental(String fileName)
                     throws IOException,
                            COSVisitorException
```
    Save the pdf as incremental.
    
    Parameters:
    fileName - the filename to be used
    
    Throws:
    
    IOException - if something went wrong
    
    COSVisitorException - if something went wrong
  - saveIncremental
```
public void saveIncremental(InputStream input,
                   OutputStream output)
                     throws IOException,
                            COSVisitorException
```
    Save the pdf as incremental.
    
    Parameters:
    input -
    output -
    
    Throws:
    
    IOException - if something went wrong
    
    COSVisitorException - if something went wrong
  - getPageCount
```
@Deprecated
public int getPageCount()
```
    Deprecated. Use the getNumberOfPages method instead!
    
    This will return the total page count of the PDF document. Note: This method is deprecated in favor of the getNumberOfPages method. The getNumberOfPages is a required interface method of the Pageable interface. This method will be removed in a future version of PDFBox!!
    
    Returns:
    The total number of pages in the PDF document.
  - getNumberOfPages
```
public int getNumberOfPages()
```
    Specified by:
    
    getNumberOfPages in interface Pageable
  - getPageFormat
```
@Deprecated
public PageFormat getPageFormat(int pageIndex)
```
    Deprecated. Use the PDPageable adapter class
    
    Returns the format of the page at the given index when using a default printer job returned by PrinterJob.getPrinterJob().
    
    Specified by:
    
    getPageFormat in interface Pageable
    
    Parameters:
    pageIndex - page index, zero-based
    
    Returns:
    page format
  - getPrintable
```
public Printable getPrintable(int pageIndex)
```
    Specified by:
    
    getPrintable in interface Pageable
  - print
```
public void print(PrinterJob printJob)
           throws PrinterException
```
    Parameters:
    printJob - The printer job.
    
    Throws:
    
    PrinterException - If there is an error while sending the PDF to the printer, or you do not have permissions to print this document.
    See Also:
    print()
  - print
```
public void print()
           throws PrinterException
```
    This will send the PDF document to a printer. The printing functionality depends on the org.apache.pdfbox.pdfviewer.PageDrawer functionality. The PageDrawer is a work in progress and some PDFs will print correctly and some will not. This is a convenience method to create the java.awt.print.PrinterJob. The PDDocument implements the java.awt.print.Pageable interface and PDPage implementes the java.awt.print.Printable interface, so advanced printing capabilities can be done by using those interfaces instead of this method.
    
    Throws:
    
    PrinterException - If there is an error while sending the PDF to the printer, or you do not have permissions to print this document.
  - silentPrint
```
public void silentPrint()
                 throws PrinterException
```
    This will send the PDF to the default printer without prompting the user for any printer settings.
    
    Throws:
    
    PrinterException - If there is an error while printing.
    See Also:
    print()
  - silentPrint
```
public void silentPrint(PrinterJob printJob)
                 throws PrinterException
```
    This will send the PDF to the default printer without prompting the user for any printer settings.
    
    Parameters:
    printJob - A printer job definition.
    
    Throws:
    
    PrinterException - If there is an error while printing.
    See Also:
    print()
  - close
```
public void close()
           throws IOException
```
    This will close the underlying COSDocument object.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    IOException - If there is an error releasing resources.
  - protect
```
public void protect(ProtectionPolicy pp)
             throws BadSecurityHandlerException
```
    Protects the document with the protection policy pp. The document content will be really encrypted when it will be saved. This method only marks the document for encryption.
    
    Parameters:
    pp - The protection policy.
    
    Throws:
    
    BadSecurityHandlerException - If there is an error during protection.
    See Also:
    StandardProtectionPolicy, PublicKeyProtectionPolicy
  - openProtection
```
public void openProtection(DecryptionMaterial pm)
                    throws BadSecurityHandlerException,
                           IOException,
                           CryptographyException
```
    Tries to decrypt the document in memory using the provided decryption material.
    
    Parameters:
    pm - The decryption material (password or certificate).
    
    Throws:
    
    BadSecurityHandlerException - If there is an error during decryption.
    
    IOException - If there is an error reading cryptographic information.
    
    CryptographyException - If there is an error during decryption.
    See Also:
    StandardDecryptionMaterial, PublicKeyDecryptionMaterial
  - getCurrentAccessPermission
```
public AccessPermission getCurrentAccessPermission()
```
    Returns the access permissions granted when the document was decrypted. If the document was not decrypted this method returns the access permission for a document owner (ie can do everything). The returned object is in read only mode so that permissions cannot be changed. Methods providing access to content should rely on this object to verify if the current user is allowed to proceed.
    
    Returns:
    the access permissions for the current user on the document.
  - getSecurityHandler
```
public SecurityHandler getSecurityHandler()
```
    Get the security handler that is used for document encryption.
    
    Returns:
    The handler used to encrypt/decrypt the document.
  - setSecurityHandler
```
public boolean setSecurityHandler(SecurityHandler secHandler)
```
    Sets security handler if none is set already.
    
    Parameters:
    secHandler - security handler to be assigned to document
    
    Returns:
    true if security handler was set, false otherwise (a security handler was already set)
  - isAllSecurityToBeRemoved
```
public boolean isAllSecurityToBeRemoved()
```
    Indicates if all security is removed or not when writing the pdf.
    
    Returns:
    returns true if all security shall be removed otherwise false
  - setAllSecurityToBeRemoved
```
public void setAllSecurityToBeRemoved(boolean removeAllSecurity)
```
    Activates/Deactivates the removal of all security when writing the pdf.
    
    Parameters:
    removeAllSecurity - remove all security if set to true
  - getDocumentId
```
public Long getDocumentId()
```
  - setDocumentId
```
public void setDocumentId(Long docId)
```

Class PDDocument

Field Summary

Fields inherited from interface java.awt.print.Pageable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PDDocument

PDDocument

PDDocument

Method Detail

getPageMap

addPage

addSignature

addSignature

addSignatureField

removePage

removePage

importPage

getDocument

getDocumentInformation

setDocumentInformation

getDocumentCatalog

isEncrypted

getEncryptionDictionary

setEncryptionDictionary

getSignatureDictionary

getLastSignatureDictionary

getSignatureFields

getSignatureDictionaries

isUserPassword

isOwnerPassword

decrypt

wasDecryptedWithOwnerPassword

encrypt

getOwnerPasswordForEncryption

getUserPasswordForEncryption

willEncryptWhenSaving

clearWillEncryptWhenSaving

load

load

load

load

load

load

load

load

load

load

load

load

loadNonSeq

loadNonSeq

loadNonSeq

loadNonSeq

save

save

save

saveIncremental

saveIncremental

getPageCount

getNumberOfPages

getPageFormat

getPrintable

print

print

silentPrint

silentPrint

close

protect

openProtection

getCurrentAccessPermission

getSecurityHandler

setSecurityHandler

isAllSecurityToBeRemoved

setAllSecurityToBeRemoved

getDocumentId

setDocumentId