Class PDDocumentOutline
java.lang.Object
org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper
org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDDocumentOutline
- All Implemented Interfaces:
COSObjectable
This represents an outline in a pdf document.
-
Constructor Summary
ConstructorsConstructorDescriptionDefault Constructor.Constructor for an existing document outline. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Close this node.boolean
void
openNode()
This will set this node to be open when it is shown in the viewer.Methods inherited from class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
addFirst, addLast, children, getFirstChild, getLastChild, getOpenCount, getOutlineItem, getParent, hasChildren, requireSingleNode, setFirstChild, setLastChild, setOpenCount, setParent, updateParentOpenCount, updateParentOpenCountForAddedChild
Methods inherited from class org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper
equals, getCOSObject, hashCode
-
Constructor Details
-
PDDocumentOutline
public PDDocumentOutline()Default Constructor. -
PDDocumentOutline
Constructor for an existing document outline.- Parameters:
dic
- The storage dictionary.
-
-
Method Details
-
isNodeOpen
public boolean isNodeOpen()- Overrides:
isNodeOpen
in classPDOutlineNode
- Returns:
- true if this node count is greater than zero, false otherwise.
-
openNode
public void openNode()Description copied from class:PDOutlineNode
This will set this node to be open when it is shown in the viewer. By default, when a new node is created it will be closed. This will do nothing if the node is already open.- Overrides:
openNode
in classPDOutlineNode
-
closeNode
public void closeNode()Description copied from class:PDOutlineNode
Close this node.- Overrides:
closeNode
in classPDOutlineNode
-