Class PdfStructureElement

    • Constructor Detail

      • PdfStructureElement

        public PdfStructureElement​(PdfStructureElement parent,
                                   PdfName structureType)
        Creates a new instance of PdfStructureElement.
        Parameters:
        parent - the parent of this node
        structureType - the type of structure. It may be a standard type or a user type mapped by the role map
      • PdfStructureElement

        public PdfStructureElement​(PdfStructureTreeRoot root,
                                   PdfName structureType)
        Creates a new instance of PdfStructureElement.
        Parameters:
        root - the parent of this node
        structureType - the type of structure. It may be a standard type or a user type mapped by the role map
    • Method Detail

      • getStructureType

        public PdfName getStructureType()
      • getParent

        public PdfDictionary getParent()
        Gets the parent of this node.
        Returns:
        the parent of this node
      • getParent

        public PdfDictionary getParent​(boolean includeStructTreeRoot)
      • getReference

        public PdfIndirectReference getReference()
        Gets the reference this object will be written to.
        Returns:
        the reference this object will be written to
        Since:
        2.1.6 method removed in 2.1.5, but restored in 2.1.6
      • toPdf

        public void toPdf​(PdfWriter writer,
                          java.io.OutputStream os)
                   throws java.io.IOException
        Description copied from class: PdfDictionary
        Writes the PDF representation of this PdfDictionary as an array of byte to the given OutputStream.
        Overrides:
        toPdf in class PdfDictionary
        Parameters:
        writer - for backwards compatibility
        os - the OutputStream to write the bytes to.
        Throws:
        java.io.IOException
      • setStructureElementParent

        protected void setStructureElementParent​(PdfStructureElement parent)