com.compdfkit.core.document

Class CPDFDocument

java.lang.Object

com.compdfkit.core.document.CPDFDocument

public class CPDFDocument
extends java.lang.Object

Document instance. One CPDFDocument object for one document. This class is used to represent a specified directory, which contains PDF files and user wants to search among these PDF files.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CPDFDocument.CompressListener
static interface	CPDFDocument.ExtractImageListener
static class	CPDFDocument.PDFDocMdpP
static class	CPDFDocument.PDFDocumentCompressLevel Options to specify compress level.
static class	CPDFDocument.PDFDocumentEncryptAlgo
static class	CPDFDocument.PDFDocumentError Error types of the opening document
static class	CPDFDocument.PDFDocumentImageMode Options to specify how a view adjusts its content when its size changes.
static class	CPDFDocument.PDFDocumentPermissions Document permission.
static class	CPDFDocument.PDFDocumentSaveType Document save type.
static class	CPDFDocument.PDFDocumentType PDF/A conformance levels.
static interface	CPDFDocument.SignatureRemoveListener

Constructor Summary

Constructors

Constructor and Description
CPDFDocument(android.content.Context context) Creates PDF document by context.

Method Summary

Modifier and Type	Method and Description
boolean	addBookmark(CPDFBookmark bookmark) Adds bookmark.
boolean	addPage(CPDFPage page, int index) Add page to document
boolean	applyRedactions() Applies redaction annotations in current documentation.
boolean	canSaveIncrementally() Whether document can be saved incrementally.
boolean	checkOwnerPassword(java.lang.String password) Whether the owner password is correct.
boolean	checkOwnerUnlocked() Whether the owner permission is unlocked.
boolean	checkPassword(java.lang.String password, boolean bOwner) Whether the password is correct.
void	close() When the object is no longer in use, call this method to release resources.
boolean	convertType(CPDFDocument.PDFDocumentType documentType) Converts existing PDF files to PDF/A compliant documents, including PDF/A-1a and PDF/A-1b only.
CPDFPage	copyPage(int pageIndex) Copy the page at page index
static CPDFDocument	createDocument(android.content.Context context) Creates a CPDFDocument object with new PDF.
CPDFWatermark	createWatermark(CPDFWatermark.Type type) Creates watermark, more: CPDFWatermark.
boolean	exchangePage(int firstIndex, int secondIndex) Exchanges one page with another.
boolean	exportAnnotations(java.lang.String exportFilePath, java.lang.String tmpCachePath) Exports annotations to XFDF document.
boolean	extractImage(java.lang.String filePath, CPDFDocument.ExtractImageListener listener) Extract all images of the document.
boolean	extractImage(java.lang.String filePath, int[] pageArr, CPDFDocument.ExtractImageListener listener) Extract images at the specified page index array.
boolean	flattenAllPages(CPDFPage.PDFFlattenOption flattenOption) Flatten all pages.
java.lang.String	getAbsolutePath() Gets absolute path of document.
CPDFBackground	getBackground() Gets the background of the document.
CPDFBates	getBates() Gets the bates numbers of the document.
java.util.List<CPDFBookmark>	getBookmarks() Gets bookmark list of document, more:CPDFBookmark.
java.lang.String	getBuildTag() Gets build tag string of document.
android.content.Context	getContext() Gets context.
long	getDocPtr()
CPDFDocument.PDFDocumentEncryptAlgo	getEncryptAlgorithm()
java.lang.String	getFileName() Gets document name.
CPDFHeaderFooter	getHeaderFooter() Gets the header & footer of the document.
CPDFInfo	getInfo() Gets document information, more:CPDFInfo
int	getMajorVersion() Gets major version string of document.
int	getMinorVersion() Gets minor version string of document.
CPDFOutline	getOutlineRoot() Gets outline root of document, more:CPDFOutline.
int	getPageCount() Gets total count of document pages.
java.lang.String	getPageLabel(int pageIndex) Gets the page label at the specified index.
android.graphics.RectF	getPageSize(int pageIndex) Gets page size at the specified index.
java.lang.String	getPassword() Gets document password.
CPDFSignature	getPdfSignature(CPDFSignatureWidget signatureWidget) Get the signature of a signature widget.
CPDFSignature	getPdfSignature(int index) Get the signature at index.
CPDFDocument.PDFDocumentPermissions	getPermissions() Gets permission status of document, more:CPDFDocument.PDFDocumentPermissions.
CPDFDocumentPermissionInfo	getPermissionsInfo() Gets permission information of document, more:CPDFDocumentPermissionInfo
int	getReVersion() Gets revision string of document.
int	getSignatureCount() Gets the count of signature form in the document
CPDFDocument.PDFDocumentType	getType() Gets PDF/A conformance levels.
android.net.Uri	getUri() Gets document URI.
CPDFWatermark	getWatermark(int index) Gets CPDFWatermark according to index, more:CPDFWatermark.
int	getWatermarkCount() Gets the count of watermark in the document.
boolean	hasBookmark(int pageIndex) Whether it has bookmark at the specified index
boolean	hasChanges() Whether document is modified.
boolean	hasRepaired() Whether document is repaired.
boolean	importAnnotations(java.lang.String importFilePath, java.lang.String tmpCachePath) Import annotations from XFDF document.
boolean	importPages(CPDFDocument otherDocument, int[] pages, int insertPosition) Import page(s) from another document at the specified index point and insert to insertPosition.
boolean	importPages(CPDFDocument otherDocument, int start, int end, int insertPosition) Import page(s) from another document at the specified index point and insert to insertPosition.
int	indexOfPage(CPDFPage page) Gets the index number for the specified page.
CPDFPage	insertBlankPage(int pageIndex, float width, float height) Inserts a blank page at the specified index point.
CPDFPage	insertPageWithImage(int pageIndex, float width, float height, int fd) Inserts a blank page with image at the specified index point.
CPDFPage	insertPageWithImage(int pageIndex, float width, float height, int fd, CPDFDocument.PDFDocumentImageMode imageMode) Inserts a blank page with image at the specified index point.
CPDFPage	insertPageWithImagePath(int pageIndex, float width, float height, java.lang.String imagePath) Inserts a blank page with image at the specified index point.
CPDFPage	insertPageWithImagePath(int pageIndex, float width, float height, java.lang.String imagePath, CPDFDocument.PDFDocumentImageMode imageMode) Inserts a blank page with image at the specified index point.
boolean	isCanWrite() Whether it can write
boolean	isEncrypted() Whether document is encrypted.
boolean	isImageDoc() Whether the document is image document.
boolean	isLocked() Whether the document is locked.
boolean	isValid() Whether CPDFDocument object is valid, false means CPDFDocument object is released.
boolean	movePage(int fromIndex, int toIndex) Moves page.
CPDFOutline	newOutlineRoot() Creates a new outline root of document.
CPDFDocument.PDFDocumentError	open(java.lang.String absolutePath) Loads the document
CPDFDocument.PDFDocumentError	open(java.lang.String absolutePath, java.lang.String password) Loads the encrypted document.
CPDFDocument.PDFDocumentError	open(android.net.Uri uri) Loads the document by URI.
CPDFDocument.PDFDocumentError	open(android.net.Uri uri, java.lang.String password) Loads the encrypted document by URI.
CPDFDocument.PDFDocumentError	openWithoutPreload(android.os.ParcelFileDescriptor fd, java.lang.String password) Loads the document without preloading.
CPDFPage	pageAtIndex(int pageIndex) Returns a pageIndex object representing the page at index, more: CPDFPage.
void	releaseAllBookmarks() When TPDFBookmark is no longer in use, release all resource of TPDFBookmark.
void	releaseAllOutlines() When TPDFOutline is no longer in use, release all resource of TPDFOutline.
void	releaseAllPages() When CPDFPage is no longer in use, release all resource of CPDFPage.
void	releaseAllWatermarks() When CPDFWatermark is no longer in use, release all resource of CPDFWatermark.
void	releaseTextEdit() When CPDFPages is no longer in use, release all resource of CPDFPages.
CPDFDocument.PDFDocumentError	reload() Reloads document.
CPDFDocument.PDFDocumentError	reload(java.lang.String password) Reloads encrypted document.
boolean	removeAllAnnotations() Removes all annotations.
boolean	removeAllFormAnnotations() Removes all form widgets.
boolean	removeAllSignStamps() Removes all signature
boolean	removeBookmark(int pageIndex) Removes the bookmark at the specified index.
boolean	removePages(int[] pageIndexes) Remove page(s).
boolean	removeSignature(CPDFSignature signature, boolean isRemoveAP, CPDFDocument.SignatureRemoveListener listener) Remove signature.
boolean	renderPageAtIndex(android.graphics.Bitmap bitmap, int pageIndex, int width, int height, int patchX, int patchY, int patchW, int patchH, int bgColor, int alpha, int rotate, boolean isDrawAnnot, boolean isDrawForm) Render contents of a page to a device independent bitmap.
boolean	renderPageScreenShotAtIndex(android.graphics.Bitmap bitmap, int pageIndex, int width, int height, int patchX, int patchY, int patchW, int patchH, int bgColor, int alpha, int rotate, boolean isDrawAnnot, boolean isDrawForm)
boolean	resetAllForm() Resets all forms.
boolean	save() Saves the document incrementally.
boolean	save(CPDFDocument.PDFDocumentSaveType saveType) Saves the document.
boolean	save(CPDFDocument.PDFDocumentSaveType saveType, boolean fontSubset) Saves the document.
boolean	save(int fd, CPDFDocument.PDFDocumentSaveType saveType) Saves the document.
boolean	save(int fd, CPDFDocument.PDFDocumentSaveType saveType, boolean fontSubset) Saves the document.
boolean	saveAs(java.lang.String absolutePath, boolean removeSecurity) Saves document to the specified path after removing permissions.
boolean	saveAs(java.lang.String absolutePath, boolean removeSecurity, boolean saveByFile) Saves document to the specified path after removing permissions.
boolean	saveAs(java.lang.String absolutePath, boolean removeSecurity, boolean saveByFile, boolean fontSubset) Saves document to the specified path after removing permissions.
boolean	saveAs(android.net.Uri uri, boolean removeSecurity) Saves document to the specified URI.
boolean	saveAs(android.net.Uri uri, boolean removeSecurity, boolean fontSubset) Saves document to the specified URI.
boolean	saveAsCompressOptimize(java.lang.String absolutePath, CPDFDocument.PDFDocumentCompressLevel level, CPDFDocument.CompressListener listener) Saves document to the specified path after compressing.
boolean	saveAsCompressOptimize(java.lang.String absolutePath, int quality)
boolean	saveAsCompressOptimize(java.lang.String absolutePath, int quality, CPDFDocument.CompressListener listener) Saves document to the specified path after compressing.
boolean	setEncryptAlgorithm(CPDFDocument.PDFDocumentEncryptAlgo type)
boolean	setInfo(CPDFInfo info) Sets document information, more:CPDFInfo
boolean	setOwnerPassword(java.lang.String password) Not in use currently
boolean	setPermissionsInfo(CPDFDocumentPermissionInfo info) Sets permission information of document, more:CPDFDocumentPermissionInfo.
boolean	setUserPassword(java.lang.String password) Sets user password.
boolean	shouleReloadDocument() Whether to reload document, true means it needs to call reload(String) or reload() to reload document.
boolean	writeSignature(CPDFSignatureWidget signatureWidget, java.lang.String savePath, java.lang.String pkcs12certPath, java.lang.String password, java.lang.String location, java.lang.String reason, CPDFDocument.PDFDocMdpP type) Add a signature to document.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CPDFDocument

