Class PDStructureTreeRoot

    • Field Detail

      • LOG

        private static final org.apache.commons.logging.Log LOG
        Log instance.
    • Constructor Detail

      • PDStructureTreeRoot

        public PDStructureTreeRoot()
        Default Constructor.
      • PDStructureTreeRoot

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

      • getKArray

        @Deprecated
        public COSArray getKArray()
        Deprecated.
        use getK() 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

        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
      • 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 java.util.Map<java.lang.String,​java.lang.Object> getRoleMap()
        Returns the role map.
        Returns:
        the role map
      • setRoleMap

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