|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.lowagie.text.pdf.PdfObject | +--com.lowagie.text.pdf.PdfDictionary | +--com.lowagie.text.pdf.PdfDocument.PdfCatalog
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)
Field Summary |
Fields inherited from class com.lowagie.text.pdf.PdfDictionary |
CATALOG, FONT, hashMap, OUTLINES, PAGE, PAGES |
Fields inherited from class com.lowagie.text.pdf.PdfObject |
ARRAY, BOOLEAN, bytes, DICTIONARY, INDIRECT, NAME, NOTHING, NULL, NUMBER, STREAM, STRING, TEXT_PDFDOCENCODING, TEXT_UNICODE, type |
Constructor Summary | |
(package private) |
PdfDocument.PdfCatalog(PdfIndirectReference pages)
Constructs a PdfCatalog . |
(package private) |
PdfDocument.PdfCatalog(PdfIndirectReference pages,
PdfIndirectReference outlines)
Constructs a PdfCatalog . |
Method Summary | |
(package private) void |
addNames(TreeMap localDestinations,
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. |
Methods inherited from class com.lowagie.text.pdf.PdfDictionary |
contains, get, getKeys, isCatalog, isDictionaryType, isFont, isOutlineTree, isPage, isPages, merge, mergeDifferent, put, putAll, putDel, putEx, remove, size, toPdf |
Methods inherited from class com.lowagie.text.pdf.PdfObject |
getBytes, isArray, isBoolean, isDictionary, isName, isNull, isNumber, isStream, isString, length, setContent, toString, type |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
PdfDocument.PdfCatalog(PdfIndirectReference pages)
PdfCatalog
.
pages
- an indirect reference to the root of the document's Pages tree.PdfDocument.PdfCatalog(PdfIndirectReference pages, PdfIndirectReference outlines)
PdfCatalog
.
pages
- an indirect reference to the root of the document's Pages tree.outlines
- an indirect reference to the outline tree.Method Detail |
void addNames(TreeMap localDestinations, ArrayList documentJavaScript, PdfWriter writer)
localDestinations
- the local destinationsvoid 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)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |