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)
Modifier and Type | Field and Description |
---|---|
(package private) PdfWriter |
writer
The writer writing the PDF for which we are creating this catalog object.
|
Constructor and Description |
---|
PdfCatalog(PdfIndirectReference pages,
PdfWriter writer)
Constructs a
PdfCatalog . |
Modifier and Type | Method and Description |
---|---|
(package private) void |
addNames(TreeMap<String,PdfDocument.Destination> localDestinations,
HashMap<String,PdfObject> documentLevelJS,
HashMap<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.
|
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
canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, length, setContent, setIndRef, type
PdfCatalog(PdfIndirectReference pages, PdfWriter writer)
PdfCatalog
.pages
- an indirect reference to the root of the document's Pages tree.writer
- the writer the catalog applies tovoid addNames(TreeMap<String,PdfDocument.Destination> localDestinations, HashMap<String,PdfObject> documentLevelJS, HashMap<String,PdfObject> documentFileAttachment, PdfWriter writer)
localDestinations
- the local destinationsdocumentLevelJS
- the javascript used in the documentdocumentFileAttachment
- the attached fileswriter
- the writer the catalog applies tovoid setOpenAction(PdfAction action)
action
- the action that will be triggered upon opening the documentvoid setAdditionalActions(PdfDictionary actions)
actions
- dictionary of actionsWebARTS Library Licensed Under the GNU - General Public License. Other Libraries licensed under their respective Open Source Licenses