public CPDFDocument(android.content.Context context)

Creates PDF document by context.

Parameters:

context - Context.

Method Detail

getDocPtr

public long getDocPtr()

getContext

public android.content.Context getContext()

Gets context.

Returns:

Returns context.

open

public CPDFDocument.PDFDocumentError open(java.lang.String absolutePath)

Loads the document

Parameters:

absolutePath - Absolute path of document.

Returns:

Returns the error type when loading document.

open

public CPDFDocument.PDFDocumentError open(java.lang.String absolutePath,
                                          java.lang.String password)

Loads the encrypted document.

Parameters:

absolutePath - Absolute path of document.

password - Document password.

Returns:

Returns the error type when loading document.

open

public CPDFDocument.PDFDocumentError open(android.net.Uri uri)

Loads the document by URI.

Parameters:

uri - Document source.

Returns:

Returns the error type when loading document.

open

public CPDFDocument.PDFDocumentError open(android.net.Uri uri,
                                          java.lang.String password)

Loads the encrypted document by URI.

Parameters:

uri - Document source.

password - Document password.

Returns:

Returns the error type when loading document.

openWithoutPreload

public CPDFDocument.PDFDocumentError openWithoutPreload(android.os.ParcelFileDescriptor fd,
                                                        java.lang.String password)

