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 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
static class	CPDFDocument.PDFDocumentSaveType Document save type.

Constructor Summary

Constructors

Constructor and Description
CPDFDocument() Creates PDF document

Method Summary

Modifier and Type	Method and Description
boolean	addPage(CPDFPage page, int pageNum) Add page to document
boolean	canSaveIncrementally() Whether document can be saved incrementally.
boolean	checkOwnerPassword(java.lang.String password)
void	close() When the object is no longer in use, call this method to release resources.
CPDFPage	copyPage(int pageNum) Copy the page at page index
CPDFCompare	createCompare(CPDFDocument compDoc)
CPDFCompare	createCompare(CPDFDocument baseDoc, CPDFDocument compDoc)
CPDFCompareDrawings	createCompareDrawings(CPDFDocument compDoc)
static CPDFDocument	createDocument() Creates a CPDFDocument object with new PDF.
CPDFWatermark	createWatermark(CPDFWatermark.Type type) createWatermark
boolean	exchangePage(int firstIndex, int secondIndex) Exchanges one page with another.
boolean	exportAnnotations(java.lang.String exportXPDFPath, java.lang.String tmpCacheDirPath) Exports annotations to XFDF document.
boolean	flattenAllPages(CPDFPage.PDFFlattenOption flattenOption) Flatten all pages.
java.lang.String	getBuildTag() Gets build tag string of document.
long	getDocPtr()
java.lang.String	getFilePath() document absolute path
CPDFInfo	getInfo() Gets document information, more:CPDFInfo
int	getMajorVersion() Gets major version string of document.
int	getMinorVersion() Gets minor version string of document.
int	getPageCount() Gets total count of document pages.
java.lang.String	getPageLabel(int pageNum) Gets the page label at the specified index.
RectF	getPageSize(int pageNum) Gets page size at the specified index.
java.lang.String	getPassword() Gets document password.
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.
CPDFWatermark	getWatermark(int index) getWatermark
int	getWatermarkCount()
boolean	hasChanges() Whether document is modified.
boolean	hasRepaired() Whether document is repaired.
boolean	importAnnotations(java.lang.String importXPDFPath) Import annotations from XFDF document.
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	insertPageWithImagePath(int pageNum, float width, float height, java.lang.String imagePath, CPDFDocument.PDFDocumentImageMode imageMode) Inserts a blank page with image at the specified index point.
boolean	isEncrypted() Whether document is encrypted.
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.
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.
CPDFPage	pageAtIndex(int pageNum) Returns a pageNum object representing the page at index, more: CPDFPage.
void	releaseAllPages() When CPDFPage is no longer in use, release all resource of CPDFPage.
void	releaseAllWatermarks()
boolean	removePages(int[] pageNums) Remove page(s).
boolean	save(CPDFDocument.PDFDocumentSaveType saveType) The doucment has changes, sava file.
boolean	save(java.lang.String absolutePath, CPDFDocument.PDFDocumentSaveType saveType) The doucment has changes, sava file.
boolean	saveForceByNoincremental() Mandatory saving, the principle is to use non-incremental saving as a document to copy the current document
void	setDocPtr(long docPtr)
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 to reload document.

Methods inherited from class java.lang.Object

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

Constructor Detail

CPDFDocument

public CPDFDocument()

Creates PDF document

Method Detail

createDocument

public static CPDFDocument createDocument()

Creates a CPDFDocument object with new PDF.

Returns:

Document object.

setDocPtr

public void setDocPtr(long docPtr)

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 to reload document.

Returns:

Returns whether to reload document.

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.

getPassword

public java.lang.String getPassword()

Gets document password.

Returns:

Returns document password.

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.

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.

getPermissions

public CPDFDocument.PDFDocumentPermissions getPermissions()

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

Returns:

Returns permission status of document.

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.

getPageCount

public int getPageCount()

Gets total count of document pages.

Returns:

Returns total count of document pages.

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)

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.

importAnnotations

public boolean importAnnotations(java.lang.String importXPDFPath)

Import annotations from XFDF document.

Parameters:

importXPDFPath - Path of XFDF.

Returns:

Returns whether to successfully import annotations from XFDF document.

exportAnnotations

public boolean exportAnnotations(java.lang.String exportXPDFPath,
                                 java.lang.String tmpCacheDirPath)

Exports annotations to XFDF document.

Parameters:

exportXPDFPath - XFDF path.

tmpCacheDirPath - Cache dir path.

Returns:

Returns whether to successfully export annotations to XFDF document.

getPageSize

public RectF getPageSize(int pageNum)

Gets page size at the specified index.

Parameters:

pageNum - Page index.

Returns:

Returns page size at the specified index.

getPageLabel

public java.lang.String getPageLabel(int pageNum)

Gets the page label at the specified index.

Parameters:

pageNum - Page index.

Returns:

Returns the page label at the specified index.

pageAtIndex

public CPDFPage pageAtIndex(int pageNum)

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

Parameters:

pageNum - Page index.

Returns:

Returns a pageNum object representing the page at index.

copyPage

public CPDFPage copyPage(int pageNum)

Copy the page at page index

Parameters:

pageNum - Page Index

Returns:

Returns a page object at index

addPage

public boolean addPage(CPDFPage page,
                       int pageNum)

Add page to document

Parameters:

page - Page object to add to document.

pageNum - Position to add to.

Returns:

Returns whether add is suceess.

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.

insertPageWithImagePath

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

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

Parameters:

pageNum - 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).

removePages

public boolean removePages(int[] pageNums)

Remove page(s).

Parameters:

pageNums - Page index array.

Returns:

Returns whether to successfully remove 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.

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.

releaseAllPages

public void releaseAllPages()

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

releaseAllWatermarks

public void releaseAllWatermarks()

close

public void close()

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

hasChanges

public boolean hasChanges()

Whether document is modified.

Returns:

Returns whether document is modified.

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.

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.

saveForceByNoincremental

public boolean saveForceByNoincremental()

Mandatory saving, the principle is to use non-incremental saving as a document to copy the current document

save

public boolean save(java.lang.String absolutePath,
                    CPDFDocument.PDFDocumentSaveType saveType)

The doucment has changes, sava file.

getDocPtr

public long getDocPtr()

save

public boolean save(CPDFDocument.PDFDocumentSaveType saveType)

The doucment has changes, sava file.

getFilePath

public java.lang.String getFilePath()

document absolute path

getWatermarkCount

public int getWatermarkCount()

getWatermark

public CPDFWatermark getWatermark(int index)

getWatermark

Parameters:

index - index

Returns:

CPDFWatermark

createWatermark

public CPDFWatermark createWatermark(CPDFWatermark.Type type)

createWatermark

Parameters:

type - CPDFWatermark.Type

Returns:

CPDFWatermark

createCompare

public CPDFCompare createCompare(CPDFDocument baseDoc,
                                 CPDFDocument compDoc)

createCompare

public CPDFCompare createCompare(CPDFDocument compDoc)

createCompareDrawings

public CPDFCompareDrawings createCompareDrawings(CPDFDocument compDoc)