Public Member Functions | |
FileSpec (PDFDoc document) throws com.foxit.sdk.PDFException | |
Constructor. More... | |
FileSpec (PDFDoc document, PDFObject pdf_object) throws com.foxit.sdk.PDFException | |
Constructor, from an existing file specification PDF object in a PDF document. More... | |
FileSpec (FileSpec other) | |
Constructor, with another FileSpec object. More... | |
boolean | embed (String file_path) throws com.foxit.sdk.PDFException |
Embed the whole content of a file which is specified by file path. More... | |
boolean | embed (PDFObject pdf_object) throws com.foxit.sdk.PDFException |
(Only support in PDF 2.0) Embed the whole content of a PDF stream object or a PDF reference object which refers to a PDF stream object, when current file specification object is used as an associated file. More... | |
boolean | exportToFile (String path) throws com.foxit.sdk.PDFException |
Export the file data that represented in current file specification directly into a file. More... | |
int | getAssociteFileRelationship () throws com.foxit.sdk.PDFException |
(Only supported in PDF 2.0) Get the associated file relationship when current file specification is used as an associated file. More... | |
byte [] | getChecksum () throws com.foxit.sdk.PDFException |
Get the checksum for embedded file. More... | |
DateTime | getCreationDateTime () throws com.foxit.sdk.PDFException |
Get creation date and time about when the embedded file was created. More... | |
String | getDescription () throws com.foxit.sdk.PDFException |
Get the descriptive text associated with current file specification. More... | |
PDFDictionary | getDict () throws com.foxit.sdk.PDFException |
Get the PDF dictionary of current file specification. More... | |
FileReaderCallback | getFileData () throws com.foxit.sdk.PDFException |
Get the file data of embedded file. More... | |
String | getFileName () throws com.foxit.sdk.PDFException |
Get the file name. More... | |
int | getFileSize () throws com.foxit.sdk.PDFException |
Get the size of embedded file. More... | |
DateTime | getModifiedDateTime () throws com.foxit.sdk.PDFException |
Get modified date and time about when the embedded file was last modified. More... | |
String | getSubtype () throws com.foxit.sdk.PDFException |
(Only support in PDF 2.0) Get the MIME type value for "Subtype" key for embedded file when current file specification is used as an associated file. More... | |
boolean | isEmbedded () throws com.foxit.sdk.PDFException |
Check whether current file specification object represents an embedded file or not. More... | |
boolean | isEmpty () |
Check whether current object is empty or not. More... | |
void | setAssociteFileRelationship (int associfile_relationship) throws com.foxit.sdk.PDFException |
(Only supported in PDF 2.0) Set the associated file relationship when current file specification is used as an associated file. More... | |
void | setChecksum (byte[] checksum) throws com.foxit.sdk.PDFException |
Set the checksum for embedded file. (Not affect local file) More... | |
void | setCreationDateTime (DateTime date_time) throws com.foxit.sdk.PDFException |
Set the creation date and time for the embedded file. (Not affect local file) More... | |
void | setDescription (String description) throws com.foxit.sdk.PDFException |
Set the descriptive text associated with current file specification. More... | |
void | setFileName (String file_name) throws com.foxit.sdk.PDFException |
Set the file name. More... | |
void | setModifiedDateTime (DateTime date_time) throws com.foxit.sdk.PDFException |
Set last modified date and time for the embedded file. (Not affect local file) More... | |
A PDF file can refer to the contents of another file by using a file specification. File specification can simply represents the file path of another file, or represents the whole content of another file, which is embedded to current PDF file.
com.foxit.sdk.pdf.FileSpec.FileSpec | ( | PDFDoc | document | ) | throws com.foxit.sdk.PDFException |
com.foxit.sdk.pdf.FileSpec.FileSpec | ( | PDFDoc | document, |
PDFObject | pdf_object | ||
) | throws com.foxit.sdk.PDFException |
Constructor, from an existing file specification PDF object in a PDF document.
document | A valid PDF document object, to which the file specification PDF object belongs. |
pdf_object | A valid PDF object which represents an existing FileSpec object in the PDF document. It should be either a dictionary object or a PDF reference object: If it is a PDF dictionary object, it should be a file specification dictionary. If it is a PDF reference object, it should refer to a file specification dictionary. This PDF object can be retrieved from PDFNameTree in type objects::e_EmbeddedFiles. |
com.foxit.sdk.pdf.FileSpec.FileSpec | ( | FileSpec | other | ) |
boolean com.foxit.sdk.pdf.FileSpec.embed | ( | String | file_path | ) | throws com.foxit.sdk.PDFException |
Embed the whole content of a file which is specified by file path.
When this function succeeds, the whole content of specified file will be embedded to the PDF document that current file specification belongs to.
file_path | A full path of an existing local file. |
boolean com.foxit.sdk.pdf.FileSpec.embed | ( | PDFObject | pdf_object | ) | throws com.foxit.sdk.PDFException |
(Only support in PDF 2.0) Embed the whole content of a PDF stream object or a PDF reference object which refers to a PDF stream object, when current file specification object is used as an associated file.
When this function succeeds, the whole content of specified PDF stream object will be embedded to the PDF document that current file specification belongs to.
pdf_object | A valid PDF object. It should be either a PDF stream object or a PDF reference object which refers to a PDF stream object. |
boolean com.foxit.sdk.pdf.FileSpec.exportToFile | ( | String | path | ) | throws com.foxit.sdk.PDFException |
Export the file data that represented in current file specification directly into a file.
path | A full path of a file to which the data will be saved. |
int com.foxit.sdk.pdf.FileSpec.getAssociteFileRelationship | ( | ) | throws com.foxit.sdk.PDFException |
(Only supported in PDF 2.0) Get the associated file relationship when current file specification is used as an associated file.
byte[] com.foxit.sdk.pdf.FileSpec.getChecksum | ( | ) | throws com.foxit.sdk.PDFException |
Get the checksum for embedded file.
This function is only useful when current file specification object represents an embedded file. A 16-byte string that is the checksum of the bytes of the uncompressed embedded file. The checksum is calculated by applying the standard MD5 message-digest algorithm to the bytes of the embedded file stream.
If current file specification object does not represent an embedded file, this function will return an empty string.
DateTime com.foxit.sdk.pdf.FileSpec.getCreationDateTime | ( | ) | throws com.foxit.sdk.PDFException |
Get creation date and time about when the embedded file was created.
This function is only useful when current file specification object represents an embedded file. If current file specification object does not represent an embedded file, this function will return a DateTime object will all value 0.
String com.foxit.sdk.pdf.FileSpec.getDescription | ( | ) | throws com.foxit.sdk.PDFException |
Get the descriptive text associated with current file specification.
PDFDictionary com.foxit.sdk.pdf.FileSpec.getDict | ( | ) | throws com.foxit.sdk.PDFException |
Get the PDF dictionary of current file specification.
FileReaderCallback com.foxit.sdk.pdf.FileSpec.getFileData | ( | ) | throws com.foxit.sdk.PDFException |
Get the file data of embedded file.
String com.foxit.sdk.pdf.FileSpec.getFileName | ( | ) | throws com.foxit.sdk.PDFException |
Get the file name.
int com.foxit.sdk.pdf.FileSpec.getFileSize | ( | ) | throws com.foxit.sdk.PDFException |
Get the size of embedded file.
This function is only useful when current file specification object represents an embedded file. If current file specification object does not represent an embedded file, this function will return 0 directly.
DateTime com.foxit.sdk.pdf.FileSpec.getModifiedDateTime | ( | ) | throws com.foxit.sdk.PDFException |
Get modified date and time about when the embedded file was last modified.
This function is only useful when current file specification object represents an embedded file. If current file specification object does not represent an embedded file, this function will return a DateTime object will all value 0.
String com.foxit.sdk.pdf.FileSpec.getSubtype | ( | ) | throws com.foxit.sdk.PDFException |
(Only support in PDF 2.0) Get the MIME type value for "Subtype" key for embedded file when current file specification is used as an associated file.
This function is only useful when current file specification object represents an embedded file and used as associated file.
boolean com.foxit.sdk.pdf.FileSpec.isEmbedded | ( | ) | throws com.foxit.sdk.PDFException |
Check whether current file specification object represents an embedded file or not.
boolean com.foxit.sdk.pdf.FileSpec.isEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
void com.foxit.sdk.pdf.FileSpec.setAssociteFileRelationship | ( | int | associfile_relationship | ) | throws com.foxit.sdk.PDFException |
(Only supported in PDF 2.0) Set the associated file relationship when current file specification is used as an associated file.
This function is required for a newly created associated file specification object.
associfile_relationship | The associated file relationship to be set. Please refer to values starting from e_RelationshipSource and this would be one of these values. |
void com.foxit.sdk.pdf.FileSpec.setChecksum | ( | byte [] | checksum | ) | throws com.foxit.sdk.PDFException |
Set the checksum for embedded file. (Not affect local file)
This function is only useful if current file specification object represents an embedded file.
A 16-byte string that is the checksum of the bytes of the uncompressed embedded file. The checksum is calculated by applying the standard MD5 message-digest algorithm to the bytes of the embedded file stream.
checksum | A checksum to be set. |
void com.foxit.sdk.pdf.FileSpec.setCreationDateTime | ( | DateTime | date_time | ) | throws com.foxit.sdk.PDFException |
Set the creation date and time for the embedded file. (Not affect local file)
This function is only useful when current file specification object represents an embedded file.
date_time | The creation date and time to be set. |
void com.foxit.sdk.pdf.FileSpec.setDescription | ( | String | description | ) | throws com.foxit.sdk.PDFException |
Set the descriptive text associated with current file specification.
description | A descriptive text to be set. It should not be an empty string. |
void com.foxit.sdk.pdf.FileSpec.setFileName | ( | String | file_name | ) | throws com.foxit.sdk.PDFException |
Set the file name.
This function is required for a new FileSpec object (not constructed from an existing file specification PDF object).
file_name | The file name to be set. It should not be an empty string. |
void com.foxit.sdk.pdf.FileSpec.setModifiedDateTime | ( | DateTime | date_time | ) | throws com.foxit.sdk.PDFException |
Set last modified date and time for the embedded file. (Not affect local file)
This function is only useful when current file specification object represents an embedded file.
date_time | The last modified date and time to be set. |