How to create a TOC when merging documents?

Tags: merge documentsTOCtable of contentsconcatenateiText 7

I need to create a TOC (not bookmarks) at the beginning of this document with clickable links to the first pages of each of the source PDFs.

Document document = new Document();
PdfCopy copy = new PdfCopy(document, outputStream);
PdfCopy.PageStamp stamp;;
PdfReader reader;
List<InputStream> pdfs = streamOfPDFFiles;
List<PdfReader> readers = new ArrayList<PdfReader>();
Iterator<InputStream> iteratorPDFs = pdfs.iterator();
for (; iteratorPDFs.hasNext(); pdfCounter++) {
    InputStream pdf =;
    reader = new PdfReader(pdf);
int currentPageNumber = 0;
Iterator<PdfReader> readerIterator = readers.iterator();
PdfImportedPage page;
int count = 1;
while (readerIterator.hasNext()) {
    reader =;
    int number_of_pages = reader.getNumberOfPages();
    for (int pageNum = 0; pageNum < number_of_pages;) {
        page = copy.getImportedPage(reader, ++pageNum);
            Element.ALIGN_RIGHT, new Phrase(
                String.format("%d", currentPageNumber),
                new Font(FontFamily.TIMES_ROMAN,3)), 50, 50, 0);
Posted on StackOverflow on Feb 4, 2014 by Butani Vijay

You're asking for something that should be trivial, but that isn't. Please take a look at the MergeWithToc example. You'll see that your code to merge PDFs is correct, but in my example, I added one extra feature:

Text text = new Text(String.format("Page %d", pageNo));
entry.getValue().copyPagesTo(i, i, pdfDoc);
if (i == 1) {
    text.setDestination("p" + pageNo);
doc.add(new Paragraph(text).setFixedPosition(pageNo, 549, 810, 40));

For every first page, I define a named destination as a local destination. We use p followed by the page number as its name.

We'll use these named destinations in an extra page that will serve as a TOC:

PdfDocument tocDoc = new PdfDocument(new PdfReader(src3));
tocDoc.copyPagesTo(1, 1, pdfDoc);
float y = 770;
for (Map.Entry<Integer, String> entry : toc.entrySet()) {
    Paragraph p = new Paragraph();
    p.addTabStops(new TabStop(500, TabAlignment.LEFT, new DashedLine()));
    p.add(new Tab());
    p.setAction(PdfAction.createGoTo("p" + entry.getKey()));
    doc.add(p.setFixedPosition(pdfDoc.getNumberOfPages(), 36, y, 595 - 72));
    y -= 20;
for (PdfDocument srcDoc : filesToMerge.values()) {

In my example, I assume that the TOC fits on a single page. You'll have to keep track of the y value and create a new page if its value is lower than the bottom margin.

If you want the TOC to be the first page, you need to reorder the pages in a second go. This is shown in the MergeWithToc2 example.

Click this link if you want to see how to answer this question in iText 5.