Class PdfFileSpecification

java.lang.Object

com.gitlab.pdftk_java.com.lowagie.text.pdf.PdfObject

com.gitlab.pdftk_java.com.lowagie.text.pdf.PdfDictionary

com.gitlab.pdftk_java.com.lowagie.text.pdf.PdfFileSpecification

public class PdfFileSpecification
extends PdfDictionary

Specifies a file or an URL. The file can be extern or embedded.

Field Summary

Fields

Modifier and Type	Field	Description
protected PdfIndirectReference	ref
protected PdfWriter	writer

Fields inherited from class PdfDictionary

CATALOG, FONT, hashMap, OUTLINES, PAGE, PAGES

Fields inherited from class PdfObject

ARRAY, BOOLEAN, bytes, DICTIONARY, INDIRECT, indRef, m_NULL, NAME, NOTHING, NUMBER, STREAM, STRING, TEXT_PDFDOCENCODING, TEXT_UNICODE, type

Constructor Summary

Constructors

Constructor	Description
PdfFileSpecification()	Creates a new instance of PdfFileSpecification.

Method Summary

Modifier and Type	Method	Description
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.
static PdfFileSpecification	url(PdfWriter writer, String url)	Creates a file specification of type URL.

Methods inherited from class PdfDictionary

contains, get, getAsArray, getAsBoolean, getAsDict, getAsIndirectObject, getAsName, getAsNumber, getAsStream, getAsString, getDirectObject, getKeys, isCatalog, isDictionaryType, isFont, isOutlineTree, isPage, isPages, merge, mergeDifferent, put, putAll, putDel, putEx, remove, size, toPdf

Methods inherited from class PdfObject

canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, length, setContent, setIndRef, toString, type

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

writer

protected PdfWriter writer

ref

protected PdfIndirectReference ref

Constructor Details

PdfFileSpecification

public PdfFileSpecification()

Creates a new instance of PdfFileSpecification. The static methods are preferred.

Method Details

url

public static PdfFileSpecification url(PdfWriter writer,
 String url)

Creates a file specification of type URL.

Parameters:

writer - the PdfWriter

url - the URL

Returns:

the file specification

fileEmbedded

public static PdfFileSpecification fileEmbedded(PdfWriter writer,
 String filePath,
 String fileDisplay,
 byte[] fileStore)
                                         throws IOException

Creates a file specification with the file embedded. The file may come from the file system or from a byte array. The data is flate compressed.

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

fileEmbedded

public static PdfFileSpecification fileEmbedded(PdfWriter writer,
 String filePath,
 String fileDisplay,
 byte[] fileStore,
 boolean compress)
                                         throws IOException

Creates a file specification with the file embedded. The file may come from the file system or from a byte array.

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

fileExtern

public static PdfFileSpecification fileExtern(PdfWriter writer,
 String filePath)

Creates a file specification for an external file.

Parameters:

writer - the PdfWriter

filePath - the file path

Returns:

the file specification

getReference

public PdfIndirectReference getReference()
                                  throws IOException

Gets the indirect reference to this file specification. Multiple invocations will retrieve the same value.

Returns:

the indirect reference

Throws:

IOException - on error