Package org.apache.pdfbox.pdmodel
Class PDDocumentCatalog
java.lang.Object
org.apache.pdfbox.pdmodel.PDDocumentCatalog
- All Implemented Interfaces:
COSObjectable
This class represents the acroform of a PDF document.
- Version:
- $Revision: 1.21 $
- Author:
- Ben Litchfield
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Display the pages in one column.static final String
Display one page at a time.static final String
Display the pages in two columns, with odd numbered pagse on the left.static final String
Display the pages in two columns, with odd numbered pagse on the right.static final String
Display the pages two at a time, with odd-numbered pages on the left.static final String
Display the pages two at a time, with odd-numbered pages on the right.static final String
Full screen mode with no menu bar, window controls.static final String
Attachments panel is visible.static final String
Page mode where neither the outline nor the thumbnails are displayed.static final String
Optional content group panel is visible when opened.static final String
Show bookmarks when pdf is opened.static final String
Show thumbnails when pdf is opened. -
Constructor Summary
ConstructorsConstructorDescriptionConstructor.PDDocumentCatalog
(PDDocument doc, COSDictionary rootDictionary) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addOutputIntent
(PDOutputIntent outputIntent) Add an OutputIntent to the list.This will get the documents acroform.The PDF document contains a hierarchical structure of PDPageNode and PDPages, which is mostly just a way to store this information.Convert this standard java object to a COS object.Convert this standard java object to a COS object.getDests()
Get the outline associated with this document or null if it does not exist.The language for the document.Get info about doc's usage of tagged features.Get the metadata that is part of the document catalog.getNames()
Get the optional content properties dictionary associated with this document.Get the Document Open Action for this object.Get the list of OutputIntents defined in the document.Returns the page labels descriptor of the document.Set the page layout, see the PAGE_LAYOUT_XXX constants.Set the page display mode, see the PAGE_MODE_XXX constants.getPages()
This will get the root node for the pages.Get the document's structure tree root.Get the list threads for this pdf document.getURI()
Document level information in the URI.Returns the PDF specification version this document conforms to.Get the viewer preferences associated with this document or null if they do not exist.void
setAcroForm
(PDAcroForm acro) Set the acro form for this catalog.void
Set the additional actions for the document.void
setDocumentOutline
(PDDocumentOutline outlines) Set the document outlines.void
setLanguage
(String language) Set the Language for the document.void
setMarkInfo
(PDMarkInfo markInfo) Set information about the doc's usage of tagged features.void
setMetadata
(PDMetadata meta) Set the metadata for this object.void
setNames
(PDDocumentNameDictionary names) Set the names dictionary for the document.void
setOCProperties
(PDOptionalContentProperties ocProperties) Set the optional content properties dictionary.void
setOpenAction
(PDDestinationOrAction action) Set the Document Open Action for this object.void
setOutputIntents
(List<PDOutputIntent> outputIntents) Replace the list of OutputIntents of the document.void
setPageLabels
(PDPageLabels labels) Set the page label descriptor for the document.void
setPageLayout
(String layout) Set the page layout.void
setPageMode
(String mode) Set the page mode.void
setStructureTreeRoot
(PDStructureTreeRoot treeRoot) Set the document's structure tree root.void
setThreads
(List threads) Set the list of threads for this pdf document.void
setURI
(PDURIDictionary uri) Set the document level uri.void
setVersion
(String version) Sets the PDF specification version this document conforms to.void
Set the viewer preferences.
-
Field Details
-
PAGE_MODE_USE_NONE
Page mode where neither the outline nor the thumbnails are displayed.- See Also:
-
PAGE_MODE_USE_OUTLINES
Show bookmarks when pdf is opened.- See Also:
-
PAGE_MODE_USE_THUMBS
Show thumbnails when pdf is opened.- See Also:
-
PAGE_MODE_FULL_SCREEN
Full screen mode with no menu bar, window controls.- See Also:
-
PAGE_MODE_USE_OPTIONAL_CONTENT
Optional content group panel is visible when opened.- See Also:
-
PAGE_MODE_USE_ATTACHMENTS
Attachments panel is visible.- See Also:
-
PAGE_LAYOUT_SINGLE_PAGE
Display one page at a time.- See Also:
-
PAGE_LAYOUT_ONE_COLUMN
Display the pages in one column.- See Also:
-
PAGE_LAYOUT_TWO_COLUMN_LEFT
Display the pages in two columns, with odd numbered pagse on the left.- See Also:
-
PAGE_LAYOUT_TWO_COLUMN_RIGHT
Display the pages in two columns, with odd numbered pagse on the right.- See Also:
-
PAGE_LAYOUT_TWO_PAGE_LEFT
Display the pages two at a time, with odd-numbered pages on the left.- Since:
- PDF Version 1.5
- See Also:
-
PAGE_LAYOUT_TWO_PAGE_RIGHT
Display the pages two at a time, with odd-numbered pages on the right.- Since:
- PDF Version 1.5
- See Also:
-
-
Constructor Details
-
PDDocumentCatalog
Constructor.- Parameters:
doc
- The document that this catalog is part of.
-
PDDocumentCatalog
Constructor.- Parameters:
doc
- The document that this catalog is part of.rootDictionary
- The root dictionary that this object wraps.
-
-
Method Details
-
getCOSObject
Convert this standard java object to a COS object.- Specified by:
getCOSObject
in interfaceCOSObjectable
- Returns:
- The cos object that matches this Java object.
-
getCOSDictionary
Convert this standard java object to a COS object.- Returns:
- The cos object that matches this Java object.
-
getAcroForm
This will get the documents acroform. This will return null if no acroform is part of the document.- Returns:
- The documents acroform.
-
setAcroForm
Set the acro form for this catalog.- Parameters:
acro
- The new acro form.
-
getPages
This will get the root node for the pages.- Returns:
- The parent page node.
-
getAllPages
The PDF document contains a hierarchical structure of PDPageNode and PDPages, which is mostly just a way to store this information. This method will return a flat list of all PDPage objects in this document.- Returns:
- A list of PDPage objects.
-
getViewerPreferences
Get the viewer preferences associated with this document or null if they do not exist.- Returns:
- The document's viewer preferences.
-
setViewerPreferences
Set the viewer preferences.- Parameters:
prefs
- The new viewer preferences.
-
getDocumentOutline
Get the outline associated with this document or null if it does not exist.- Returns:
- The document's outline.
-
getThreads
Get the list threads for this pdf document.- Returns:
- A list of PDThread objects.
-
setThreads
Set the list of threads for this pdf document.- Parameters:
threads
- The list of threads, or null to clear it.
-
getMetadata
Get the metadata that is part of the document catalog. This will return null if there is no meta data for this object.- Returns:
- The metadata for this object.
-
setMetadata
Set the metadata for this object. This can be null.- Parameters:
meta
- The meta data for this object.
-
setOpenAction
Set the Document Open Action for this object.- Parameters:
action
- The action you want to perform.
-
getOpenAction
Get the Document Open Action for this object.- Returns:
- The action to perform when the document is opened.
- Throws:
IOException
- If there is an error creating the destination or action.
-
getActions
- Returns:
- The Additional Actions for this Document
-
setActions
Set the additional actions for the document.- Parameters:
actions
- The actions that are associated with this document.
-
getNames
- Returns:
- The names dictionary for this document or null if none exist.
-
getDests
- Returns:
- The named destinations dictionary for this document or null if none exists.
-
setNames
Set the names dictionary for the document.- Parameters:
names
- The names dictionary that is associated with this document.
-
getMarkInfo
Get info about doc's usage of tagged features. This will return null if there is no information.- Returns:
- The new mark info.
-
setMarkInfo
Set information about the doc's usage of tagged features.- Parameters:
markInfo
- The new MarkInfo data.
-
getOutputIntent
Get the list of OutputIntents defined in the document.- Returns:
- The list of PDOutputIntent
-
addOutputIntent
Add an OutputIntent to the list. If there is not OutputIntent, the list is created and the first element added.- Parameters:
outputIntent
- the OutputIntent to add.
-
setOutputIntents
Replace the list of OutputIntents of the document.- Parameters:
outputIntents
- the list of OutputIntents, if the list is empty all OutputIntents are removed.
-
getPageMode
Set the page display mode, see the PAGE_MODE_XXX constants.- Returns:
- A string representing the page mode.
-
setPageMode
Set the page mode. See the PAGE_MODE_XXX constants for valid values.- Parameters:
mode
- The new page mode.
-
getPageLayout
Set the page layout, see the PAGE_LAYOUT_XXX constants.- Returns:
- A string representing the page layout.
-
setPageLayout
Set the page layout. See the PAGE_LAYOUT_XXX constants for valid values.- Parameters:
layout
- The new page layout.
-
getURI
Document level information in the URI.- Returns:
- Document level URI.
-
setURI
Set the document level uri.- Parameters:
uri
- The new document level uri.
-
getStructureTreeRoot
Get the document's structure tree root.- Returns:
- The document's structure tree root or null if none exists.
-
setStructureTreeRoot
Set the document's structure tree root.- Parameters:
treeRoot
- The new structure tree.
-
getLanguage
The language for the document.- Returns:
- The language for the document.
-
setLanguage
Set the Language for the document.- Parameters:
language
- The new document language.
-
getVersion
Returns the PDF specification version this document conforms to.- Returns:
- The PDF version.
-
setVersion
Sets the PDF specification version this document conforms to.- Parameters:
version
- the PDF version (ex. "1.4")
-
getPageLabels
Returns the page labels descriptor of the document.- Returns:
- the page labels descriptor of the document.
- Throws:
IOException
- If there is a problem retrieving the page labels.
-
setPageLabels
Set the page label descriptor for the document.- Parameters:
labels
- the new page label descriptor to set.
-
getOCProperties
Get the optional content properties dictionary associated with this document.- Returns:
- the optional properties dictionary or null if it is not present
- Since:
- PDF 1.5
-
setOCProperties
Set the optional content properties dictionary.- Parameters:
ocProperties
- the optional properties dictionary- Since:
- PDF 1.5
-