Package com.itextpdf.text.pdf.events
Class IndexEvents
- java.lang.Object
-
- com.itextpdf.text.pdf.PdfPageEventHelper
-
- com.itextpdf.text.pdf.events.IndexEvents
-
- All Implemented Interfaces:
PdfPageEvent
public class IndexEvents extends PdfPageEventHelper
Class for an index.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
IndexEvents.Entry
Class for an index entry.
-
Field Summary
Fields Modifier and Type Field Description private java.util.Comparator<IndexEvents.Entry>
comparator
Comparator for sorting the indexprivate long
indexcounter
indexcounterprivate java.util.List<IndexEvents.Entry>
indexentry
the list for the index entryprivate java.util.Map<java.lang.String,java.lang.Integer>
indextag
keeps the indextag with the pagenumber
-
Constructor Summary
Constructors Constructor Description IndexEvents()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
create(Chunk text, java.lang.String in1)
Create an index entry.void
create(Chunk text, java.lang.String in1, java.lang.String in2)
Create an index entry.void
create(Chunk text, java.lang.String in1, java.lang.String in2, java.lang.String in3)
Create an index entry.Chunk
create(java.lang.String text, java.lang.String in1)
Create an index entry.Chunk
create(java.lang.String text, java.lang.String in1, java.lang.String in2)
Create an index entry.Chunk
create(java.lang.String text, java.lang.String in1, java.lang.String in2, java.lang.String in3)
Create an index entry.java.util.List<IndexEvents.Entry>
getSortedEntries()
Returns the sorted list with the entries and the collected page numbers.void
onGenericTag(PdfWriter writer, Document document, Rectangle rect, java.lang.String text)
All the text that is passed to this event, gets registered in the indexentry.void
setComparator(java.util.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
-
-
-
-
Field Detail
-
indextag
private java.util.Map<java.lang.String,java.lang.Integer> indextag
keeps the indextag with the pagenumber
-
indexcounter
private long indexcounter
indexcounter
-
indexentry
private java.util.List<IndexEvents.Entry> indexentry
the list for the index entry
-
comparator
private java.util.Comparator<IndexEvents.Entry> comparator
Comparator for sorting the index
-
-
Method Detail
-
onGenericTag
public void onGenericTag(PdfWriter writer, Document document, Rectangle rect, java.lang.String text)
All the text that is passed to this event, gets registered in the indexentry.- Specified by:
onGenericTag
in interfacePdfPageEvent
- Overrides:
onGenericTag
in classPdfPageEventHelper
- Parameters:
writer
- thePdfWriter
for this documentdocument
- the documentrect
- theRectangle
containing theChunk
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(java.lang.String text, java.lang.String in1, java.lang.String in2, java.lang.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(java.lang.String text, java.lang.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(java.lang.String text, java.lang.String in1, java.lang.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, java.lang.String in1, java.lang.String in2, java.lang.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, java.lang.String in1)
Create an index entry.- Parameters:
text
- The text.in1
- The first level.
-
create
public void create(Chunk text, java.lang.String in1, java.lang.String in2)
Create an index entry.- Parameters:
text
- The text.in1
- The first level.in2
- The second level.
-
setComparator
public void setComparator(java.util.Comparator<IndexEvents.Entry> aComparator)
Set the comparator.- Parameters:
aComparator
- The comparator to set.
-
getSortedEntries
public java.util.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.
-
-