Class IndexEvents

java.lang.Object
com.lowagie.text.pdf.PdfPageEventHelper
com.lowagie.text.pdf.events.IndexEvents
All Implemented Interfaces:
PdfPageEvent

public class IndexEvents extends PdfPageEventHelper
Class for an index.
  • Field Details

    • indextag

      private Map<String,Integer> indextag
      keeps the indextag with the pagenumber
    • indexcounter

      private long indexcounter
      indexcounter
    • indexentry

      private List<IndexEvents.Entry> indexentry
      the list for the index entry
    • comparator

      private Comparator<IndexEvents.Entry> comparator
      Comparator for sorting the index
  • Constructor Details

    • IndexEvents

      public IndexEvents()
  • Method Details

    • onGenericTag

      public void onGenericTag(PdfWriter writer, Document document, Rectangle rect, String text)
      All the text that is passed to this event, gets registered in the indexentry.
      Specified by:
      onGenericTag in interface PdfPageEvent
      Overrides:
      onGenericTag in class PdfPageEventHelper
      Parameters:
      writer - the PdfWriter for this document
      document - the document
      rect - the Rectangle containing the Chunk
      text - the text of the tag
      See Also:
    • create

      public Chunk create(String text, String in1, String in2, String in3)
      Create an index entry.
      Parameters:
      text - The text for the Chunk.
      in1 - The first level.
      in2 - The second level.
      in3 - The third level.
      Returns:
      Returns the Chunk.
    • create

      public Chunk create(String text, String in1)
      Create an index entry.
      Parameters:
      text - The text for the Chunk.
      in1 - The first level.
      Returns:
      Returns the Chunk.
    • create

      public Chunk create(String text, String in1, String in2)
      Create an index entry.
      Parameters:
      text - The text for the Chunk.
      in1 - The first level.
      in2 - The second level.
      Returns:
      Returns the Chunk.
    • create

      public void create(Chunk text, String in1, String in2, String in3)
      Create an index entry.
      Parameters:
      text - The text.
      in1 - The first level.
      in2 - The second level.
      in3 - The third level.
    • create

      public void create(Chunk text, String in1)
      Create an index entry.
      Parameters:
      text - The text.
      in1 - The first level.
    • create

      public void create(Chunk text, String in1, String in2)
      Create an index entry.
      Parameters:
      text - The text.
      in1 - The first level.
      in2 - The second level.
    • setComparator

      public void setComparator(Comparator<IndexEvents.Entry> aComparator)
      Set the comparator.
      Parameters:
      aComparator - The comparator to set.
    • getSortedEntries

      public List<IndexEvents.Entry> getSortedEntries()
      Returns the sorted list with the entries and the collected page numbers.
      Returns:
      Returns the sorted list with the entries and the collected page numbers.