Loads the document without preloading.

Parameters:

fd - File descriptor.

password - Document password.

Returns:

Returns the error type when loading document.

reload

public CPDFDocument.PDFDocumentError reload()

Reloads document.

Returns:

Returns the error type when loading document.

reload

public CPDFDocument.PDFDocumentError reload(java.lang.String password)

Reloads encrypted document.

Parameters:

password - Document password.

Returns:

Returns the error type when loading document.

isCanWrite

public boolean isCanWrite()

Whether it can write

Returns:

Whether it can write

getFileName

public java.lang.String getFileName()

Gets document name.

Returns:

Returns document name.

getUri

public android.net.Uri getUri()

Gets document URI.

Returns:

Returns document URI.

getAbsolutePath

public java.lang.String getAbsolutePath()

Gets absolute path of document.

Returns:

Returns absolute path of document.

createDocument

public static CPDFDocument createDocument(android.content.Context context)

Creates a CPDFDocument object with new PDF.

Parameters:

context - Context.

Returns:

Document object.

isEncrypted

public boolean isEncrypted()

Whether document is encrypted.

Returns:

Returns whether document is encrypted.

isLocked

public boolean isLocked()

Whether the document is locked.

Returns:

Returns whether the document is locked.

isImageDoc

public boolean isImageDoc()

Whether the document is image document. This is a time-consuming operation.

Returns:

Returns whether the document is image document

save

public boolean save()
             throws CPDFDocumentException

Saves the document incrementally.

Returns:

Returns whether to save the document incrementally.

Throws:

CPDFDocumentException

save

public boolean save(CPDFDocument.PDFDocumentSaveType saveType)
             throws CPDFDocumentException

Saves the document.

Parameters:

saveType - Method to save the document.

Returns:

Whether to successfully save the document.

Throws:

CPDFDocumentException

See Also:

CPDFDocument.PDFDocumentSaveType

save

public boolean save(CPDFDocument.PDFDocumentSaveType saveType,
                    boolean fontSubset)
             throws CPDFDocumentException

Saves the document.

Parameters:

saveType - Method to save the document.

fontSubset - Whether to font subset.

Returns:

Whether to successfully save the document.

Throws:

CPDFDocumentException

See Also:

CPDFDocument.PDFDocumentSaveType

save

public boolean save(int fd,
                    CPDFDocument.PDFDocumentSaveType saveType)

Saves the document.

Parameters:

fd - File descriptor.

saveType - Method to save the document.

Returns:

Returns whether to successfully save the document.

save

public boolean save(int fd,
                    CPDFDocument.PDFDocumentSaveType saveType,
                    boolean fontSubset)

Saves the document.

Parameters:

fd - File descriptor.

saveType - Method to save the document.

fontSubset - whether to font subset.

Returns:

Returns whether to successfully save the document.

saveAsCompressOptimize

public boolean saveAsCompressOptimize(java.lang.String absolutePath,
                                      CPDFDocument.PDFDocumentCompressLevel level,
                                      CPDFDocument.CompressListener listener)
                               throws CPDFDocumentException

Saves document to the specified path after compressing.

Parameters:

absolutePath - Absolute path of document

level - compress quality CPDFDocument.PDFDocumentCompressLevel

Returns:

Returns whether to successfully save document to the specified path after compressing.

Throws:

CPDFDocumentException

saveAsCompressOptimize

public boolean saveAsCompressOptimize(java.lang.String absolutePath,
                                      int quality,
                                      CPDFDocument.CompressListener listener)
                               throws CPDFDocumentException

Saves document to the specified path after compressing.

Parameters:

absolutePath - Absolute path of document

quality - compress quality between 1 ~ 120

Returns:

Returns whether to successfully save document to the specified path after compressing.

Throws:

CPDFDocumentException

saveAsCompressOptimize

public boolean saveAsCompressOptimize(java.lang.String absolutePath,
                                      int quality)
                               throws CPDFDocumentException

Throws:

CPDFDocumentException

saveAs

public boolean saveAs(java.lang.String absolutePath,
                      boolean removeSecurity)
               throws CPDFDocumentException

Saves document to the specified path after removing permissions.

Parameters:

absolutePath - Absolute path of document.

removeSecurity - Whether to remove password.

Returns:

Returns whether to successfully save the document to the specified path after removing permissions.

Throws:

CPDFDocumentException

saveAs

public boolean saveAs(java.lang.String absolutePath,
                      boolean removeSecurity,
                      boolean saveByFile)
               throws CPDFDocumentException

Saves document to the specified path after removing permissions.

Parameters:

absolutePath - Absolute path of document.

removeSecurity - Whether to remove password.

saveByFile - Whether to save by FILE, differ from using file descriptor of saveAs(String, boolean)}.

Returns:

Returns whether to successfully save the document to the specified path after removing permissions.

Throws:

CPDFDocumentException

saveAs

public boolean saveAs(java.lang.String absolutePath,
                      boolean removeSecurity,
                      boolean saveByFile,
                      boolean fontSubset)
               throws CPDFDocumentException

