Package com.reportmill.pdf

Class PDFXTable

  • All Implemented Interfaces:
    RMArchiver.Archiving, java.lang.Cloneable
    public class PDFXTable
extends RMObject
    This class represents a cross reference table in a PDF file.

    • Constructor Summary

      Constructors 
      Constructor Description
      PDFXTable()
      Creates an empty xref table.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String addObject​(java.lang.Object anObj)
      Adds an object and returns the string by which the object can be referenced inside the pdf file.
      java.lang.String addObject​(java.lang.Object anObj, boolean definitelyIsNew)
      Adds an object and returns the string by which the object can be referenced inside the pdf file.
      java.lang.Object getEntry​(int anIndex)
      Returns the specific entry at the given index.
      int getEntryCount()
      Returns the number of entries in xref table.
      java.lang.String getRefString​(int index)
      Returns a reference string for the entry object at the given index.
      java.lang.String getRefString​(java.lang.Object anObj)
      Returns a reference string for the given entry object.
      java.lang.String getRefStringForName​(java.lang.String aName)
      Returns a reference string for the given entry object name.
      int indexOfEntry​(java.lang.Object obj)
      Returns the index of a given entry object.
      void setNameForObject​(java.lang.String aName, java.lang.Object anObj)
      Sets the name for a given entry object.

      • Methods inherited from class java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • PDFXTable

        public PDFXTable()
        Creates an empty xref table.

    • Method Detail

      • getEntryCount

        public int getEntryCount()
        Returns the number of entries in xref table.

      • getEntry

        public java.lang.Object getEntry​(int anIndex)
        Returns the specific entry at the given index.

      • addObject

        public java.lang.String addObject​(java.lang.Object anObj)
        Adds an object and returns the string by which the object can be referenced inside the pdf file.

      • addObject

        public java.lang.String addObject​(java.lang.Object anObj,
                                  boolean definitelyIsNew)
        Adds an object and returns the string by which the object can be referenced inside the pdf file.

      • indexOfEntry

        public int indexOfEntry​(java.lang.Object obj)
        Returns the index of a given entry object.

      • setNameForObject

        public void setNameForObject​(java.lang.String aName,
                             java.lang.Object anObj)
        Sets the name for a given entry object.

      • getRefString

        public java.lang.String getRefString​(int index)
                              throws RMException
        Returns a reference string for the entry object at the given index.
        Throws:
        RMException

      • getRefString

        public java.lang.String getRefString​(java.lang.Object anObj)
                              throws RMException
        Returns a reference string for the given entry object.
        Throws:
        RMException

      • getRefStringForName

        public java.lang.String getRefStringForName​(java.lang.String aName)
        Returns a reference string for the given entry object name.