|
![]() |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.lowagie.text.pdf.PdfObject
com.lowagie.text.pdf.PdfDictionary
com.lowagie.text.pdf.PdfFileSpecification
Specifies a file or an URL. The file can be extern or embedded.
Field Summary | |
protected PdfIndirectReference |
ref
|
protected PdfWriter |
writer
|
Fields inherited from class com.lowagie.text.pdf.PdfDictionary |
CATALOG, FONT, hashMap, OUTLINES, PAGE, PAGES |
Fields inherited from class com.lowagie.text.pdf.PdfObject |
ARRAY, BOOLEAN, bytes, DICTIONARY, INDIRECT, indRef, NAME, NOTHING, NULL, NUMBER, STREAM, STRING, TEXT_PDFDOCENCODING, TEXT_UNICODE, type |
Constructor Summary | |
PdfFileSpecification()
Creates a new instance of PdfFileSpecification. |
Method Summary | |
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 |
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. |
static PdfFileSpecification |
url(PdfWriter writer,
String url)
Creates a file specification of type URL. |
Methods inherited from class com.lowagie.text.pdf.PdfDictionary |
contains, get, getKeys, isCatalog, isDictionaryType, isFont, isOutlineTree, isPage, isPages, merge, mergeDifferent, put, putAll, putEx, remove, size, toPdf, toString |
Methods inherited from class com.lowagie.text.pdf.PdfObject |
canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, length, setContent, setIndRef, type |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
protected PdfWriter writer
protected PdfIndirectReference ref
Constructor Detail |
public PdfFileSpecification()
Method Detail |
public static PdfFileSpecification url(PdfWriter writer, String url)
writer
- the PdfWriter
url
- the URL
public 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, 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 compression
IOException
- on errorpublic static PdfFileSpecification fileExtern(PdfWriter writer, String filePath)
writer
- the PdfWriter
filePath
- the file path
public PdfIndirectReference getReference() throws IOException
IOException
- on errorpublic void setMultiByteFileName(byte[] fileName)
fileName
- the file name as a byte array
|
![]() |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |