com.aowagie.text.pdf

Class PdfFileSpecification

java.lang.Object

com.aowagie.text.pdf.PdfObject

com.aowagie.text.pdf.PdfDictionary

com.aowagie.text.pdf.PdfFileSpecification

public class PdfFileSpecification
extends PdfDictionary

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

Author:

Paulo Soares (psoares@consiste.pt)

Field Summary

Fields inherited from class com.aowagie.text.pdf.PdfDictionary

hashMap

Fields inherited from class com.aowagie.text.pdf.PdfObject

ARRAY, bytes, INDIRECT, STREAM, TEXT_UNICODE, type

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static PdfFileSpecification	fileEmbedded(PdfWriter writer, String filePath, String fileDisplay, byte[] fileStore) 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	setVolatile(boolean volatile_file) Sets a flag that indicates whether an external file referenced by the file specification is volatile.

Methods inherited from class com.aowagie.text.pdf.PdfDictionary

get, getAsArray, getAsDict, getAsName, getAsNumber, getAsString, getDirectObject, getKeys, isCatalog, isFont, isOutlineTree, isPage, isPages, put, remove, size, toPdf, toString

Methods inherited from class com.aowagie.text.pdf.PdfObject

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PdfFileSpecification

public PdfFileSpecification()

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

Method Detail

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

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

setMultiByteFileName

public void setMultiByteFileName(byte[] fileName)

Sets the file name (the key /F) string as an hex representation to support multi byte file names. The name must have the slash and backslash escaped according to the file specification rules

Parameters:

fileName - the file name as a byte array

setVolatile

public void setVolatile(boolean volatile_file)

Sets a flag that indicates whether an external file referenced by the file specification is volatile. If the value is true, applications should never cache a copy of the file.

Parameters:

volatile_file - if true, the external file should not be cached