com.itextpdf.text.pdf.events
Class IndexEvents

java.lang.Object
  extended by com.itextpdf.text.pdf.PdfPageEventHelper
      extended by com.itextpdf.text.pdf.events.IndexEvents
All Implemented Interfaces:
PdfPageEvent

public class IndexEvents
extends PdfPageEventHelper

Class for an index.

Author:
Michael Niedermair

Nested Class Summary
 class IndexEvents.Entry
          Class for an index entry.
 
Field Summary
private  Comparator<IndexEvents.Entry> comparator
          Comparator for sorting the index
private  long indexcounter
          indexcounter
private  List<IndexEvents.Entry> indexentry
          the list for the index entry
private  Map<String,Integer> indextag
          keeps the indextag with the pagenumber
 
Constructor Summary
IndexEvents()
           
 
Method Summary
 void create(Chunk text, String in1)
          Create an index entry.
 void create(Chunk text, String in1, String in2)
          Create an index entry.
 void create(Chunk text, String in1, String in2, String in3)
          Create an index entry.
 Chunk create(String text, String in1)
          Create an index entry.
 Chunk create(String text, String in1, String in2)
          Create an index entry.
 Chunk create(String text, String in1, String in2, String in3)
          Create an index entry.
 List<IndexEvents.Entry> getSortedEntries()
          Returns the sorted list with the entries and the collected page numbers.
 void onGenericTag(PdfWriter writer, Document document, Rectangle rect, String text)
          All the text that is passed to this event, gets registered in the indexentry.
 void setComparator(Comparator<IndexEvents.Entry> aComparator)
          Set the comparator.
 
Methods inherited from class com.itextpdf.text.pdf.PdfPageEventHelper
onChapter, onChapterEnd, onCloseDocument, onEndPage, onOpenDocument, onParagraph, onParagraphEnd, onSection, onSectionEnd, onStartPage
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

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 Detail

IndexEvents

public IndexEvents()
Method Detail

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:
PdfPageEventHelper.onGenericTag( com.itextpdf.text.pdf.PdfWriter, com.itextpdf.text.Document, com.itextpdf.text.Rectangle, java.lang.String)

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.

Hosted by Hostbasket