Saves document to the specified path after removing permissions.

Parameters:

absolutePath - Absolute path of document.

removeSecurity - Whether to remove password.

saveByFile - Whether to save by FILE, differ from using file descriptor of saveAs(String, boolean)}.

fontSubset - Whether to font subset.

Returns:

Returns whether to successfully save the document to the specified path after removing permissions.

Throws:

CPDFDocumentException

saveAs

public boolean saveAs(android.net.Uri uri,
                      boolean removeSecurity)
               throws CPDFDocumentException

Saves document to the specified URI.

Parameters:

uri - Output source of file.

removeSecurity - Whether to remove password.

Returns:

Returns whether to successfully save document to the specified URI.

Throws:

CPDFDocumentException

saveAs

public boolean saveAs(android.net.Uri uri,
                      boolean removeSecurity,
                      boolean fontSubset)
               throws CPDFDocumentException

Saves document to the specified URI.

Parameters:

uri - Output source of file.

removeSecurity - Whether to remove password.

fontSubset - Whether to font subset.

Returns:

Returns whether to successfully save document to the specified URI.

Throws:

CPDFDocumentException

getPermissions

public CPDFDocument.PDFDocumentPermissions getPermissions()

Gets permission status of document, more:CPDFDocument.PDFDocumentPermissions.

Returns:

Returns permission status of document.

checkOwnerUnlocked

public boolean checkOwnerUnlocked()

Whether the owner permission is unlocked.

Returns:

Returns whether the owner permission is unlocked.

checkPassword

public boolean checkPassword(java.lang.String password,
                             boolean bOwner)

Whether the password is correct.

Parameters:

password - The password to check.

bOwner - Whether it is the owner password.

Returns:

Returns whether the password is correct.

getPermissionsInfo

public CPDFDocumentPermissionInfo getPermissionsInfo()

Gets permission information of document, more:CPDFDocumentPermissionInfo

Returns:

Returns permissions of document.

setPermissionsInfo

public boolean setPermissionsInfo(CPDFDocumentPermissionInfo info)

Sets permission information of document, more:CPDFDocumentPermissionInfo.

Parameters:

info - Permission information.

Returns:

Returns whether to successfully set document permission.

getInfo

public CPDFInfo getInfo()

Gets document information, more:CPDFInfo

Returns:

Returns document information.

setInfo

public boolean setInfo(CPDFInfo info)

Sets document information, more:CPDFInfo

Returns:

Returns true on success, false on failure.

getMajorVersion

public int getMajorVersion()

Gets major version string of document.

Returns:

Returns major version string of document.

getMinorVersion

public int getMinorVersion()

Gets minor version string of document.

Returns:

Returns minor version string of document.

getReVersion

public int getReVersion()

Gets revision string of document.

Returns:

Returns revision string of document.

getBuildTag

public java.lang.String getBuildTag()

Gets build tag string of document.

Returns:

Returns build tag string of document.

getOutlineRoot

public CPDFOutline getOutlineRoot()

Gets outline root of document, more:CPDFOutline.

Returns:

Returns outline root of document.

newOutlineRoot

public CPDFOutline newOutlineRoot()

Creates a new outline root of document. more:CPDFOutline.

Returns:

Returns outline root of document.

getBookmarks

public java.util.List<CPDFBookmark> getBookmarks()

Gets bookmark list of document, more:CPDFBookmark.

Returns:

Returns bookmark list of document.

hasBookmark

public boolean hasBookmark(int pageIndex)

Whether it has bookmark at the specified index

Parameters:

pageIndex - Page number

Returns:

Returns whether it has bookmark at the specified index.

addBookmark

public boolean addBookmark(CPDFBookmark bookmark)

Adds bookmark.

Parameters:

bookmark - Bookmark object.

Returns:

Returns whether to successfully add bookmark.

removeBookmark

public boolean removeBookmark(int pageIndex)

Removes the bookmark at the specified index.

Parameters:

pageIndex - Page index.

Returns:

Returns whether to successfully remove the bookmark at the specified index.

getPassword

public java.lang.String getPassword()

Gets document password.

Returns:

Returns document password.

getPageCount

public int getPageCount()

Gets total count of document pages.

Returns:

Returns total count of document pages.

getPageSize

public android.graphics.RectF getPageSize(int pageIndex)

Gets page size at the specified index.

Parameters:

pageIndex - Page index.

Returns:

Returns page size at the specified index.

getPageLabel

public java.lang.String getPageLabel(int pageIndex)

