Struts 2 and iText PDF Report Integration Example
In this tutorial, we have integrated the Struts 2 and iText to generated the PDF report. iText is an open source and widely used with Java to create the PDF report. It provides the classes they help to generate the report.
In our example, we have simply created the PDF report using static values.
Similar Post- Struts 2 + iText + MySQL Dynamic PDF Report Example
Software Used
In our example, we have used the below software/jars.
- Eclipse IDE
- Tomcat 8
- JDK 8
Required Dependencies
You can directly add all core JARs of struts2.x.x and iText5.x.x in your application or add below to your pom.xml if your application maven based.
pom.xml
<dependencies>
<dependency>
<groupId>org.apache.struts</groupId>
<artifactId>struts2-core</artifactId>
<version>2.3.16</version>
</dependency>
<dependency>
<groupId>com.itextpdf</groupId>
<artifactId>itextpdf</artifactId>
<version>5.0.6</version>
</dependency>
</dependencies>Project Structure in Eclipse
Add Struts 2 Filter
Define the struts 2 filters in web.xml.
web.xml
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
id="WebApp_ID" version="2.5">
<display-name>Struts2iTextPdfReportExamaple</display-name>
<welcome-file-list>
<welcome-file>report.jsp</welcome-file>
</welcome-file-list>
<filter>
<filter-name>struts2</filter-name>
<filter-class>org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>struts2</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
</web-app>Action Class
Create an action class.
ReportAction.java
package org.websparrow;
import java.io.FileInputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.struts2.ServletActionContext;
import org.apache.struts2.interceptor.ServletRequestAware;
import org.apache.struts2.interceptor.ServletResponseAware;
import com.itextpdf.text.BaseColor;
import com.itextpdf.text.Document;
import com.itextpdf.text.Element;
import com.itextpdf.text.Font;
import com.itextpdf.text.FontFactory;
import com.itextpdf.text.Image;
import com.itextpdf.text.PageSize;
import com.itextpdf.text.Paragraph;
import com.itextpdf.text.Phrase;
import com.itextpdf.text.Rectangle;
import com.itextpdf.text.pdf.PdfPCell;
import com.itextpdf.text.pdf.PdfPTable;
import com.itextpdf.text.pdf.PdfReader;
import com.itextpdf.text.pdf.PdfStamper;
import com.opensymphony.xwork2.ActionSupport;
public class ReportAction extends ActionSupport implements ServletRequestAware, ServletResponseAware {
private static final long serialVersionUID = -1517087746057956540L;
private HttpServletRequest request;
private HttpServletResponse response;
@Override
public String execute() throws Exception {
try {
// Creating document and set the page size
Document document = new Document(PageSize.A4, 20, 20, 20, 20);
String imagePath = ServletActionContext.getServletContext().getRealPath("/assets");
PdfWriter writer = PdfWriter.getInstance(document, new FileOutputStream(imagePath + "/temp1" + ".pdf"));
document.open();
// Add image on the document
Image image = Image.getInstance(imagePath + "/ws.jpg");
image.scaleToFit(90f, 90f);
image.setAlignment(Image.MIDDLE);
image.setAbsolutePosition(70, 770);
image.scaleAbsolute(100, 40);
document.add(image);
// Creating the paragraph and add it to document
Paragraph p1 = new Paragraph(" WebSparrow Technologies ",
FontFactory.getFont(FontFactory.HELVETICA, 14, Font.BOLD, new BaseColor(0, 0, 0)));
Paragraph p2 = new Paragraph("Employee Attendance Report",
FontFactory.getFont(FontFactory.HELVETICA, 10, Font.UNDERLINE, new BaseColor(0, 0, 0)));
Paragraph p3 = new Paragraph("\n\n\n");
p1.setAlignment(Element.ALIGN_CENTER);
p2.setAlignment(Element.ALIGN_CENTER);
document.add(p1);
document.add(p2);
document.add(p3);
// Create table and set the width of columns
PdfPTable t = new PdfPTable(9);
float widths[] = { 3, 6, 3, 3, 4, 3, 3, 3, 3 };
t.setWidths(widths);
t.setHeaderRows(1);
t.setTotalWidth(100f);
// Add table header row
PdfPCell c1 = new PdfPCell(new Phrase("Emp Id", FontFactory.getFont(FontFactory.HELVETICA, 8)));
c1.setBorderWidth((float) 0.25);
c1.setBackgroundColor(new BaseColor(232, 232, 232));
c1.setHorizontalAlignment(Element.ALIGN_CENTER);
c1.setVerticalAlignment(Element.ALIGN_MIDDLE);
t.addCell(c1);
c1 = new PdfPCell(new Phrase("Emp Name", FontFactory.getFont(FontFactory.HELVETICA, 8)));
c1.setBorderWidth(0.25f);
c1.setBackgroundColor(new BaseColor(232, 232, 232));
c1.setHorizontalAlignment(Element.ALIGN_CENTER);
c1.setVerticalAlignment(Element.ALIGN_MIDDLE);
t.addCell(c1);
c1 = new PdfPCell(new Phrase("Monday", FontFactory.getFont(FontFactory.HELVETICA, 8)));
c1.setBorderWidth(0.25f);
c1.setBackgroundColor(new BaseColor(232, 232, 232));
c1.setHorizontalAlignment(Element.ALIGN_CENTER);
c1.setVerticalAlignment(Element.ALIGN_MIDDLE);
t.addCell(c1);
c1 = new PdfPCell(new Phrase("Tuesday", FontFactory.getFont(FontFactory.HELVETICA, 8)));
c1.setBorderWidth(0.25f);
c1.setBackgroundColor(new BaseColor(232, 232, 232));
c1.setHorizontalAlignment(Element.ALIGN_CENTER);
c1.setVerticalAlignment(Element.ALIGN_MIDDLE);
t.addCell(c1);
c1 = new PdfPCell(new Phrase("Wednesday", FontFactory.getFont(FontFactory.HELVETICA, 8)));
c1.setBorderWidth((float) 0.25);
c1.setBackgroundColor(new BaseColor(232, 232, 232));
c1.setHorizontalAlignment(Element.ALIGN_CENTER);
c1.setVerticalAlignment(Element.ALIGN_MIDDLE);
t.addCell(c1);
c1 = new PdfPCell(new Phrase("Thursday", FontFactory.getFont(FontFactory.HELVETICA, 8)));
c1.setBorderWidth(0.25f);
c1.setBackgroundColor(new BaseColor(232, 232, 232));
c1.setHorizontalAlignment(Element.ALIGN_CENTER);
c1.setVerticalAlignment(Element.ALIGN_MIDDLE);
t.addCell(c1);
c1 = new PdfPCell(new Phrase("Friday", FontFactory.getFont(FontFactory.HELVETICA, 8)));
c1.setBorderWidth(0.25f);
c1.setBackgroundColor(new BaseColor(232, 232, 232));
c1.setHorizontalAlignment(Element.ALIGN_CENTER);
c1.setVerticalAlignment(Element.ALIGN_MIDDLE);
t.addCell(c1);
c1 = new PdfPCell(new Phrase("Saturday", FontFactory.getFont(FontFactory.HELVETICA, 8)));
c1.setBorderWidth(0.25f);
c1.setBackgroundColor(new BaseColor(232, 232, 232));
c1.setHorizontalAlignment(Element.ALIGN_CENTER);
c1.setVerticalAlignment(Element.ALIGN_MIDDLE);
t.addCell(c1);
c1 = new PdfPCell(new Phrase("Sunday", FontFactory.getFont(FontFactory.HELVETICA, 8)));
c1.setBorderWidth(0.25f);
c1.setBackgroundColor(new BaseColor(232, 232, 232));
c1.setHorizontalAlignment(Element.ALIGN_CENTER);
c1.setVerticalAlignment(Element.ALIGN_MIDDLE);
t.addCell(c1);
// Add the table details row
Phrase ph;
c1 = new PdfPCell();
c1.setBorderWidth((float) 0.25);
c1.setHorizontalAlignment(Element.ALIGN_CENTER);
ph = new Phrase("1", FontFactory.getFont(FontFactory.HELVETICA, 8));
c1.addElement(ph);
t.addCell(c1);
c1 = new PdfPCell();
c1.setBorderWidth((float) 0.25);
c1.setHorizontalAlignment(Element.ALIGN_CENTER);
ph = new Phrase("Sandeep Sharma", FontFactory.getFont(FontFactory.HELVETICA, 8));
c1.addElement(ph);
t.addCell(c1);
c1 = new PdfPCell();
c1.setBorderWidth((float) 0.25);
c1.setHorizontalAlignment(Element.ALIGN_CENTER);
ph = new Phrase("P", FontFactory.getFont(FontFactory.HELVETICA, 8));
c1.addElement(ph);
t.addCell(c1);
c1 = new PdfPCell();
c1.setBorderWidth((float) 0.25);
c1.setHorizontalAlignment(Element.ALIGN_CENTER);
ph = new Phrase("P", FontFactory.getFont(FontFactory.HELVETICA, 8));
c1.addElement(ph);
t.addCell(c1);
c1 = new PdfPCell();
c1.setBorderWidth((float) 0.25);
c1.setHorizontalAlignment(Element.ALIGN_CENTER);
ph = new Phrase("A", FontFactory.getFont(FontFactory.HELVETICA, 8));
c1.addElement(ph);
t.addCell(c1);
c1 = new PdfPCell();
c1.setBorderWidth((float) 0.25);
c1.setHorizontalAlignment(Element.ALIGN_CENTER);
ph = new Phrase("P", FontFactory.getFont(FontFactory.HELVETICA, 8));
c1.addElement(ph);
t.addCell(c1);
c1 = new PdfPCell();
c1.setBorderWidth((float) 0.25);
c1.setHorizontalAlignment(Element.ALIGN_CENTER);
ph = new Phrase("P", FontFactory.getFont(FontFactory.HELVETICA, 8));
c1.addElement(ph);
t.addCell(c1);
c1 = new PdfPCell();
c1.setBorderWidth((float) 0.25);
c1.setHorizontalAlignment(Element.ALIGN_CENTER);
ph = new Phrase("OFF", FontFactory.getFont(FontFactory.HELVETICA, 8));
c1.addElement(ph);
t.addCell(c1);
c1 = new PdfPCell();
c1.setBorderWidth((float) 0.25);
c1.setHorizontalAlignment(Element.ALIGN_CENTER);
ph = new Phrase("OFF", FontFactory.getFont(FontFactory.HELVETICA, 8));
c1.addElement(ph);
t.addCell(c1);
// Finally add all into the document
response.setHeader("Content-disposition", "inline; filename=\"Employee Attendance.pdf\"");
document.add(t);
document.close();
addPageNumber("temp1.pdf", "newName.pdf", response, request);
} catch (Exception e) {
e.printStackTrace();
}
return null;
}
// Method for adding page number on the document
public static void addPageNumber(String oldFileName, String newFileName, HttpServletResponse response,
HttpServletRequest request) {
try {
String realPath = ServletActionContext.getServletContext().getRealPath("/assets");
FileInputStream fis = new FileInputStream(realPath + "/" + "temp1.pdf");
PdfReader reader = new PdfReader(fis);
int totalPages = reader.getNumberOfPages();
PdfStamper stamper = new PdfStamper(reader, response.getOutputStream());
for (int i = 1; i <= totalPages; i++) {
getHeaderTable(i, totalPages).writeSelectedRows(0, -1, 34, 30, stamper.getOverContent(i));
}
stamper.close();
fis.close();
} catch (Exception e) {
e.printStackTrace();
}
}
public static PdfPTable getHeaderTable(int x, int y) {
PdfPTable table = new PdfPTable(2);
try {
table.setTotalWidth(490);
table.setLockedWidth(true);
table.getDefaultCell().setFixedHeight(20);
table.getDefaultCell().setBorder(Rectangle.NO_BORDER);
PdfPCell cell = new PdfPCell(new com.itextpdf.text.Phrase((""),
new com.itextpdf.text.Font(com.itextpdf.text.Font.FontFamily.HELVETICA, 5)));
cell.setBorder(Rectangle.NO_BORDER);
table.addCell(cell);
table.getDefaultCell().setHorizontalAlignment(Element.ALIGN_RIGHT);
table.getDefaultCell().setBorder(Rectangle.NO_BORDER);
cell = new PdfPCell(new com.itextpdf.text.Phrase(String.format("Page %d of %d", x, y),
new com.itextpdf.text.Font(com.itextpdf.text.Font.FontFamily.HELVETICA, 5)));
cell.setBorder(Rectangle.NO_BORDER);
cell.setHorizontalAlignment(Element.ALIGN_RIGHT);
table.addCell(cell);
} catch (Exception e) {
System.out.println("getHeaderTable exception" + e.getMessage());
e.printStackTrace();
}
return table;
}
@Override
public void setServletRequest(HttpServletRequest request) {
this.request = request;
}
public HttpServletRequest getServletRequest() {
return request;
}
@Override
public void setServletResponse(HttpServletResponse response) {
this.response = response;
}
public HttpServletResponse getServletResponse() {
return response;
}
}JSP Pages
Create a JSP page to send the request to action class.
report.jsp
<%@ taglib prefix="s" uri="/struts-tags"%>
<html>
<head>
<title>Struts2 and iText pdf report Integration Example</title>
</head>
<body>
<h1>Struts2 and iText pdf report Integration Example</h1>
<s:form action="itextreport">
<s:submit value="Generate Report"></s:submit>
</s:form>
</body>
</html>Map Action Class in Struts.xml
Map the action class in the struts.xml and do not configure the result.
struts.xml
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE struts PUBLIC
"-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"
"http://struts.apache.org/dtds/struts-2.0.dtd">
<struts>
<constant name="struts.devMode" value="true" />
<package name="default" namespace="/" extends="struts-default">
<action name="itextreport" class="org.websparrow.ReportAction">
</action>
</package>
</struts>Output :
Now everything is all set. Start your server and deploy the project.
Screen 1
Screen 2
Download Source Code – struts2-and-itext-pdf-report-integration-example.zip
Similar Posts
About the Author
