com.lowagie.text.pdf
public class PdfFileSpecification extends PdfDictionary
Field Summary | |
---|---|
protected PdfIndirectReference | ref |
protected PdfWriter | writer |
Constructor Summary | |
---|---|
PdfFileSpecification() Creates a new instance of PdfFileSpecification. |
Method Summary | |
---|---|
void | addCollectionItem(PdfCollectionItem ci)
Adds the Collection item dictionary. |
void | addDescription(String description, boolean unicode)
Adds a description for the file that is specified here. |
static PdfFileSpecification | fileEmbedded(PdfWriter writer, String filePath, String fileDisplay, byte[] fileStore)
Creates a file specification with the file embedded. |
static PdfFileSpecification | fileEmbedded(PdfWriter writer, String filePath, String fileDisplay, byte[] fileStore, int compressionLevel)
Creates a file specification with the file embedded. |
static PdfFileSpecification | fileEmbedded(PdfWriter writer, String filePath, String fileDisplay, byte[] fileStore, boolean compress)
Creates a file specification with the file embedded. |
static PdfFileSpecification | fileEmbedded(PdfWriter writer, String filePath, String fileDisplay, byte[] fileStore, boolean compress, String mimeType, PdfDictionary fileParameter)
Creates a file specification with the file embedded. |
static PdfFileSpecification | fileEmbedded(PdfWriter writer, String filePath, String fileDisplay, byte[] fileStore, String mimeType, PdfDictionary fileParameter, int compressionLevel)
Creates a file specification with the file embedded. |
static PdfFileSpecification | fileExtern(PdfWriter writer, String filePath)
Creates a file specification for an external file. |
PdfIndirectReference | getReference()
Gets the indirect reference to this file specification.
|
void | setMultiByteFileName(byte[] fileName)
Sets the file name (the key /F) string as an hex representation
to support multi byte file names. |
void | setUnicodeFileName(String filename, boolean unicode)
Adds the unicode file name (the key /UF). |
void | setVolatile(boolean volatile_file)
Sets a flag that indicates whether an external file referenced by the file
specification is volatile. |
static PdfFileSpecification | url(PdfWriter writer, String url)
Creates a file specification of type URL. |
Parameters: description some text unicode if true, the text is added as a unicode string
Parameters: writer the PdfWriter
filePath the file path fileDisplay the file information that is presented to the user fileStore the byte array with the file. If it is not null
it takes precedence over filePath
Returns: the file specification
Throws: IOException on error
Parameters: writer the PdfWriter
filePath the file path fileDisplay the file information that is presented to the user fileStore the byte array with the file. If it is not null
compressionLevel the compression level to be used for compressing the file
it takes precedence over filePath
Returns: the file specification
Throws: IOException on error
Since: 2.1.3
Parameters: writer the PdfWriter
filePath the file path fileDisplay the file information that is presented to the user fileStore the byte array with the file. If it is not null
it takes precedence over filePath
compress sets the compression on the data. Multimedia content will benefit little
from compression
Returns: the file specification
Throws: IOException on error
Parameters: writer the PdfWriter
filePath the file path fileDisplay the file information that is presented to the user fileStore the byte array with the file. If it is not null
it takes precedence over filePath
compress sets the compression on the data. Multimedia content will benefit little
from compression mimeType the optional mimeType fileParameter the optional extra file parameters such as the creation or modification date
Returns: the file specification
Throws: IOException on error
Parameters: writer the PdfWriter
filePath the file path fileDisplay the file information that is presented to the user fileStore the byte array with the file. If it is not null
it takes precedence over filePath
mimeType the optional mimeType fileParameter the optional extra file parameters such as the creation or modification date compressionLevel the level of compression
Returns: the file specification
Throws: IOException on error
Since: 2.1.3
Parameters: writer the PdfWriter
filePath the file path
Returns: the file specification
Returns: the indirect reference
Throws: IOException on error
Parameters: fileName the file name as a byte array
Parameters: filename the filename unicode if true, the filename is UTF-16BE encoded; otherwise PDFDocEncoding is used;
Parameters: volatile_file if true, the external file should not be cached
Parameters: writer the PdfWriter
url the URL
Returns: the file specification