Package com.aowagie.text.pdf
Class PdfDocument.PdfCatalog
- java.lang.Object
-
- com.aowagie.text.pdf.PdfObject
-
- com.aowagie.text.pdf.PdfDictionary
-
- com.aowagie.text.pdf.PdfDocument.PdfCatalog
-
- Enclosing class:
- PdfDocument
private static class PdfDocument.PdfCatalog extends PdfDictionary
PdfCatalog
is the PDF Catalog-object.The Catalog is a dictionary that is the root node of the document. It contains a reference to the tree of pages contained in the document, a reference to the tree of objects representing the document's outline, a reference to the document's article threads, and the list of named destinations. In addition, the Catalog indicates whether the document's outline or thumbnail page images should be displayed automatically when the document is viewed and whether some location other than the first page should be shown when the document is opened.
In this class however, only the reference to the tree of pages is implemented.
This object is described in the 'Portable Document Format Reference Manual version 1.3' section 6.2 (page 67-71)
-
-
Field Summary
Fields Modifier and Type Field Description private PdfWriter
writer
The writer writing the PDF for which we are creating this catalog object.-
Fields inherited from class com.aowagie.text.pdf.PdfDictionary
CATALOG, hashMap, OUTLINES, PAGE
-
Fields inherited from class com.aowagie.text.pdf.PdfObject
ARRAY, BOOLEAN, bytes, DICTIONARY, INDIRECT, NAME, NOTHING, NULL, NUMBER, STREAM, STRING, TEXT_PDFDOCENCODING, TEXT_UNICODE, type
-
-
Constructor Summary
Constructors Modifier Constructor Description private
PdfCatalog(PdfIndirectReference pages, PdfWriter writer)
Constructs aPdfCatalog
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description private void
addNames(java.util.TreeMap localDestinations, java.util.HashMap documentLevelJS, java.util.HashMap documentFileAttachment, PdfWriter writer)
Adds the names of the named destinations to the catalog.private void
setAdditionalActions(PdfDictionary actions)
Sets the document level additional actions.private void
setOpenAction(PdfAction action)
Adds an open action to the catalog.-
Methods inherited from class com.aowagie.text.pdf.PdfDictionary
contains, get, getAsArray, getAsBoolean, getAsDict, getAsIndirectObject, getAsName, getAsNumber, getAsString, getDirectObject, getKeys, isCatalog, isFont, isOutlineTree, isPage, isPages, merge, mergeDifferent, put, putAll, remove, size, toPdf, toString
-
Methods inherited from class com.aowagie.text.pdf.PdfObject
canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, setContent, setIndRef, type
-
-
-
-
Field Detail
-
writer
private final PdfWriter writer
The writer writing the PDF for which we are creating this catalog object.
-
-
Constructor Detail
-
PdfCatalog
private PdfCatalog(PdfIndirectReference pages, PdfWriter writer)
Constructs aPdfCatalog
.- Parameters:
pages
- an indirect reference to the root of the document's Pages tree.writer
- the writer the catalog applies to
-
-
Method Detail
-
addNames
private void addNames(java.util.TreeMap localDestinations, java.util.HashMap documentLevelJS, java.util.HashMap documentFileAttachment, PdfWriter writer)
Adds the names of the named destinations to the catalog.- Parameters:
localDestinations
- the local destinationsdocumentLevelJS
- the javascript used in the documentdocumentFileAttachment
- the attached fileswriter
- the writer the catalog applies to
-
setOpenAction
private void setOpenAction(PdfAction action)
Adds an open action to the catalog.- Parameters:
action
- the action that will be triggered upon opening the document
-
setAdditionalActions
private void setAdditionalActions(PdfDictionary actions)
Sets the document level additional actions.- Parameters:
actions
- dictionary of actions
-
-