Class StructureObject

java.lang.Object
com.itextpdf.text.pdf.mc.StructureItem
com.itextpdf.text.pdf.mc.StructureObject

public class StructureObject extends StructureItem
A StructureItem that refers to an object from an OBJR dictionary.
  • Field Details

    • structElem

      protected PdfDictionary structElem
      The structure element of which the properties are stored.
    • ref

      protected PdfIndirectReference ref
      The reference of the structure element of which the properties are stored.
    • obj

      protected PdfObject obj
      An object referred to by an OBJR dictionary.
    • objref

      protected PdfIndirectReference objref
      The reference to the object.
    • structParent

      protected int structParent
      The StructParent value of the object.
  • Constructor Details

  • Method Details

    • getStructElem

      public PdfDictionary getStructElem()
      Returns the structure element.
      Returns:
      a StructElem dictionary
    • getRef

      public PdfIndirectReference getRef()
      Returns the structure element's reference.
      Returns:
      an indirect reference to a StructElem dictionary
    • getObjAsDict

      public PdfDictionary getObjAsDict()
      Returns the object referred to by the OBJR dictionary. Note that this method returns a dictionary which means that in case the object is a stream, only the stream dictionary will be returned.
      Returns:
      the object referred to by OBJR as a dictionary
    • getObjRef

      public PdfIndirectReference getObjRef()
      Returns the reference to the object.
      Returns:
      an object reference
    • checkStructParent

      public int checkStructParent(int pg, int sp)
      Checks if a StructParent corresponds with the StructParent stored in the object.
      Overrides:
      checkStructParent in class StructureItem
      Parameters:
      pg - the page reference that needs to be checked
      sp - the structParent that needs to be checked
      Returns:
      1 in case the StructParent matches, -1 in case there's no match.
    • toString

      public String toString()
      Creates a String representation of the object.
      Overrides:
      toString in class Object
      See Also: