Class PDStructureTreeRoot
java.lang.Object
org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode
org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureTreeRoot
- All Implemented Interfaces:
COSObjectable
A root of a structure tree.
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionDefault Constructor.Constructor for an existing structure element. -
Method Summary
Modifier and TypeMethodDescriptionReturns the ID tree.getK()
Returns the K entry.Deprecated.Returns the parent tree.int
Returns the next key in the parent tree.Returns the role map.void
setIDTree
(PDNameTreeNode<PDStructureElement> idTree) Sets the ID tree.void
Sets the K entry.void
setParentTree
(PDNumberTreeNode parentTree) Sets the parent tree.void
setParentTreeNextKey
(int parentTreeNextkey) Sets the next key in the parent tree.void
setRoleMap
(Map<String, String> roleMap) Sets the role map.Methods inherited from class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode
appendKid, appendKid, appendObjectableKid, create, createObject, getCOSObject, getKids, getType, insertBefore, insertBefore, insertObjectableBefore, removeKid, removeKid, removeObjectableKid, setKids
-
Field Details
-
LOG
private static final org.apache.commons.logging.Log LOGLog instance. -
TYPE
- See Also:
-
-
Constructor Details
-
PDStructureTreeRoot
public PDStructureTreeRoot()Default Constructor. -
PDStructureTreeRoot
Constructor for an existing structure element.- Parameters:
dic
- The existing dictionary.
-
-
Method Details
-
getKArray
Deprecated.usegetK()
only. /K can be a dictionary or an array, and the next level can also be a dictionary. See file 054080.pdf in PDFBOX-4417 and read "Entries in the structure tree root" in the PDF specification.Returns the K array entry.- Returns:
- the K array entry
-
getK
Returns the K entry. This can be a dictionary representing a structure element, or an array of them.- Returns:
- the K entry.
-
setK
Sets the K entry.- Parameters:
k
- the K value
-
getIDTree
Returns the ID tree.- Returns:
- the ID tree
-
setIDTree
Sets the ID tree.- Parameters:
idTree
- the ID tree
-
getParentTree
Returns the parent tree.- Returns:
- the parent tree
-
setParentTree
Sets the parent tree.- Parameters:
parentTree
- the parent tree
-
getParentTreeNextKey
public int getParentTreeNextKey()Returns the next key in the parent tree.- Returns:
- the next key in the parent tree
-
setParentTreeNextKey
public void setParentTreeNextKey(int parentTreeNextkey) Sets the next key in the parent tree.- Parameters:
parentTreeNextkey
- the next key in the parent tree.
-
getRoleMap
Returns the role map.- Returns:
- the role map
-
setRoleMap
Sets the role map.- Parameters:
roleMap
- the role map
-
getK()
only.