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 wether 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 |
Constructor and Description |
---|
PdfDocument.PdfCatalog(PdfIndirectReference pages,
PdfIndirectReference outlines,
PdfWriter writer)
Constructs a
PdfCatalog . |
PdfDocument.PdfCatalog(PdfIndirectReference pages,
PdfWriter writer)
Constructs a
PdfCatalog . |
Modifier and Type | Method and Description |
---|---|
(package private) void |
addNames(java.util.TreeMap localDestinations,
java.util.ArrayList documentJavaScript,
PdfWriter writer)
Adds the names of the named destinations to the catalog.
|
(package private) void |
setAcroForm(PdfObject fields) |
(package private) void |
setAdditionalActions(PdfDictionary actions)
Sets the document level additional actions.
|
(package private) void |
setOpenAction(PdfAction action) |
(package private) void |
setPageLabels(PdfPageLabels pageLabels) |
(package private) void |
setViewerPreferences(int preferences)
Sets the viewer preferences as the sum of several constants.
|
contains, get, getKeys, isCatalog, isDictionaryType, isFont, isOutlineTree, isPage, isPages, merge, mergeDifferent, put, putAll, putDel, putEx, remove, size, toPdf, toString
canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, length, setContent, setIndRef, type
PdfWriter writer
PdfDocument.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 toPdfDocument.PdfCatalog(PdfIndirectReference pages, PdfIndirectReference outlines, PdfWriter writer)
PdfCatalog
.pages
- an indirect reference to the root of the document's Pages tree.outlines
- an indirect reference to the outline tree.writer
- the writer the catalog applies tovoid addNames(java.util.TreeMap localDestinations, java.util.ArrayList documentJavaScript, PdfWriter writer)
localDestinations
- the local destinationsdocumentJavaScript
- the javascript used in the documentwriter
- the writer the catalog applies tovoid setViewerPreferences(int preferences)
preferences
- the viewer preferencesPdfWriter.setViewerPreferences(int)
void setOpenAction(PdfAction action)
void setAdditionalActions(PdfDictionary actions)
actions
- dictionary of actionsvoid setPageLabels(PdfPageLabels pageLabels)
void setAcroForm(PdfObject fields)