Gets the page label at the specified index.

Parameters:

pageIndex - Page index.

Returns:

Returns the page label at the specified index.

pageAtIndex

public CPDFPage pageAtIndex(int pageIndex)

Returns a pageIndex object representing the page at index, more: CPDFPage.

Parameters:

pageIndex - Page index.

Returns:

Returns a pageIndex object representing the page at index.

copyPage

public CPDFPage copyPage(int pageIndex)

Copy the page at page index

Parameters:

pageIndex - Page Index

Returns:

Returns a page object at index

addPage

public boolean addPage(CPDFPage page,
                       int index)

Add page to document

Parameters:

page - Page object to add to document.

index - Position to add to.

Returns:

Returns whether add is suceess.

indexOfPage

public int indexOfPage(CPDFPage page)

Gets the index number for the specified page.

Parameters:

page - Page object.

Returns:

Returns the index number for the specified page.

removePages

public boolean removePages(int[] pageIndexes)

Remove page(s).

Parameters:

pageIndexes - Page index array.

Returns:

Returns whether to successfully remove page(s).

insertBlankPage

public CPDFPage insertBlankPage(int pageIndex,
                                float width,
                                float height)

Inserts a blank page at the specified index point.

Parameters:

pageIndex - Page index.

width - Page width.

height - Page height.

Returns:

Returns the inserted blank page.

insertPageWithImage

public CPDFPage insertPageWithImage(int pageIndex,
                                    float width,
                                    float height,
                                    int fd)

Inserts a blank page with image at the specified index point.

Parameters:

pageIndex - Page.

width - Page width.

height - Page height.

fd - File descriptor of image resource.

Returns:

Return the inserted image page.

insertPageWithImage

public CPDFPage insertPageWithImage(int pageIndex,
                                    float width,
                                    float height,
                                    int fd,
                                    CPDFDocument.PDFDocumentImageMode imageMode)

Inserts a blank page with image at the specified index point.

Parameters:

pageIndex - Page.

width - Page width.

height - Page height.

fd - File description of image resource.

imageMode - Fill mode.

Returns:

Returns the inserted image page.

insertPageWithImagePath

public CPDFPage insertPageWithImagePath(int pageIndex,
                                        float width,
                                        float height,
                                        java.lang.String imagePath)

Inserts a blank page with image at the specified index point.

Parameters:

pageIndex - Page.

width - Page width.

height - Page height.

imagePath - File path of image resource.

Returns:

Returns the inserted image page.

insertPageWithImagePath

public CPDFPage insertPageWithImagePath(int pageIndex,
                                        float width,
                                        float height,
                                        java.lang.String imagePath,
                                        CPDFDocument.PDFDocumentImageMode imageMode)

Inserts a blank page with image at the specified index point.

Parameters:

pageIndex - Page.

width - Page width.

height - Page height.

imagePath - File path of image resource.

imageMode - Fill mode.

Returns:

Returns the inserted image page.

importPages

public boolean importPages(CPDFDocument otherDocument,
                           int start,
                           int end,
                           int insertPosition)

Import page(s) from another document at the specified index point and insert to insertPosition.

Parameters:

otherDocument - Other document.

start - Start page index.

end - End page index.

insertPosition - Insert position.

Returns:

Returns whether to successfully import page(s).

importPages

public boolean importPages(CPDFDocument otherDocument,
                           int[] pages,
                           int insertPosition)

Import page(s) from another document at the specified index point and insert to insertPosition.

Parameters:

otherDocument - Other document.

pages - Page index array.

insertPosition - Insert position.

Returns:

Returns whether to successfully import page(s).

movePage

public boolean movePage(int fromIndex,
                        int toIndex)

Moves page.

Parameters:

fromIndex - Source page index.

toIndex - Destination page index.

Returns:

Returns whether to successfully move page.

exchangePage

public boolean exchangePage(int firstIndex,
                            int secondIndex)

Exchanges one page with another.

Parameters:

firstIndex - The first page index.

secondIndex - The second page index.

Returns:

Returns whether to successfully exchange page.

renderPageAtIndex

public boolean renderPageAtIndex(android.graphics.Bitmap bitmap,
                                 int pageIndex,
                                 int width,
                                 int height,
                                 int patchX,
                                 int patchY,
                                 int patchW,
                                 int patchH,
                                 int bgColor,
                                 int alpha,
                                 int rotate,
                                 boolean isDrawAnnot,
                                 boolean isDrawForm)

Render contents of a page to a device independent bitmap.

Parameters:

bitmap - Handle to the device independent bitmap (as the output buffer).

pageIndex - Page index.

width - Page width.

height - Page height.

patchX - Left pixel position of the display area in bitmap coordinates.

patchY - Top pixel position of the display area in bitmap coordinates.

patchW - Horizontal size (in pixels) for displaying the page.

patchH - Vertical size (in pixels) for displaying the page.

bgColor - Background color of image.

alpha - Background opacity of image.

rotate - Rotation angle.

isDrawAnnot - Whether to draw annotation.

isDrawForm - Whether to draw form.

Returns:

Returns whether to successfully render content in pageIndex page.

renderPageScreenShotAtIndex

public boolean renderPageScreenShotAtIndex(android.graphics.Bitmap bitmap,
                                           int pageIndex,
                                           int width,
                                           int height,
                                           int patchX,
                                           int patchY,
                                           int patchW,
                                           int patchH,
                                           int bgColor,
                                           int alpha,
                                           int rotate,
                                           boolean isDrawAnnot,
                                           boolean isDrawForm)

importAnnotations

public boolean importAnnotations(java.lang.String importFilePath,
                                 java.lang.String tmpCachePath)

Import annotations from XFDF document.

Parameters:

importFilePath - Path of XFDF.

tmpCachePath - Cache path.

Returns:

Returns whether to successfully import annotations from XFDF document.

exportAnnotations

public boolean exportAnnotations(java.lang.String exportFilePath,
                                 java.lang.String tmpCachePath)

Exports annotations to XFDF document.

Parameters:

exportFilePath - XFDF path.

tmpCachePath - Cache path.

Returns:

Returns whether to successfully export annotations to XFDF document.

setUserPassword

public boolean setUserPassword(java.lang.String password)

Sets user password.

Parameters:

password - Password string.

Returns:

Returns whether to successfully set user password.

setOwnerPassword

public boolean setOwnerPassword(java.lang.String password)

Not in use currently

checkOwnerPassword

public boolean checkOwnerPassword(java.lang.String password)

Whether the owner password is correct.

Parameters:

password - Owner password.

Returns:

Whether the owner password is correct.

setEncryptAlgorithm

public boolean setEncryptAlgorithm(CPDFDocument.PDFDocumentEncryptAlgo type)

getEncryptAlgorithm

public CPDFDocument.PDFDocumentEncryptAlgo getEncryptAlgorithm()

canSaveIncrementally

public boolean canSaveIncrementally()

Whether document can be saved incrementally.

Returns:

Returns whether document can be saved incrementally.

hasRepaired

public boolean hasRepaired()

Whether document is repaired.

Returns:

Returns whether document is repaired.

getWatermarkCount

public int getWatermarkCount()

Gets the count of watermark in the document.

Returns:

Returns the count of watermark in the document.

getWatermark

public CPDFWatermark getWatermark(int index)

Gets CPDFWatermark according to index, more:CPDFWatermark.

Parameters:

index - Watermark index.

Returns:

Returns watermark object, more: CPDFWatermark.

See Also:

CPDFTextWatermark, CPDFImageWatermark

createWatermark

public CPDFWatermark createWatermark(CPDFWatermark.Type type)

Creates watermark, more: CPDFWatermark.

Parameters:

type - Watermark type, more: CPDFWatermark.Type

Returns:

Returns watermark type object, more:CPDFWatermark

See Also:

CPDFTextWatermark, CPDFImageWatermark

getHeaderFooter

public CPDFHeaderFooter getHeaderFooter()

Gets the header & footer of the document.

Returns:

Returns header & footer type object, more:CPDFHeaderFooter

getBackground

public CPDFBackground getBackground()

Gets the background of the document.

Returns:

Returns background type object, more:CPDFBackground

getBates

public CPDFBates getBates()

Gets the bates numbers of the document.

Returns:

Returns bates type object, more:CPDFBates

flattenAllPages

public boolean flattenAllPages(CPDFPage.PDFFlattenOption flattenOption)

Flatten all pages.

Parameters:

flattenOption - flatten type, more: CPDFPage.PDFFlattenOption

Returns:

Returns whether to successfully flatten all pages.

applyRedactions

public boolean applyRedactions()

Applies redaction annotations in current documentation.

Returns:

Returns whether to successfully apply redaction in current documentation.

removeAllAnnotations

public boolean removeAllAnnotations()

Removes all annotations.

Returns:

Returns whether to successfully remove all annotations.

removeAllFormAnnotations

public boolean removeAllFormAnnotations()

Removes all form widgets.

Returns:

