Foxit PDF SDK
|
Public Member Functions | |
FDFDoc (byte[] buffer) throws com.foxit.sdk.PDFException | |
Constructor, from a memory buffer. More... | |
FDFDoc (FDFDoc other) | |
Constructor, with another FDF document object. More... | |
FDFDoc (FileReaderCallback file_read) throws com.foxit.sdk.PDFException | |
Constructor, with a file read callback object. More... | |
FDFDoc (int type) throws com.foxit.sdk.PDFException | |
Constructor. More... | |
FDFDoc (String path) throws com.foxit.sdk.PDFException | |
Constructor, from an existing FDF or XFDF file path. More... | |
synchronized void | delete () |
Clean up related resources immediately. More... | |
PDFDictionary | getCatalog () throws com.foxit.sdk.PDFException |
Get the catalog dictionary. More... | |
PDFDictionary | getFDFDict () throws com.foxit.sdk.PDFException |
Get the dictionary of "FDF" entry from catalog dictionary. More... | |
String | getPDFPath () throws com.foxit.sdk.PDFException |
Get the path of related PDF document. More... | |
int | getType () throws com.foxit.sdk.PDFException |
Get the type of current document object. More... | |
boolean | isEmpty () |
Check whether current object is empty or not. More... | |
boolean | saveAs (FileWriterCallback file) throws com.foxit.sdk.PDFException |
Save current document as another FDF or XFDF file. More... | |
boolean | saveAs (String file_path) throws com.foxit.sdk.PDFException |
Save current document as another FDF or XFDF file. More... | |
boolean | setPDFPath (String pdf_path) throws com.foxit.sdk.PDFException |
Set the path of related PDF document. More... | |
Static Public Attributes | |
static final int | e_FDF = 0 |
FDF document type: FDF. | |
static final int | e_XFDF = 1 |
FDF document type: XFDF. | |
FDF (Forms Data Format) is a kind of file format, used for interactive form data. FDF can be used when submitting form data to a server, receiving the response, and incorporating it into the interactive form. It can also be used to export form data to stand-alone files that can be stored, transmitted electronically, and imported back into the corresponding PDF interactive form. Besides these, FDF can be used to define a container for annotations that are separated from the PDF document to which they apply.
XFDF(XML Forms Data Format) is a version of FDF based on XML. It has similar features with FDF.
In a word, FDF and XFDF contain the subset of a PDF document to describe interactive forms and annotations.
Class FDFDoc can be used to represent either FDF or XFDF. A FDF document object can be constructed with an existing file from file path, memory buffer, a custom implemented com.foxit.sdk.common.fxcrt.FileReaderCallback object and an input file stream. A FDF document object can also be constructed as a new FDF or XFDF document. This class also offers functions to get or set some information from FDF or XFDF file, and save current FDF/XFDF as another file.
To import or export form fields or annotations, please refer to functions pdf.PDFDoc.importFromFDF , pdf.PDFDoc.exportToFDF and pdf.PDFDoc.exportAnnotToFDF .
com.foxit.sdk.fdf.FDFDoc.FDFDoc | ( | FileReaderCallback | file_read | ) | throws com.foxit.sdk.PDFException |
Constructor, with a file read callback object.
[in] | file_read | Pointer to a com.foxit.sdk.common.fxcrt.FileReaderCallback object which is implemented by user to load a FDF or XFDF document. It should not be null. |
com.foxit.sdk.fdf.FDFDoc.FDFDoc | ( | int | type | ) | throws com.foxit.sdk.PDFException |
Constructor.
This constructor is to construct a new FDF document object (without any data).
[in] | type | FDF document type. It should be one of following values: com.foxit.sdk.fdf.FDFDoc.e_FDF , com.foxit.sdk.fdf.FDFDoc.e_XFDF |
com.foxit.sdk.fdf.FDFDoc.FDFDoc | ( | String | path | ) | throws com.foxit.sdk.PDFException |
Constructor, from an existing FDF or XFDF file path.
[in] | path | A full path of an existing FDF/XFDF file. It should not be an empty string. |
com.foxit.sdk.fdf.FDFDoc.FDFDoc | ( | byte[] | buffer | ) | throws com.foxit.sdk.PDFException |
Constructor, from a memory buffer.
[in] | buffer | A memory buffer. The FDF or XFDF file data should be fully loaded in this memory buffer. It should not be null. |
com.foxit.sdk.fdf.FDFDoc.FDFDoc | ( | FDFDoc | other | ) |
Constructor, with another FDF document object.
[in] | other | Another FDF document object. |
synchronized void com.foxit.sdk.fdf.FDFDoc.delete | ( | ) |
Clean up related resources immediately.
Reimplemented from com.foxit.sdk.common.Base.
PDFDictionary com.foxit.sdk.fdf.FDFDoc.getCatalog | ( | ) | throws com.foxit.sdk.PDFException |
Get the catalog dictionary.
PDFDictionary com.foxit.sdk.fdf.FDFDoc.getFDFDict | ( | ) | throws com.foxit.sdk.PDFException |
Get the dictionary of "FDF" entry from catalog dictionary.
String com.foxit.sdk.fdf.FDFDoc.getPDFPath | ( | ) | throws com.foxit.sdk.PDFException |
Get the path of related PDF document.
The path can be either an absolute one, or a relative one.
int com.foxit.sdk.fdf.FDFDoc.getType | ( | ) | throws com.foxit.sdk.PDFException |
Get the type of current document object.
boolean com.foxit.sdk.fdf.FDFDoc.isEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
boolean com.foxit.sdk.fdf.FDFDoc.saveAs | ( | FileWriterCallback | file | ) | throws com.foxit.sdk.PDFException |
Save current document as another FDF or XFDF file.
[in] | file | A com.foxit.sdk.common.fxcrt.FileWriterCallback object which is implemented by user to save FDF or XFDF file. |
boolean com.foxit.sdk.fdf.FDFDoc.saveAs | ( | String | file_path | ) | throws com.foxit.sdk.PDFException |
Save current document as another FDF or XFDF file.
[in] | file_path | A full path of the new saved FDF or XFDF file. It should not be an empty string. |
boolean com.foxit.sdk.fdf.FDFDoc.setPDFPath | ( | String | pdf_path | ) | throws com.foxit.sdk.PDFException |
Set the path of related PDF document.
[in] | pdf_path | The path of related PDF document. It can be either an absolute path or a relative path. It should not be an empty string. |