Class TagReference

    • Constructor Detail

      • TagReference

        protected TagReference​(PdfStructElem referencedTag,
                               TagTreePointer tagPointer,
                               int insertIndex)
        Creates a TagReference instance which represents a reference to PdfStructElem.
        Parameters:
        referencedTag - a structure element to which marked content will link (if insertIndex is -1, otherwise to MC will link to kid with insertIndex of passed structure element)
        tagPointer - the tag pointer to structure element
        insertIndex - if insertIndex is -1, the referencedTag will be used as a source of reference, otherwise the kid will be used
    • Method Detail

      • getRole

        public PdfName getRole()
        Gets role of structure element.
        Returns:
        the role of structure element
      • createNextMcid

        public int createNextMcid()
        Creates next marked content identifier, which will be used to mark content in PDF stream.
        Returns:
        the marked content identifier
      • addProperty

        public TagReference addProperty​(PdfName name,
                                        PdfObject value)
        Adds property, which will be associated with marked-content sequence.
        Parameters:
        name - the name of the property
        value - the value of the property
        Returns:
        the TagReference instance
      • removeProperty

        public TagReference removeProperty​(PdfName name)
        Removes property. The property will not be associated with marked-content sequence.
        Parameters:
        name - the name of property to be deleted
        Returns:
        the TagReference instance
      • getProperty

        public PdfObject getProperty​(PdfName name)
        Gets property which related to specified name.
        Parameters:
        name - the name of the property
        Returns:
        the value of the property
      • getProperties

        public PdfDictionary getProperties()
        Gets properties, which will be associated with marked-content sequence as PdfDictionary.
        Returns:
        the properties