Returns whether to successfully remove all form widgets.

removeAllSignStamps

public boolean removeAllSignStamps()

Removes all signature

Returns:

Whether to remove all forged signature successfully

resetAllForm

public boolean resetAllForm()

Resets all forms.

Returns:

Returns whether to successfully reset all forms.

getSignatureCount

public int getSignatureCount()

Gets the count of signature form in the document

Returns:

Returns the count of signature form

hasChanges

public boolean hasChanges()

Whether document is modified.

Returns:

Returns whether document is modified.

close

public void close()

When the object is no longer in use, call this method to release resources.

releaseAllOutlines

public void releaseAllOutlines()

When TPDFOutline is no longer in use, release all resource of TPDFOutline.

releaseTextEdit

public void releaseTextEdit()

When CPDFPages is no longer in use, release all resource of CPDFPages.

releaseAllWatermarks

public void releaseAllWatermarks()

When CPDFWatermark is no longer in use, release all resource of CPDFWatermark.

releaseAllBookmarks

public void releaseAllBookmarks()

When TPDFBookmark is no longer in use, release all resource of TPDFBookmark.

releaseAllPages

public void releaseAllPages()

When CPDFPage is no longer in use, release all resource of CPDFPage.

isValid

public boolean isValid()

Whether CPDFDocument object is valid, false means CPDFDocument object is released.

Returns:

Returns whether CPDFDocument object is valid.

shouleReloadDocument

public boolean shouleReloadDocument()

Whether to reload document, true means it needs to call reload(String) or reload() to reload document.

Returns:

Returns whether to reload document.

getType

public CPDFDocument.PDFDocumentType getType()

Gets PDF/A conformance levels.

Returns:

Returns PDF/A conformance levels.

convertType

public boolean convertType(CPDFDocument.PDFDocumentType documentType)

Converts existing PDF files to PDF/A compliant documents, including PDF/A-1a and PDF/A-1b only. The conversion option analyzes the content of existing PDF files and performs a sequence of modifications in order to produce a PDF/A compliant document. Features that are not suitable for long-term archiving (such as encryption, obsolete compression schemes, missing fonts, or device-dependent color) are replaced with their PDF/A compliant equivalents. Because the conversion process applies only necessary changes to the source file, the information loss is minimal. When the document is encrypted, it should be decrypted through saveAs(String, boolean) before conversion. Otherwise the conversion fails.

Parameters:

documentType - PDF/A conformance levels.

Returns:

Returns whether to convert successfully.

getPdfSignature

public CPDFSignature getPdfSignature(int index)

Get the signature at index.

Parameters:

index - signature index.

Returns:

Returns SPDFSignature object.

removeSignature

public boolean removeSignature(CPDFSignature signature,
                               boolean isRemoveAP,
                               CPDFDocument.SignatureRemoveListener listener)

Remove signature.

Parameters:

signature - Signature to remove.

isRemoveAP - Whether removing ap.

listener - The callback after removing the signature.

Returns:

Returns true:succeed, false:fail

getPdfSignature

public CPDFSignature getPdfSignature(CPDFSignatureWidget signatureWidget)

Get the signature of a signature widget.

Parameters:

signatureWidget - Signauture widget.

Returns:

Returns CPDFSignature.

writeSignature

public boolean writeSignature(CPDFSignatureWidget signatureWidget,
                              java.lang.String savePath,
                              java.lang.String pkcs12certPath,
                              java.lang.String password,
                              java.lang.String location,
                              java.lang.String reason,
                              CPDFDocument.PDFDocMdpP type)

Add a signature to document.

Parameters:

signatureWidget - Signature widget.

savePath - Save path for the signature file.

pkcs12certPath - Pkcs12 certificate file path.

password - Pkcs12 certificate file password

location - The CPU host name or physical location of the signing.

reason - Signature reason.

type - Modify permission type. more:CPDFDocument.PDFDocMdpP

Returns:

Returns true:write signature succeed, false:fail.

extractImage

public boolean extractImage(java.lang.String filePath,
                            int[] pageArr,
                            CPDFDocument.ExtractImageListener listener)

Extract images at the specified page index array.

Parameters:

filePath - Extract directory.

pageArr - Page index array.

listener - Extract listener.

Returns:

Returns Whether extracting images succeed.

extractImage

public boolean extractImage(java.lang.String filePath,
                            CPDFDocument.ExtractImageListener listener)

Extract all images of the document.

Parameters:

filePath - Extract directory.

listener - Extract listener.

Returns:

Returns Whether extracting images succeed.