|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.pdfbox.pdmodel.PDDocumentCatalog
public class PDDocumentCatalog
This class represents the acroform of a PDF document.
Field Summary | |
---|---|
static java.lang.String |
PAGE_LAYOUT_ONE_COLUMN
Display the pages in one column. |
static java.lang.String |
PAGE_LAYOUT_SINGLE_PAGE
Display one page at a time. |
static java.lang.String |
PAGE_LAYOUT_TWO_COLUMN_LEFT
Display the pages in two columns, with odd numbered pagse on the left. |
static java.lang.String |
PAGE_LAYOUT_TWO_COLUMN_RIGHT
Display the pages in two columns, with odd numbered pagse on the right. |
static java.lang.String |
PAGE_LAYOUT_TWO_PAGE_LEFT
Display the pages two at a time, with odd-numbered pages on the left. |
static java.lang.String |
PAGE_LAYOUT_TWO_PAGE_RIGHT
Display the pages two at a time, with odd-numbered pages on the right. |
static java.lang.String |
PAGE_MODE_FULL_SCREEN
Full screen mode with no menu bar, window controls. |
static java.lang.String |
PAGE_MODE_USE_ATTACHMENTS
Attachments panel is visible. |
static java.lang.String |
PAGE_MODE_USE_NONE
Page mode where neither the outline nor the thumbnails are displayed. |
static java.lang.String |
PAGE_MODE_USE_OPTIONAL_CONTENT
Optional content group panel is visible when opened. |
static java.lang.String |
PAGE_MODE_USE_OUTLINES
Show bookmarks when pdf is opened. |
static java.lang.String |
PAGE_MODE_USE_THUMBS
Show thumbnails when pdf is opened. |
Constructor Summary | |
---|---|
PDDocumentCatalog(PDDocument doc)
Constructor. |
|
PDDocumentCatalog(PDDocument doc,
COSDictionary rootDictionary)
Constructor. |
Method Summary | |
---|---|
PDAcroForm |
getAcroForm()
This will get the documents acroform. |
PDDocumentCatalogAdditionalActions |
getActions()
|
java.util.List |
getAllPages()
The PDF document contains a hierarchical structure of PDPageNode and PDPages, which is mostly just a way to store this information. |
COSDictionary |
getCOSDictionary()
Convert this standard java object to a COS object. |
COSBase |
getCOSObject()
Convert this standard java object to a COS object. |
PDDocumentOutline |
getDocumentOutline()
Get the outline associated with this document or null if it does not exist. |
java.lang.String |
getLanguage()
The language for the document. |
PDMarkInfo |
getMarkInfo()
Get info about doc's usage of tagged features. |
PDMetadata |
getMetadata()
Get the metadata that is part of the document catalog. |
PDDocumentNameDictionary |
getNames()
|
PDOptionalContentProperties |
getOCProperties()
Get the optional content properties dictionary associated with this document. |
PDDestinationOrAction |
getOpenAction()
Get the Document Open Action for this object. |
PDPageLabels |
getPageLabels()
Returns the page labels descriptor of the document. |
java.lang.String |
getPageLayout()
Set the page layout, see the PAGE_LAYOUT_XXX constants. |
java.lang.String |
getPageMode()
Set the page display mode, see the PAGE_MODE_XXX constants. |
PDPageNode |
getPages()
This will get the root node for the pages. |
PDStructureTreeRoot |
getStructureTreeRoot()
Get the document's structure tree root. |
java.util.List |
getThreads()
Get the list threads for this pdf document. |
PDURIDictionary |
getURI()
Document level information in the URI. |
java.lang.String |
getVersion()
Returns the PDF specification version this document conforms to. |
PDViewerPreferences |
getViewerPreferences()
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 |
setActions(PDDocumentCatalogAdditionalActions actions)
Set the additional actions for the document. |
void |
setDocumentOutline(PDDocumentOutline outlines)
Set the document outlines. |
void |
setLanguage(java.lang.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 |
setPageLabels(PDPageLabels labels)
Set the page label descriptor for the document. |
void |
setPageLayout(java.lang.String layout)
Set the page layout. |
void |
setPageMode(java.lang.String mode)
Set the page mode. |
void |
setStructureTreeRoot(PDStructureTreeRoot treeRoot)
Set the document's structure tree root. |
void |
setThreads(java.util.List threads)
Set the list of threads for this pdf document. |
void |
setURI(PDURIDictionary uri)
Set the document level uri. |
void |
setVersion(java.lang.String version)
Sets the PDF specification version this document conforms to. |
void |
setViewerPreferences(PDViewerPreferences prefs)
Set the viewer preferences. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String PAGE_MODE_USE_NONE
public static final java.lang.String PAGE_MODE_USE_OUTLINES
public static final java.lang.String PAGE_MODE_USE_THUMBS
public static final java.lang.String PAGE_MODE_FULL_SCREEN
public static final java.lang.String PAGE_MODE_USE_OPTIONAL_CONTENT
public static final java.lang.String PAGE_MODE_USE_ATTACHMENTS
public static final java.lang.String PAGE_LAYOUT_SINGLE_PAGE
public static final java.lang.String PAGE_LAYOUT_ONE_COLUMN
public static final java.lang.String PAGE_LAYOUT_TWO_COLUMN_LEFT
public static final java.lang.String PAGE_LAYOUT_TWO_COLUMN_RIGHT
public static final java.lang.String PAGE_LAYOUT_TWO_PAGE_LEFT
public static final java.lang.String PAGE_LAYOUT_TWO_PAGE_RIGHT
Constructor Detail |
---|
public PDDocumentCatalog(PDDocument doc)
doc
- The document that this catalog is part of.public PDDocumentCatalog(PDDocument doc, COSDictionary rootDictionary)
doc
- The document that this catalog is part of.rootDictionary
- The root dictionary that this object wraps.Method Detail |
---|
public COSBase getCOSObject()
getCOSObject
in interface COSObjectable
public COSDictionary getCOSDictionary()
public PDAcroForm getAcroForm()
public void setAcroForm(PDAcroForm acro)
acro
- The new acro form.public PDPageNode getPages()
public java.util.List getAllPages()
public PDViewerPreferences getViewerPreferences()
public void setViewerPreferences(PDViewerPreferences prefs)
prefs
- The new viewer preferences.public PDDocumentOutline getDocumentOutline()
public void setDocumentOutline(PDDocumentOutline outlines)
outlines
- The new document outlines.public java.util.List getThreads()
public void setThreads(java.util.List threads)
threads
- The list of threads, or null to clear it.public PDMetadata getMetadata()
public void setMetadata(PDMetadata meta)
meta
- The meta data for this object.public void setOpenAction(PDDestinationOrAction action)
action
- The action you want to perform.public PDDestinationOrAction getOpenAction() throws java.io.IOException
java.io.IOException
- If there is an error creating the destination
or action.public PDDocumentCatalogAdditionalActions getActions()
public void setActions(PDDocumentCatalogAdditionalActions actions)
actions
- The actions that are associated with this document.public PDDocumentNameDictionary getNames()
public void setNames(PDDocumentNameDictionary names)
names
- The names dictionary that is associated with this document.public PDMarkInfo getMarkInfo()
public void setMarkInfo(PDMarkInfo markInfo)
markInfo
- The new MarkInfo data.public java.lang.String getPageMode()
public void setPageMode(java.lang.String mode)
mode
- The new page mode.public java.lang.String getPageLayout()
public void setPageLayout(java.lang.String layout)
layout
- The new page layout.public PDURIDictionary getURI()
public void setURI(PDURIDictionary uri)
uri
- The new document level uri.public PDStructureTreeRoot getStructureTreeRoot()
public void setStructureTreeRoot(PDStructureTreeRoot treeRoot)
treeRoot
- The new structure tree.public java.lang.String getLanguage()
public void setLanguage(java.lang.String language)
language
- The new document language.public java.lang.String getVersion()
public void setVersion(java.lang.String version)
version
- the PDF version (ex. "1.4")public PDPageLabels getPageLabels() throws java.io.IOException
java.io.IOException
- If there is a problem retrieving the page labels.public void setPageLabels(PDPageLabels labels)
labels
- the new page label descriptor to set.public PDOptionalContentProperties getOCProperties()
public void setOCProperties(PDOptionalContentProperties ocProperties)
ocProperties
- the optional properties dictionary
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |