COSWriterXRefEntry (Apache PDFBox 2.0.0-SNAPSHOT API)

Prev Class
Prev Class
Next Class

Prev Class
Prev Class
Next Class

PDDestinationNameTreeNode (Apache PDFBox 2.0.0-SNAPSHOT API)

public class PDDestinationNameTreeNode
 extends PDNameTreeNode

This class holds all of the name trees that are available at the document level.

Version:: $Revision: 1.2 $
Author:: Ben Litchfield

Author:: Ben Litchfield

public class PDDocument @@ -203,25 +199,6 @@ implements -void -decrypt(String password) -

Deprecated. -

This method is provided for compatibility reasons only. User should use the new - security layer instead and the openProtection method especially.

- - - -void -encrypt(String ownerPassword, - String userPassword) -

Deprecated. -

This method is provided for compatibility reasons only. User should use the new security layer - instead and the openProtection method especially.

- - - AccessPermission getCurrentAccessPermission()

Returns the access permissions granted when the document was decrypted.

@@ -258,33 +235,17 @@ implements -PDEncryption -getEncryptionDictionary() -

Deprecated. -

Use getEncryption() instead.

- - - PDSignature getLastSignatureDictionary()

This will return the last signature.

- + int getNumberOfPages()

This will return the total page count of the PDF document.

- -String -getOwnerPasswordForEncryption() -

Deprecated. -

Do not rely on this method anymore.

- - PDPage getPage(int pageIndex) @@ -296,73 +257,62 @@ implements getPages() -SecurityHandler -getSecurityHandler() -

Deprecated. -

Use getEncryption(). - PDEncryption.getSecurityHandler()

- - - List<PDSignature> getSignatureDictionaries()

Retrieve all signature dictionaries from the document.

- + List<PDSignatureField> getSignatureFields()

Retrieve all signature fields from the document.

- -String -getUserPasswordForEncryption() -

Deprecated. -

Do not rely on this method anymore.

+ +float +getVersion() +

Returns the PDF specification version this document conforms to.

- + 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.

- + static PDDocument load(File file)

Parses PDF with non sequential parser.

- + static PDDocument load(File file, boolean useScratchFiles)

Parses PDF with non sequential parser.

- + static PDDocument load(File file, String password)

Parses PDF with non sequential parser.

- + static PDDocument load(File file, String password, @@ -370,7 +320,7 @@ implements Parses PDF with non sequential parser. - + static PDDocument load(File file, String password, @@ -379,7 +329,7 @@ implements Parses PDF with non sequential parser. - + static PDDocument load(File file, String password, @@ -389,27 +339,27 @@ implements Parses PDF with non sequential parser. - + static PDDocument load(InputStream input) Parses PDF with non sequential parser. - + static PDDocument load(InputStream input, boolean useScratchFiles) Parses PDF with non sequential parser. - + static PDDocument load(InputStream input, String password) Parses PDF with non sequential parser. - + static PDDocument load(InputStream input, String password, @@ -418,7 +368,7 @@ implements Parses PDF with non sequential parser. - + static PDDocument load(InputStream input, String password, @@ -428,38 +378,6 @@ implements Parses PDF with non sequential parser. - -static PDDocument -loadLegacy(File file) -This will load a document from a file. - - - -static PDDocument -loadLegacy(File file, - boolean useScratchFiles) -This will load a document from a file. - - - -static PDDocument -loadLegacy(InputStream input) -This will load a document from an input stream. - - - -static PDDocument -loadLegacy(InputStream input, - boolean useScratchFiles) -This will load a document from an input stream. - - - -void -openProtection(DecryptionMaterial decryptionMaterial) -Tries to decrypt the document in memory using the provided decryption material. - - void protect(ProtectionPolicy policy) @@ -498,23 +416,8 @@ implements void -saveIncremental(InputStream input, - OutputStream output) -Save the PDF as an incremental update, explicitly providing the original input stream again. - - - -void saveIncremental(OutputStream output) -Save the PDF as an incremental update, if it was loaded from a File. - - - -void -saveIncremental(String fileName) -Deprecated. -Use saveIncremental(OutputStream output) instead. - +Save the PDF as an incremental update. @@ -542,11 +445,9 @@ implements -boolean -setSecurityHandler(SecurityHandler securityHandler) -Deprecated. -Use protection policies instead. - +void +setVersion(float newVersion) +Sets the PDF specification version for this document. @@ -780,18 +681,6 @@ implements Returns:true If this document is encrypted. - - - - - -getEncryptionDictionary -@Deprecated -public PDEncryption getEncryptionDictionary() -Deprecated. Use getEncryption() instead. -Returns: The encryption dictionary(most likely a PDStandardEncryption object) - - @@ -862,131 +751,6 @@ public IOException - if no document catalog can be found. - - - - - -decrypt -@Deprecated -public void decrypt(String password) - throws IOException -Deprecated. This method is provided for compatibility reasons only. User should use the new - security layer instead and the openProtection method especially. -This will decrypt a document. -Parameters: password - Either the user or owner password. -Throws: -IOException - If there is an error getting the stream data. - - - - - - - -encrypt -@Deprecated -public void encrypt(String ownerPassword, - String userPassword) - throws IOException -Deprecated. This method is provided for compatibility reasons only. User should use the new security layer - instead and the openProtection method especially. -This will mark a document to be encrypted. The actual encryption will occur when the document is saved. -Parameters: ownerPassword - The owner password to encrypt the document. userPassword - The user password to encrypt the document. -Throws: -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. - - - - - - - -loadLegacy -public static PDDocument loadLegacy(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. - - - - - - - -loadLegacy -public static PDDocument loadLegacy(File file, - boolean useScratchFiles) - throws IOException -This will load a document from a file. Allows for skipping corrupt pdf objects -Parameters: file - The name of the file to load. useScratchFiles - enables the usage of a scratch file if set to true -Returns: The document that was loaded. -Throws: -IOException - If there is an error reading from the stream. - - - - - - - -loadLegacy -public static PDDocument loadLegacy(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. - - - - - - - -loadLegacy -public static PDDocument loadLegacy(InputStream input, - boolean useScratchFiles) - 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. useScratchFiles - enables the usage of a scratch file if set to true -Returns: The document that was loaded. -Throws: -IOException - If there is an error reading from the stream. - - @@ -1214,39 +978,6 @@ public IOException - if the output could not be written - - - - - -saveIncremental -@Deprecated -public void saveIncremental(String fileName) - throws IOException -Deprecated. Use saveIncremental(OutputStream output) instead. -Save the pdf as incremental. -Parameters: fileName - the filename to be used -Throws: -IOException - if the output could not be written - - - - - - - -saveIncremental -public void saveIncremental(InputStream input, - OutputStream output) - throws IOException -Save the PDF as an incremental update, explicitly providing the original input stream again. - - Use of this method is discouraged, use saveIncremental(OutputStream) instead. -Parameters: input - stream to read, must contain the same data used in the call to load(). output - stream to write -Throws: -IOException - if the output could not be written - - @@ -1255,9 +986,7 @@ public void saveIncremental(saveIncremental public void saveIncremental(OutputStream output) throws IOException -Save the PDF as an incremental update, if it was loaded from a File. - This method can only be used when the PDDocument was created by passing a File or filename - to one of the load() constructors. +Save the PDF as an incremental update. Parameters: output - stream to write Throws: IOException - if the output could not be written @@ -1329,21 +1058,6 @@ public void saveIncremental(PublicKeyProtectionPolicy - - - - - -openProtection -public void openProtection(DecryptionMaterial decryptionMaterial) - throws IOException -Tries to decrypt the document in memory using the provided decryption material. -Parameters: decryptionMaterial - The decryption material (password or certificate). -Throws: -IOException - If there is an error reading cryptographic information. See Also: StandardDecryptionMaterial, -PublicKeyDecryptionMaterial - - @@ -1358,33 +1072,6 @@ public void saveIncremental(Returns: the access permissions for the current user on the document. - - - - - -getSecurityHandler -@Deprecated -public SecurityHandler getSecurityHandler() -Deprecated. Use getEncryption(). - PDEncryption.getSecurityHandler() -Get the security handler that is used for document encryption. -Returns: The handler used to encrypt/decrypt the document. - - - - - - - -setSecurityHandler -@Deprecated -public boolean setSecurityHandler(SecurityHandler securityHandler) -Deprecated. Use protection policies instead. -Parameters: securityHandler - security handler to be assigned to document -Returns: true if security handler was set - - @@ -1421,7 +1108,7 @@ public boolean setSecurityHand - + setDocumentId public void setDocumentId(Long docId) @@ -1429,6 +1116,28 @@ public boolean setSecurityHand Parameters: docId - the new document ID + + + + + +getVersion +public float getVersion() +Returns the PDF specification version this document conforms to. +Returns: the PDF version (e.g. 1.4f) + + + + + + + +setVersion +public void setVersion(float newVersion) +Sets the PDF specification version for this document. +Parameters: newVersion - the new PDF version (e.g. 1.4f) + + Modified: pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/PDDocumentCatalog.html URL: http://svn.apache.org/viewvc/pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/PDDocumentCatalog.html?rev=1669997&r1=1669996&r2=1669997&view=diff ============================================================================== --- pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/PDDocumentCatalog.html (original) +++ pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/PDDocumentCatalog.html Mon Mar 30 05:51:10 2015 @@ -2,10 +2,10 @@ - + PDDocumentCatalog (Apache PDFBox 2.0.0-SNAPSHOT API) - + @@ -214,7 +214,7 @@ implements List<PDOutputIntent> -getOutputIntent() +getOutputIntents() Get the list of OutputIntents defined in the document. @@ -251,7 +251,7 @@ implements List<PDThread> getThreads() -Returns the document? +Returns the document's article threads. @@ -530,7 +530,7 @@ implements getThreads public List<PDThread> getThreads() -Returns the document?s article threads. +Returns the document's article threads. @@ -657,13 +657,13 @@ implements Parameters:markInfo - The new MarkInfo data. - + -getOutputIntent -public List<PDOutputIntent> getOutputIntent() +getOutputIntents +public List<PDOutputIntent> getOutputIntents() Get the list of OutputIntents defined in the document. Returns: The list of PDOutputIntent

getNullEntry

getKey

setOffset

getEncryptionDictionary

decrypt

encrypt

getOwnerPasswordForEncryption

getUserPasswordForEncryption

loadLegacy

loadLegacy

loadLegacy

loadLegacy

saveIncremental

saveIncremental

openProtection

getSecurityHandler

setSecurityHandler

setDocumentId

getVersion

setVersion

getThreads

getOutputIntent

getOutputIntents