Package org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure

Class PDStructureTreeRoot

java.lang.Object
org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode
org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureTreeRoot
All Implemented Interfaces:
COSObjectable
public class PDStructureTreeRoot extends PDStructureNode
A root of a structure tree.

  • Field Details

    • LOG

      private static final org.apache.commons.logging.Log LOG
      Log instance.

    • TYPE

      private static final String TYPE
      See Also:

  • Constructor Details

    • PDStructureTreeRoot

      public PDStructureTreeRoot()
      Default Constructor.

    • PDStructureTreeRoot

      public PDStructureTreeRoot(COSDictionary dic)
      Constructor for an existing structure element.
      Parameters:
      dic - The existing dictionary.

  • Method Details

    • getK

      public COSBase getK()
      Returns the K entry. This can be a dictionary representing a structure element, or an array of them.
      Returns:
      the K entry.

    • setK

      public void setK(COSBase k)
      Sets the K entry.
      Parameters:
      k - the K value

    • getIDTree

      public PDNameTreeNode<PDStructureElement> getIDTree()
      Returns the ID tree.
      Returns:
      the ID tree

    • setIDTree

      public void setIDTree(PDNameTreeNode<PDStructureElement> idTree)
      Sets the ID tree.
      Parameters:
      idTree - the ID tree

    • getParentTree

      public PDNumberTreeNode getParentTree()
      Returns the parent tree.
      Returns:
      the parent tree

    • setParentTree

      public void setParentTree(PDNumberTreeNode parentTree)
      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

      public Map<String,Object> getRoleMap()
      Returns the role map.
      Returns:
      the role map

    • setRoleMap

      public void setRoleMap(Map<String,String> roleMap)
      Sets the role map.
      Parameters:
      roleMap - the role map

    • getClassMap

      public Map<String,Object> getClassMap()
      Sets the ClassMap.
      Returns:
      the ClassMap, never null. The elements are either PDAttributeObject or lists of it.

    • setClassMap

      public void setClassMap(Map<String,Object> classMap)
      Sets the ClassMap.
      Parameters:
      classMap - null, or a map whose elements are either PDAttributeObject or lists of it.