Class FdfReader

java.lang.Object

com.gitlab.pdftk_java.com.lowagie.text.pdf.PdfReader

com.gitlab.pdftk_java.com.lowagie.text.pdf.FdfReader

All Implemented Interfaces:

PdfViewerPreferences

public class FdfReader
extends PdfReader

Reads an FDF form and makes the fields available

Nested Class Summary

Nested classes/interfaces inherited from class PdfReader

PdfReader.PageRefs

Field Summary

Fields

Modifier and Type	Field	Description
(package private) PdfName	encoding
(package private) HashMap	fields
(package private) String	fileSpec

Fields inherited from class PdfReader

acroForm, acroFormParsed, catalog, consolidateNamedDestinations, decrypt, encrypted, endobj, endstream, eofPos, freeXref, lastXref, newXrefType, objStmMark, objStmToOffset, ownerPasswordUsed, pageInhCandidates, pageRefs, password, pdfVersion, pValue, rebuilt, remoteToLocalNamedDestinations, rootPages, rValue, sharedStreams, strings, tampered, tokens, trailer, vpints, vpnames, xref

Constructor Summary

Constructors

Constructor	Description
FdfReader(byte[] pdfIn)	Reads an FDF form.
FdfReader(InputStream is)	Reads an FDF form.
FdfReader(String filename)	Reads an FDF form.
FdfReader(URL url)	Reads an FDF form.

Method Summary

Modifier and Type	Method	Description
private String	decodeString(PdfString vs)
PdfDictionary	getField(String name)	Gets the field dictionary.
String[]	getFieldMultiValue(String name)
String	getFieldRichValue(String name)
HashMap	getFields()	Gets all the fields.
String	getFieldValue(String name)	Gets the field value or null if the field does not exist or has no value defined.
String	getFileSpec()	Gets the PDF file specification contained in the FDF.
protected void	kidNode(PdfDictionary merged, String name)
protected void	readFields()
protected void	readFileSpecification(PdfDictionary fdf)
protected void	readPdf()

Methods inherited from class PdfReader

addPdfObject, addViewerPreference, ASCII85Decode, ASCIIHexDecode, close, computeUserPassword, consolidateNamedDestinations, createFakeFontSubsets, decodePredictor, dumpPerc, duplicatePdfDictionary, duplicatePdfObject, eliminateSharedStreams, equalsn, existsName, FlateDecode, FlateDecode, getAcroFields, getAcroForm, getBoxSize, getBoxSize, getBoxSize, getCatalog, getCropBox, getCropBox, getCryptoMode, getCryptoRef, getDecrypt, getEofPos, getFileLength, getFontName, getInfo, getJavaScript, getJavaScript, getLastXref, getMetadata, getNamedDestination, getNamedDestination, getNamedDestinationFromNames, getNamedDestinationFromNames, getNamedDestinationFromStrings, getNormalizedRectangle, getNumberOfPages, getPageContent, getPageContent, getPageN, getPageNRelease, getPageOrigRef, getPageRotation, getPageRotation, getPageSize, getPageSize, getPageSizeWithRotation, getPageSizeWithRotation, getPdfObject, getPdfObject, getPdfObject, getPdfObjectRelease, getPdfObjectRelease, getPdfObjectRelease, getPdfReaderInstance, getPdfVersion, getPermissions, getPRIndirectReference, getSafeFile, getSimpleViewerPreferences, getStreamBytes, getStreamBytes, getStreamBytesRaw, getStreamBytesRaw, getSubsetPrefix, getTrailer, getXrefSize, is128Key, isAppendable, isEncrypted, isHybridXref, isMetadataEncrypted, isNewXrefType, isOpenedWithFullPermissions, isRebuilt, isTampered, killIndirect, killXref, LZWDecode, makeRemoteNamedDestinationsLocal, readArray, readDictionary, readDocObj, readDocObjPartial, readObjStm, readOneObjStm, readPages, readPdfPartial, readPRObject, readSingleObject, readXref, readXrefSection, readXRefStream, rebuildXref, releaseLastXrefPartial, releaseLastXrefPartial, releasePage, removeAnnotations, removeFields, removeUnusedNode, removeUnusedObjects, removeUsageRights, resetLastXrefPartial, resetReleasePage, selectPages, selectPages, setAppendable, setPageContent, setPageContent, setTampered, setViewerPreferences, setViewerPreferences, shuffleSubsetNames

Methods inherited from class Object

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

Field Details

fields

HashMap fields

fileSpec

String fileSpec

encoding

PdfName encoding

Constructor Details

FdfReader

public FdfReader(String filename)
          throws IOException

Reads an FDF form.

Parameters:

filename - the file name of the form

Throws:

IOException - on error

FdfReader

public FdfReader(byte[] pdfIn)
          throws IOException

Reads an FDF form.

Parameters:

pdfIn - the byte array with the form

Throws:

IOException - on error

FdfReader

public FdfReader(URL url)
          throws IOException

Reads an FDF form.

Parameters:

url - the URL of the document

Throws:

IOException - on error

FdfReader

public FdfReader(InputStream is)
          throws IOException

Reads an FDF form.

Parameters:

is - the InputStream containing the document. The stream is read to the end but is not closed

Throws:

IOException - on error

Method Details

readPdf

protected void readPdf()
                throws IOException

Overrides:

readPdf in class PdfReader

Throws:

IOException

kidNode

protected void kidNode(PdfDictionary merged,
 String name)

readFileSpecification

protected void readFileSpecification(PdfDictionary fdf)

readFields

protected void readFields()
                   throws IOException

Throws:

IOException

getFields

public HashMap getFields()

Gets all the fields. The map is keyed by the fully qualified field name and the value is a merged PdfDictionary with the field content.

Returns:

all the fields

getField

public PdfDictionary getField(String name)

Gets the field dictionary.

Parameters:

name - the fully qualified field name

Returns:

the field dictionary

decodeString

private String decodeString(PdfString vs)

getFieldValue

public String getFieldValue(String name)

Gets the field value or null if the field does not exist or has no value defined.

Parameters:

name - the fully qualified field name

Returns:

the field value or null

getFieldRichValue

public String getFieldRichValue(String name)

getFieldMultiValue

public String[] getFieldMultiValue(String name)

getFileSpec

public String getFileSpec()

Gets the PDF file specification contained in the FDF.

Returns:

the PDF file specification contained in the FDF