Class StructureMCID


  • public class StructureMCID
    extends StructureItem
    Object that stores an item that is part of the document structure. It can refer to a marked-content sequence in a page or an object reference (in this case the subclass StructureObject is used).
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected int mcid
      The mcid of the structure element.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int checkMCID​(int pg, int mcid)
      Checks if the MCID in this object corresponds with the stored number
      java.lang.String toString()
      Creates a String representation of the object.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • mcid

        protected int mcid
        The mcid of the structure element.
    • Constructor Detail

      • StructureMCID

        public StructureMCID​(PdfIndirectReference pg,
                             PdfNumber mcid)
        Creates a StructureMCID using an MCID.
        Parameters:
        mcid - an MCID
      • StructureMCID

        public StructureMCID​(PdfDictionary mcr)
        Creates a StructurItem using an MCR dictionary.
        Parameters:
        mcr - an MCR dictionary
    • Method Detail

      • checkMCID

        public int checkMCID​(int pg,
                             int mcid)
        Checks if the MCID in this object corresponds with the stored number
        Overrides:
        checkMCID in class StructureItem
        Parameters:
        mcid - the MCID
        pg - the page reference that needs to be checked
        Returns:
        1 in case the MCIDs corresponds with obj, -1 in case the MCID doesn't correspond
      • toString

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