public class PdfFileSpecification extends PdfDictionary
Modifier and Type | Field and Description |
---|---|
protected PdfIndirectReference |
ref |
protected PdfWriter |
writer |
Constructor and Description |
---|
PdfFileSpecification()
Creates a new instance of PdfFileSpecification.
|
Modifier and Type | Method and Description |
---|---|
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,
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,
int compressionLevel)
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.
|
clear, contains, get, getAsArray, getAsBoolean, getAsDict, getAsIndirectObject, getAsName, getAsNumber, getAsStream, getAsString, getDirectObject, getKeys, isCatalog, isFont, isOutlineTree, isPage, isPages, merge, mergeDifferent, put, putAll, putEx, remove, size, toPdf, toString
canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, length, setContent, setIndRef, type
protected PdfIndirectReference ref
public PdfFileSpecification()
public static PdfFileSpecification url(PdfWriter writer, String url)
writer
- the PdfWriter
url
- the URLpublic static PdfFileSpecification fileEmbedded(PdfWriter writer, String filePath, String fileDisplay, byte[] fileStore) throws IOException
writer
- the PdfWriter
filePath
- the file pathfileDisplay
- the file information that is presented to the userfileStore
- the byte array with the file. If it is not null
it takes precedence over filePath
IOException
- on errorpublic static PdfFileSpecification fileEmbedded(PdfWriter writer, String filePath, String fileDisplay, byte[] fileStore, int compressionLevel) throws IOException
writer
- the PdfWriter
filePath
- the file pathfileDisplay
- the file information that is presented to the userfileStore
- the byte array with the file. If it is not null
it takes precedence over filePath
compressionLevel
- the compression level to be used for compressing the file
it takes precedence over filePath
IOException
- on errorpublic static PdfFileSpecification fileEmbedded(PdfWriter writer, String filePath, String fileDisplay, byte[] fileStore, boolean compress) throws IOException
writer
- the PdfWriter
filePath
- the file pathfileDisplay
- the file information that is presented to the userfileStore
- 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 compressionIOException
- on errorpublic static PdfFileSpecification fileEmbedded(PdfWriter writer, String filePath, String fileDisplay, byte[] fileStore, boolean compress, String mimeType, PdfDictionary fileParameter) throws IOException
writer
- the PdfWriter
filePath
- the file pathfileDisplay
- the file information that is presented to the userfileStore
- 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 compressionmimeType
- the optional mimeTypefileParameter
- the optional extra file parameters such as the creation or modification dateIOException
- on errorpublic static PdfFileSpecification fileEmbedded(PdfWriter writer, String filePath, String fileDisplay, byte[] fileStore, String mimeType, PdfDictionary fileParameter, int compressionLevel) throws IOException
writer
- the PdfWriter
filePath
- the file pathfileDisplay
- the file information that is presented to the userfileStore
- the byte array with the file. If it is not null
it takes precedence over filePath
mimeType
- the optional mimeTypefileParameter
- the optional extra file parameters such as the creation or modification datecompressionLevel
- the level of compressionIOException
- on errorpublic static PdfFileSpecification fileExtern(PdfWriter writer, String filePath)
writer
- the PdfWriter
filePath
- the file pathpublic PdfIndirectReference getReference() throws IOException
IOException
- on errorpublic void setMultiByteFileName(byte[] fileName)
fileName
- the file name as a byte arraypublic void setUnicodeFileName(String filename, boolean unicode)
filename
- the filenameunicode
- if true, the filename is UTF-16BE encoded; otherwise PDFDocEncoding is used;public void setVolatile(boolean volatile_file)
volatile_file
- if true, the external file should not be cachedpublic void addDescription(String description, boolean unicode)
description
- some textunicode
- if true, the text is added as a unicode stringpublic void addCollectionItem(PdfCollectionItem ci)
WebARTS Library Licensed Under the GNU - General Public License. Other Libraries licensed under their respective Open Source Licenses