|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectorg.pdfbox.pdmodel.PDDocumentCatalog
This class represents the acroform of a PDF document.
| Constructor Summary | |
PDDocumentCatalog(PDDocument doc)
Constructor. |
|
PDDocumentCatalog(PDDocument doc,
COSDictionary rootDictionary)
Constructor. |
|
| Method Summary | |
PDAcroForm |
getAcroForm()
This will get the documents acroform. |
PDDocumentCatalogAdditionalActions |
getActions()
|
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. |
PDMetadata |
getMetadata()
Get the metadata that is part of the document catalog. |
PDDocumentNameDictionary |
getNames()
|
PDAction |
getOpenAction()
Get the Document Open Action for this object. |
PDPageNode |
getPages()
This will get the root node for the pages. |
List |
getThreads()
Get the list threads for this pdf document. |
PDViewerPreferences |
getViewerPreferences()
Get the viewer preferences associated with this document or null if they do not exist. |
void |
setActions(PDDocumentCatalogAdditionalActions actions)
Set the additional actions for the document. |
void |
setDocumentOutline(PDDocumentOutline outlines)
Set the document outlines. |
void |
setMetadata(PDMetadata meta)
Set the metadata for this object. |
void |
setNames(PDDocumentNameDictionary names)
Set the names dictionary for the document. |
void |
setOpenAction(PDAction action)
Set the Document Open Action for this object. |
void |
setThreads(List threads)
Set the list of threads for this pdf document. |
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 |
| 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 COSObjectablepublic COSDictionary getCOSDictionary()
public PDAcroForm getAcroForm()
public PDPageNode getPages()
public 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 List getThreads()
public void setThreads(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(PDAction action)
action - The action you want to perform.public PDAction getOpenAction()
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.
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||