PdfReader (iText API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.lowagie.text.pdf
Class PdfReader

java.lang.Object
  com.lowagie.text.pdf.PdfReader

All Implemented Interfaces:: PdfViewerPreferences

Direct Known Subclasses:: FdfReader

public class PdfReader
extends java.lang.Object
implements PdfViewerPreferences
extends java.lang.Object
implements PdfViewerPreferences

Reads a PDF document.

Author:: Paulo Soares (psoares@consiste.pt), Kazuya Ujihara

Field Summary
`protected PRAcroForm`	`acroForm`
`protected boolean`	`acroFormParsed`
`protected PdfDictionary`	`catalog`
`protected java.security.cert.Certificate`	`certificate`
`protected java.security.Key`	`certificateKey`
`protected java.lang.String`	`certificateKeyProvider`
`protected boolean`	`consolidateNamedDestinations`
`protected PdfEncryption`	`decrypt`
`protected boolean`	`encrypted`
`protected int`	`eofPos`
`protected int`	`freeXref`
`protected int`	`lastXref`
`protected boolean`	`newXrefType`
`protected java.util.HashMap`	`objStmMark`
`protected IntHashtable`	`objStmToOffset`
`protected com.lowagie.text.pdf.PdfReader.PageRefs`	`pageRefs`
`protected byte[]`	`password`
`protected char`	`pdfVersion`
`protected int`	`pValue`
`protected boolean`	`rebuilt`
`protected int`	`rValue`
`protected boolean`	`sharedStreams`
`protected java.util.ArrayList`	`strings`
`protected boolean`	`tampered`
`protected PRTokeniser`	`tokens`
`protected PdfDictionary`	`trailer`
`protected int[]`	`xref`

Constructor Summary
`protected`	`PdfReader()`
	`PdfReader(byte[] pdfIn)` Reads and parses a PDF document.
	`PdfReader(byte[] pdfIn, byte[] ownerPassword)` Reads and parses a PDF document.
	`PdfReader(java.io.InputStream is)` Reads and parses a PDF document.
	`PdfReader(java.io.InputStream is, byte[] ownerPassword)` Reads and parses a PDF document.
	`PdfReader(PdfReader reader)` Creates an independent duplicate.
	`PdfReader(RandomAccessFileOrArray raf, byte[] ownerPassword)` Reads and parses a pdf document.
	`PdfReader(java.lang.String filename)` Reads and parses a PDF document.
	`PdfReader(java.lang.String filename, byte[] ownerPassword)` Reads and parses a PDF document.
	`PdfReader(java.lang.String filename, java.security.cert.Certificate certificate, java.security.Key certificateKey, java.lang.String certificateKeyProvider)` Reads and parses a PDF document.
	`PdfReader(java.net.URL url)` Reads and parses a PDF document.
	`PdfReader(java.net.URL url, byte[] ownerPassword)` Reads and parses a PDF document.

Method Summary
`PRIndirectReference`	`addPdfObject(PdfObject obj)`
`void`	`addViewerPreference(PdfName key, PdfObject value)` Adds a viewer preference
`static byte[]`	`ASCII85Decode(byte[] in)` Decodes a stream that has the ASCII85Decode filter.
`static byte[]`	`ASCIIHexDecode(byte[] in)` Decodes a stream that has the ASCIIHexDecode filter.
`void`	`close()` Closes the reader
`byte[]`	`computeUserPassword()`
`void`	`consolidateNamedDestinations()` Replaces all the local named links with the actual destinations.
`int`	`createFakeFontSubsets()` Finds all the fonts not subset but embedded and marks them as subset.
`static byte[]`	`decodePredictor(byte[] in, PdfObject dicPar)`
`double`	`dumpPerc()`
`protected static PdfDictionary`	`duplicatePdfDictionary(PdfDictionary original, PdfDictionary copy, PdfReader newReader)`
`protected static PdfObject`	`duplicatePdfObject(PdfObject original, PdfReader newReader)`
`void`	`eliminateSharedStreams()` Eliminates shared streams if they exist.
`static byte[]`	`FlateDecode(byte[] in)` Decodes a stream that has the FlateDecode filter.
`static byte[]`	`FlateDecode(byte[] in, boolean strict)` A helper to FlateDecode.
`AcroFields`	`getAcroFields()` Gets a read-only version of `AcroFields`.
`PRAcroForm`	`getAcroForm()` Returns the document's acroform, if it has one.
`Rectangle`	`getBoxSize(int index, java.lang.String boxName)` Gets the box size.
`PdfDictionary`	`getCatalog()` Returns the document's catalog.
`int`	`getCertificationLevel()` Gets the certification level for this document.
`Rectangle`	`getCropBox(int index)` Gets the crop box without taking rotation into account.
`int`	`getCryptoMode()`
`int`	`getEofPos()` Gets the byte address of the %%EOF marker.
`int`	`getFileLength()` Getter for property fileLength.
`java.util.HashMap`	`getInfo()` Returns the content of the document information dictionary as a `HashMap` of `String`.
`java.lang.String`	`getJavaScript()` Gets the global document JavaScript.
`java.lang.String`	`getJavaScript(RandomAccessFileOrArray file)` Gets the global document JavaScript.
`int`	`getLastXref()` Gets the byte address of the last xref table.
`java.util.ArrayList`	`getLinks(int page)`
`byte[]`	`getMetadata()` Gets the XML metadata.
`java.util.HashMap`	`getNamedDestination()` Gets all the named destinations as an `HashMap`.
`java.util.HashMap`	`getNamedDestination(boolean keepNames)` Gets all the named destinations as an `HashMap`.
`java.util.HashMap`	`getNamedDestinationFromNames()` Gets the named destinations from the /Dests key in the catalog as an `HashMap`.
`java.util.HashMap`	`getNamedDestinationFromNames(boolean keepNames)` Gets the named destinations from the /Dests key in the catalog as an `HashMap`.
`java.util.HashMap`	`getNamedDestinationFromStrings()` Gets the named destinations from the /Names key in the catalog as an `HashMap`.
`static Rectangle`	`getNormalizedRectangle(PdfArray box)` Normalizes a `Rectangle` so that llx and lly are smaller than urx and ury.
`int`	`getNumberOfPages()` Gets the number of pages in the document.
`byte[]`	`getPageContent(int pageNum)` Gets the contents of the page.
`byte[]`	`getPageContent(int pageNum, RandomAccessFileOrArray file)` Gets the contents of the page.
`PdfDictionary`	`getPageN(int pageNum)` Gets the dictionary that represents a page.
`PdfDictionary`	`getPageNRelease(int pageNum)`
`PRIndirectReference`	`getPageOrigRef(int pageNum)` Gets the page reference to this page.
`int`	`getPageRotation(int index)` Gets the page rotation.
`Rectangle`	`getPageSize(int index)` Gets the page size without taking rotation into account.
`Rectangle`	`getPageSize(PdfDictionary page)` Gets the page from a page dictionary
`Rectangle`	`getPageSizeWithRotation(int index)` Gets the page size, taking rotation into account.
`Rectangle`	`getPageSizeWithRotation(PdfDictionary page)` Gets the rotated page from a page dictionary.
`PdfObject`	`getPdfObject(int idx)`
`static PdfObject`	`getPdfObject(PdfObject obj)` Reads a `PdfObject` resolving an indirect reference if needed.
`static PdfObject`	`getPdfObject(PdfObject obj, PdfObject parent)`
`PdfObject`	`getPdfObjectRelease(int idx)`
`static PdfObject`	`getPdfObjectRelease(PdfObject obj)`
`static PdfObject`	`getPdfObjectRelease(PdfObject obj, PdfObject parent)` Reads a `PdfObject` resolving an indirect reference if needed.
`protected com.lowagie.text.pdf.PdfReaderInstance`	`getPdfReaderInstance(PdfWriter writer)`
`char`	`getPdfVersion()` Gets the PDF version.
`int`	`getPermissions()` Gets the encryption permissions.
`RandomAccessFileOrArray`	`getSafeFile()` Gets a new file instance of the original PDF document.
`int`	`getSimpleViewerPreferences()` Returns a bitset representing the PageMode and PageLayout viewer preferences.
`static byte[]`	`getStreamBytes(PRStream stream)` Get the content from a stream applying the required filters.
`static byte[]`	`getStreamBytes(PRStream stream, RandomAccessFileOrArray file)` Get the content from a stream applying the required filters.
`static byte[]`	`getStreamBytesRaw(PRStream stream)` Get the content from a stream as it is without applying any filter.
`static byte[]`	`getStreamBytesRaw(PRStream stream, RandomAccessFileOrArray file)` Get the content from a stream as it is without applying any filter.
`PdfDictionary`	`getTrailer()` Gets the trailer dictionary
`int`	`getXrefSize()` Gets the number of xref objects.
`boolean`	`is128Key()` Returns `true` if the PDF has a 128 bit key encryption.
`boolean`	`isAppendable()` Getter for property appendable.
`boolean`	`isEncrypted()` Returns `true` if the PDF is encrypted.
`boolean`	`isHybridXref()` Getter for property hybridXref.
`boolean`	`isMetadataEncrypted()`
`boolean`	`isNewXrefType()` Getter for property newXrefType.
`boolean`	`isOpenedWithFullPermissions()` Checks if the document was opened with the owner password so that the end application can decide what level of access restrictions to apply.
`boolean`	`isRebuilt()` Checks if the document had errors and was rebuilt.
`boolean`	`isTampered()` Checks if the document was changed.
`static PdfObject`	`killIndirect(PdfObject obj)` Eliminates the reference to the object freeing the memory used by it and clearing the xref entry.
`protected void`	`killXref(PdfObject obj)`
`static byte[]`	`LZWDecode(byte[] in)` Decodes a stream that has the LZWDecode filter.
`protected PdfArray`	`readArray()`
`protected PdfDictionary`	`readDictionary()`
`protected void`	`readDocObj()`
`protected void`	`readDocObjPartial()`
`protected void`	`readObjStm(PRStream stream, IntHashtable map)`
`protected PdfObject`	`readOneObjStm(PRStream stream, int idx)`
`protected void`	`readPages()`
`protected void`	`readPdf()`
`protected void`	`readPdfPartial()`
`protected PdfObject`	`readPRObject()`
`protected PdfObject`	`readSingleObject(int k)`
`protected void`	`readXref()`
`protected PdfDictionary`	`readXrefSection()`
`protected boolean`	`readXRefStream(int ptr)`
`protected void`	`rebuildXref()`
`void`	`releaseLastXrefPartial()`
`static void`	`releaseLastXrefPartial(PdfObject obj)`
`void`	`releasePage(int pageNum)`
`void`	`removeAnnotations()` Removes all the annotations and fields from the document.
`void`	`removeFields()` Removes all the fields from the document.
`protected void`	`removeUnusedNode(PdfObject obj, boolean[] hits)`
`int`	`removeUnusedObjects()` Removes all the unreachable objects.
`void`	`removeUsageRights()` Removes any usage rights that this PDF may have.
`void`	`resetLastXrefPartial()`
`void`	`resetReleasePage()`
`void`	`selectPages(java.util.List pagesToKeep)` Selects the pages to keep in the document.
`void`	`selectPages(java.lang.String ranges)` Selects the pages to keep in the document.
`void`	`setAppendable(boolean appendable)` Setter for property appendable.
`void`	`setPageContent(int pageNum, byte[] content)` Sets the contents of the page.
`void`	`setPageContent(int pageNum, byte[] content, int compressionLevel)` Sets the contents of the page.
`void`	`setTampered(boolean tampered)` Sets the tampered state.
`void`	`setViewerPreferences(int preferences)` Sets the viewer preferences as the sum of several constants.
`int`	`shuffleSubsetNames()` Finds all the font subsets and changes the prefixes to some random values.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

tokens

protected PRTokeniser tokens

xref

protected int[] xref

objStmMark

protected java.util.HashMap objStmMark

objStmToOffset

protected IntHashtable objStmToOffset

newXrefType

protected boolean newXrefType

trailer

protected PdfDictionary trailer

catalog

protected PdfDictionary catalog

pageRefs

protected com.lowagie.text.pdf.PdfReader.PageRefs pageRefs

acroForm

protected PRAcroForm acroForm

acroFormParsed

protected boolean acroFormParsed

encrypted

protected boolean encrypted

rebuilt

protected boolean rebuilt

freeXref

protected int freeXref

tampered

protected boolean tampered

lastXref

protected int lastXref

eofPos

protected int eofPos

pdfVersion

protected char pdfVersion

decrypt

protected PdfEncryption decrypt

password

protected byte[] password

certificateKey

protected java.security.Key certificateKey

certificate

protected java.security.cert.Certificate certificate

certificateKeyProvider

protected java.lang.String certificateKeyProvider

strings

protected java.util.ArrayList strings

sharedStreams

protected boolean sharedStreams

consolidateNamedDestinations

protected boolean consolidateNamedDestinations

rValue

protected int rValue

pValue

protected int pValue

Constructor Detail