Wednesday, August 17, 2011

How to create multi page pdf with footer in pdfBox


Hi guys,

In this blog i am going to show one of example that how to create a multiple pdf page in pdf document with the footer where you generating pdf using open source java library "pdfBox". That footer should contain document name in each page , current page number and total pages in document.

First declare some constant where you can have static font size , padding size of bottom of the document.Like below code snippet.

// Hold the report font size.
private final static float FONT_SIZE = 10f;

// Hold the initial x position.
private final static float X0 = 5f;

// Hold the padding bottom of the document.
private final static float PADDING_BOTTOM_OF_DOCUMENT = 30f;

Then create a method to create document object and add some pages to that .I have created a separate method for that.Its like below code snippet.

// create empty document.
doc = new PDDocument();
// create fist page.
PDPage page = new PDPage();
page.setMediaBox(PDPage.PAGE_SIZE_A4);
doc.addPage(page);

Then create a PDPageContentStream Object to set the page x and y cordinates , font size and type.And also should remember is , before you write any text to page , you have to call the beginText() off the PDPageContentStream object.Its like blow code snippet.

contentStream = new PDPageContentStream(doc, page);
contentStream.beginText();
contentStream.setFont(PDType1Font.HELVETICA_BOLD, FONT_SIZE);
contentStream.moveTextPositionByAmount(5, 800);

contentStream.drawString("Siva's Test page one");
contentStream.endText();
contentStream.close();

thats it .your done . now you can save the document by specifying the file name and the location to where to save by calling the document save() method.

doc.save(new FileOutputStream(new File("C://siva//SivaTestPDfWithMultiPage.pdf")));

you can see the full code in below.

thank and enjoy the programming !!!!!!!

package com.pdf.multipage;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.List;

import org.apache.pdfbox.exceptions.COSVisitorException;
import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.pdmodel.PDPage;
import org.apache.pdfbox.pdmodel.edit.PDPageContentStream;
import org.apache.pdfbox.pdmodel.font.PDType1Font;

/**
*
* @author sivakumaran Kathamuttu
*
*
*/
public class MultipagePdfWithFooter {

// Hold the report font size.
private final static float FONT_SIZE = 10f;

// Hold the initial x position.
private final static float X0 = 5f;

// Hold the padding bottom of the document.
private final static float PADDING_BOTTOM_OF_DOCUMENT = 30f;

/**
* This method for include the footer to the each page in pdf document.
*
* @param doc
* Set the pdf document.
* @param reportName
* Set the report name.
* @throws IOException
*/
@SuppressWarnings("rawtypes")
private void addReportFooter(final PDDocument doc, final String reportName) throws IOException {

PDPageContentStream footercontentStream = null;
try {

List pages = doc.getDocumentCatalog().getAllPages();

for (int i = 0; i < pages.size(); i++) {


PDPage page = ((PDPage) pages.get(i));
footercontentStream = new PDPageContentStream(doc, page, true, true);
footercontentStream.beginText();
footercontentStream.setFont(PDType1Font.HELVETICA_BOLD, FONT_SIZE);
footercontentStream.moveTextPositionByAmount(X0,
(PDPage.PAGE_SIZE_A4.getLowerLeftY() + PADDING_BOTTOM_OF_DOCUMENT));
footercontentStream.drawString(reportName);
footercontentStream.moveTextPositionByAmount((PDPage.PAGE_SIZE_A4.getUpperRightX() / 2),
(PDPage.PAGE_SIZE_A4.getLowerLeftY()));
footercontentStream.drawString((i + 1) + " - " + pages.size());
footercontentStream.endText();
footercontentStream.close();

}
} catch (final IOException exception) {
throw new RuntimeException(exception);
} finally {

if (footercontentStream != null) {
try {
footercontentStream.close();
} catch (final IOException exception) {
throw new RuntimeException(exception);
}

}
}

}

/**
* This method created a document with 2 pages.
*
* @return Document with consist of two pages.
* @throws IOException
*/
private PDDocument createDocumentWithMultiplePage() throws IOException {

PDPageContentStream contentStream = null;
PDPageContentStream contentStream1 = null;
PDDocument doc = null;

try {
// create empty document.
doc = new PDDocument();
// create fist page.
PDPage page = new PDPage();
page.setMediaBox(PDPage.PAGE_SIZE_A4);
doc.addPage(page);

contentStream = new PDPageContentStream(doc, page);
contentStream.beginText();
contentStream.setFont(PDType1Font.HELVETICA_BOLD, FONT_SIZE);
contentStream.moveTextPositionByAmount(5, 800);

contentStream.drawString("Siva's Test page one");
contentStream.endText();
contentStream.close();

// Create next page.
PDPage page1 = new PDPage();
page1.setMediaBox(PDPage.PAGE_SIZE_A4);
doc.addPage(page1);

contentStream1 = new PDPageContentStream(doc, page1);
contentStream1.setFont(PDType1Font.HELVETICA_BOLD, FONT_SIZE);
contentStream1.beginText();
contentStream1.moveTextPositionByAmount(5, 800);

contentStream1.drawString("Siva's Test page Two");
contentStream1.endText();
contentStream1.close();
} catch (final IOException exception) {
throw new RuntimeException(exception);
} finally {

if (contentStream != null) {
try {
contentStream.close();
} catch (final IOException exception) {
throw new RuntimeException(exception);
}

}
if (contentStream1 != null) {
try {
contentStream1.close();
} catch (final IOException exception) {
throw new RuntimeException(exception);
}

}
}

return doc;
}

/**
* Main method
*
* @param arg
* @throws IOException
* @throws COSVisitorException
*/
public static void main(String arg[]) throws IOException, COSVisitorException {

MultipagePdfWithFooter obj = new MultipagePdfWithFooter();
PDDocument doc = obj.createDocumentWithMultiplePage();

obj.addReportFooter(doc, "Siva's Multi page with footer Test Report");
doc.save(new FileOutputStream(new File("C://siva//SivaTestPDfWithMultiPage.pdf")));
}
}

2 comments:

  1. Hi Siva,

    Very good Stuff, Good Work.

    ReplyDelete
  2. Can you please provide a sample for creating pdf with text fields basically form fields.

    ReplyDelete