Foxit PDF SDK
com.foxit.sdk.addon.comparison.Comparison Class Reference
Inheritance diagram for com.foxit.sdk.addon.comparison.Comparison:
com.foxit.sdk.common.Base

Public Member Functions

 Comparison (PDFDoc base_doc, PDFDoc compared_doc) throws com.foxit.sdk.PDFException
 Constructor, from PDF document object.
More...
 
 Comparison (Comparison other)
 Constructor, with another comparison object.
More...
 
CompareResults doCompare (int base_page_index, int compared_page_index, int compare_flags)
 Compare a PDF page of base document with a PDF page in compared document. "base document" and "compared document" means the PDF documents objects that aredused to construct current object.
More...
 
PDFDoc generateComparedDoc (int compare_flags)
 Compare the base document with compared document (which are used to construct current object) and then generate a PDF document as comparison result.
More...
 
boolean isEmpty ()
 Check whether current object is empty or not.
More...
 

Static Public Attributes

static final int e_CompareTypeAll = 0x00000000
 Compare all content. This value should be used alone.

 
static final int e_CompareTypeText = 0x00000001
 Compare text only.

 

Detailed Description

This class can be used to compare one PDF file (as "base document") with another PDF file (as "compared document") page by page.

Constructor & Destructor Documentation

◆ Comparison() [1/2]

com.foxit.sdk.addon.comparison.Comparison.Comparison ( PDFDoc  base_doc,
PDFDoc  compared_doc 
) throws com.foxit.sdk.PDFException

Constructor, from PDF document object.

Parameters
[in]base_docA valid PDF document object as base document.
[in]compared_docA valid PDF document object as compared document.
Note
If module "Comparison" is not defined in the license information which is used in function common.Library.initialize , that means user has no right in using compare related functions and this constructor will throw exception com.foxit.sdk.common.Constants.e_ErrInvalidLicense .

◆ Comparison() [2/2]

com.foxit.sdk.addon.comparison.Comparison.Comparison ( Comparison  other)

Constructor, with another comparison object.

Parameters
[in]otherAnother comparison object.

Member Function Documentation

◆ doCompare()

CompareResults com.foxit.sdk.addon.comparison.Comparison.doCompare ( int  base_page_index,
int  compared_page_index,
int  compare_flags 
)

Compare a PDF page of base document with a PDF page in compared document. "base document" and "compared document" means the PDF documents objects that aredused to construct current object.

Parameters
[in]base_page_indexPage index in base document. Valid range: from 0 to (base_page_count-1). base_page_count is returned by function pdf.PDFDoc.getPageCount for base document.
[in]compared_page_indexPage index in compared document. Valid range: from 0 to (compared_page_count-1). compared_page_count is returned by function pdf.PDFDoc.getPageCount for compared document.
[in]compare_flagsCompare type which specifies what to be compared in PDF pages. Please refer to values starting from com.foxit.sdk.addon.comparison.Comparison.e_CompareTypeAll and this can be one or combination of some of these values.
Returns
A com.foxit.sdk.addon.comparison.CompareResults object.

◆ generateComparedDoc()

PDFDoc com.foxit.sdk.addon.comparison.Comparison.generateComparedDoc ( int  compare_flags)

Compare the base document with compared document (which are used to construct current object) and then generate a PDF document as comparison result.

It may take a long time to compare content of two PDF documents and generate the new PDF document.

Parameters
[in]compare_flagsCompare type which specifies what to be compared in PDF pages. Please refer to values starting from com.foxit.sdk.addon.comparison.Comparison.e_CompareTypeAll and this can be one or combination of some of these values.
Returns
A com.foxit.sdk.pdf.PDFDoc object which represents the PDF document as comparison result.

◆ isEmpty()

boolean com.foxit.sdk.addon.comparison.Comparison.isEmpty ( )

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
true means current object is empty, while false means not.