Class PdfStructureElement

All Implemented Interfaces:
IPdfStructureElement, Serializable

public class PdfStructureElement extends PdfDictionary implements IPdfStructureElement
This is a node in a document logical structure. It may contain a mark point or it may contain other nodes.
See Also:
  • Field Details

  • Constructor Details

    • 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
    • PdfStructureElement

      protected PdfStructureElement(PdfDictionary parent, PdfName structureType, AccessibleElementId elementId)
  • Method Details

    • getStructureType

      public PdfName getStructureType()
    • init

      private void init(PdfDictionary parent, PdfName structureType)
    • getParent

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

      public PdfDictionary getParent(boolean includeStructTreeRoot)
    • setPageMark

      void setPageMark(int page, int mark)
    • setAnnotation

      void setAnnotation(PdfAnnotation annot, PdfIndirectReference currentPage)
    • 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
    • getAttribute

      public PdfObject getAttribute(PdfName name)
      Gets the first entarance of attribute.
      Specified by:
      getAttribute in interface IPdfStructureElement
      Since:
      5.3.4
    • setAttribute

      public void setAttribute(PdfName name, PdfObject obj)
      Sets the attribute value.
      Specified by:
      setAttribute in interface IPdfStructureElement
      Since:
      5.3.4
    • writeAttributes

      public void writeAttributes(IAccessibleElement element)
    • writeAttributes

      private void writeAttributes(Chunk chunk)
    • writeAttributes

      private void writeAttributes(Image image)
    • writeAttributes

      private void writeAttributes(PdfTemplate template)
    • writeAttributes

      private void writeAttributes(Paragraph paragraph)
    • writeAttributes

      private void writeAttributes(List list)
    • writeAttributes

      private void writeAttributes(ListItem listItem)
    • writeAttributes

      private void writeAttributes(ListBody listBody)
    • writeAttributes

      private void writeAttributes(ListLabel listLabel)
    • writeAttributes

      private void writeAttributes(PdfPTable table)
    • writeAttributes

      private void writeAttributes(PdfPRow row)
    • writeAttributes

      private void writeAttributes(PdfPCell cell)
    • writeAttributes

      private void writeAttributes(PdfPHeaderCell headerCell)
    • writeAttributes

      private void writeAttributes(PdfPTableHeader header)
    • writeAttributes

      private void writeAttributes(PdfPTableBody body)
    • writeAttributes

      private void writeAttributes(PdfPTableFooter footer)
    • writeAttributes

      private void writeAttributes(PdfDiv div)
    • writeAttributes

      private void writeAttributes(Document document)
    • colorsEqual

      private boolean colorsEqual(PdfArray parentColor, float[] color)
    • setColorAttribute

      private void setColorAttribute(BaseColor newColor, PdfObject oldColor, PdfName attributeName)
    • setTextAlignAttribute

      private void setTextAlignAttribute(int elementAlign)
    • toPdf

      public void toPdf(PdfWriter writer, OutputStream os) throws 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:
      IOException
    • getParentAttribute

      private PdfObject getParentAttribute(IPdfStructureElement parent, PdfName name)
    • setStructureTreeRoot

      protected void setStructureTreeRoot(PdfStructureTreeRoot root)
    • setStructureElementParent

      protected void setStructureElementParent(PdfStructureElement parent)
    • getElementId

      protected AccessibleElementId getElementId()