Package com.itextpdf.text.pdf
Class PdfDocument.PdfCatalog
- java.lang.Object
-
- com.itextpdf.text.pdf.PdfObject
-
- com.itextpdf.text.pdf.PdfDictionary
-
- com.itextpdf.text.pdf.PdfDocument.PdfCatalog
-
- All Implemented Interfaces:
java.io.Serializable
- Enclosing class:
- PdfDocument
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)
-
-
Constructor Summary
Constructors Constructor Description PdfCatalog(PdfIndirectReference pages, PdfWriter writer)
Constructs aPdfCatalog
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description (package private) void
addNames(java.util.TreeMap<java.lang.String,PdfDocument.Destination> localDestinations, java.util.HashMap<java.lang.String,PdfObject> documentLevelJS, java.util.HashMap<java.lang.String,PdfObject> documentFileAttachment, PdfWriter writer)
Adds the names of the named destinations to the catalog.(package private) void
setAdditionalActions(PdfDictionary actions)
Sets the document level additional actions.(package private) void
setOpenAction(PdfAction action)
Adds an open action to the catalog.-
Methods inherited from class com.itextpdf.text.pdf.PdfDictionary
checkType, clear, contains, get, getAsArray, getAsBoolean, getAsDict, getAsIndirectObject, getAsName, getAsNumber, getAsStream, getAsString, getDirectObject, getKeys, isCatalog, isFont, isOutlineTree, isPage, isPages, merge, mergeDifferent, put, putAll, putEx, remove, size, toPdf, toString
-
Methods inherited from class com.itextpdf.text.pdf.PdfObject
canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, length, setContent, setIndRef, type
-
-
-
-
Field Detail
-
writer
PdfWriter writer
The writer writing the PDF for which we are creating this catalog object.
-
-
Constructor Detail
-
PdfCatalog
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
void addNames(java.util.TreeMap<java.lang.String,PdfDocument.Destination> localDestinations, java.util.HashMap<java.lang.String,PdfObject> documentLevelJS, java.util.HashMap<java.lang.String,PdfObject> 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
void setOpenAction(PdfAction action)
Adds an open action to the catalog.- Parameters:
action
- the action that will be triggered upon opening the document
-
setAdditionalActions
void setAdditionalActions(PdfDictionary actions)
Sets the document level additional actions.- Parameters:
actions
- dictionary of actions
-
-