Foxit PDF SDK
com.foxit.sdk.pdf.CombineDocumentInfo Class Reference
Inheritance diagram for com.foxit.sdk.pdf.CombineDocumentInfo:
com.foxit.sdk.common.Base

Public Member Functions

 CombineDocumentInfo (String file_path, String password)
 Constructor, with parameters. More...
 
 CombineDocumentInfo (PDFDoc doc)
 Constructor, with parameters. More...
 
 CombineDocumentInfo (CombineDocumentInfo other)
 Constructor, with another information object. More...
 
synchronized void delete ()
 Clean up related resources immediately. More...
 
boolean isEmpty ()
 Check whether current object is empty or not. More...
 
void setBookmarkTitle (String bookmark_title)
 Set the title of a new parent bookmark for the root bookmark of related source PDF document in combined result file. More...
 
void setPDFFileName (String pdf_file_name)
 Set the name of the PDF file, which will be combined with other PDF files. More...
 
- Public Member Functions inherited from com.foxit.sdk.common.Base
synchronized void delete ()
 Clean up related resources immediately. More...
 

Detailed Description

This class represents information of source PDF file which is to be combined with other PDF files.

Constructor & Destructor Documentation

◆ CombineDocumentInfo() [1/3]

com.foxit.sdk.pdf.CombineDocumentInfo.CombineDocumentInfo ( String  file_path,
String  password 
)

Constructor, with parameters.

This constructor does not check the validity of input PDF file and the check will be done in function Combination.startCombineDocuments .

Parameters
[in]file_pathFile path of a PDF file, which is to be combined with other PDF files.
[in]passwordOwner password of PDF file which is specified by parameter file_path.

◆ CombineDocumentInfo() [2/3]

com.foxit.sdk.pdf.CombineDocumentInfo.CombineDocumentInfo ( PDFDoc  doc)

Constructor, with parameters.

This constructor does not check the validity of input PDF file and the check will be done in function Combination.startCombineDocuments .

Parameters
[in]docA valid PDF document object which represents a PDF file to be combined with other PDF files. Please ensure input PDF document object have been loaded; otherwise unknown error may occur later when current information object is used.

◆ CombineDocumentInfo() [3/3]

com.foxit.sdk.pdf.CombineDocumentInfo.CombineDocumentInfo ( CombineDocumentInfo  other)

Constructor, with another information object.

Parameters
[in]otherAnother information object.

Member Function Documentation

◆ delete()

synchronized void com.foxit.sdk.pdf.CombineDocumentInfo.delete ( )

Clean up related resources immediately.

Returns
None.
Note
Once this function is called, current object cannot be used anymore.

◆ isEmpty()

boolean com.foxit.sdk.pdf.CombineDocumentInfo.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.

◆ setBookmarkTitle()

void com.foxit.sdk.pdf.CombineDocumentInfo.setBookmarkTitle ( String  bookmark_title)

Set the title of a new parent bookmark for the root bookmark of related source PDF document in combined result file.

This function is to set the bookmark title for a new bookmark in combined result file, if option value com.foxit.sdk.pdf.Combination.e_CombineDocsOptionBookmark is used for combination and related source PDF file has any bookmark. The new bookmark will be used as a parent bookmark and root bookmark of related source PDF doucment will be inserted to be the child node of the new parent bookmark in combined result PDF file.
If no bookmark title is set or an empty title is set, GSDK will generate a bookmark title automatically during combination process which is started by function Combination.startCombineDocuments .

Parameters
[in]bookmark_titleTitle of a new parent bookmark which is used in combined result PDF file.
Returns
None.

◆ setPDFFileName()

void com.foxit.sdk.pdf.CombineDocumentInfo.setPDFFileName ( String  pdf_file_name)

Set the name of the PDF file, which will be combined with other PDF files.

This function is invalid if the constructor CombineDocumentInfo.CombineDocumentInfo with a file path parameter is called. If option value com.foxit.sdk.pdf.Combination.e_CombineDocsOptionOCProperties is used for combination and the PDF file to be combined has multiple layers, then the PDF file name to be set will be shown on the root node of the combined PDF file's layers.

Parameters
[in]pdf_file_nameThe name of the PDF file, which will be combined with other PDF files.
Returns
None.