Skip to content

Latest commit

 

History

History
263 lines (201 loc) · 6.43 KB

README.md

File metadata and controls

263 lines (201 loc) · 6.43 KB

PDFBox Table Generator

Image of a sample pdf

##Usage First, A java Class is need to be created giving all the configurations.

A default table can be generated using the following code.

package org.wso2.analytics.is.common.pdf;
import org.pdfbox.exceptions.COSVisitorException;

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

public class PDFSample {
     public static void main(String[] args) throws IOException, COSVisitorException {
         File file = new File("pdfSample.pdf");
         if (!file.exists()) {
             file.createNewFile();
         }
         try(OutputStream os = new FileOutputStream(file)) {
             PDFGenerator pdfGenerator = new PDFGenerator();
             pdfGenerator.generatePDF(createPDF(), createContent(), null, null, os);
         }
     }
     private static PDFPageInfo createPDF() {
         PDFPageInfo pdf = new PDFPageInfo();
         return pdf;
     }
     private static Table createContent() {
         // Total size of columns must not be greater than table width.
         List<Column> columns = new ArrayList<Column>();
         columns.add(new Column("TimeStamp", 150 ));
         columns.add(new Column("Tenant Domain", 100 ));
         columns.add(new Column("User", 100 ));
         columns.add(new Column("Duration (ms)", 100 ));
         columns.add(new Column("Avg. Duration (ms)", 100 ));

         String[][] content = {
                 {"31/05/2013 07:15 am", "carbon.super", "User1", "319626.00", "26497.00"},
                 {"31/05/2013 07:15 am", "carbon.super", "User1", "319626.00", "26497.00"},
                 {"31/05/2013 07:15 am", "carbon.super", "User1", "319626.00", "26497.00"},
                 {"31/05/2013 07:15 am", "carbon.super", "User1", "319626.00", "26497.00"},
                 {"31/05/2013 07:15 am", "carbon.super", "User1", "319626.00", "26497.00"}
         };

         Table table = new Table();
         table.setColumns(columns);
         table.setContent(content);
         return table;
     }
 }

##Configure the PDF Template

Configurable Components are shown in the following image Image of the configurable Components of the pdf

1. Logo Image

2. Title

3. HeaderInfo

4. Table

5. Table Header

6. Table Body

7. PDF Page

8. Footer

###Logo Image Configurations

####setLogoCoordinates

void setLogoCoordinates(float[] logoCoordinates)

Changes the logo coordinates. This takes a float array that has the x, y coordinates of the logo.

####setLogoSize

void setLogoSize(float[] logoSize)

Changes the logo coordinates. This takes a float array that has the x, y coordinates of the logo.

###Title Configurations

####setTitle

void setTitle(String title)

Set the title.

####setTitleFont

void setTitleFont(PDFont titleFont)

Set the title font.

####setTitleFontSize

void setTitleFontSize(float titleFontSize)

Set the title font size.

####setTitleCoordinates

void setTitleCoordinates(float[] titleCoordinates)

Set the title Coordinates. This takes a size 2 array which takes the x, y coordinates

###Header Info Configurations

####setHeaderInfo

void setHeaderInfo(String[] headerInfo)

Set the header information that needs to be at the top of the page. This is a String array that contains the Strings per each line

####setHeaderInfoFont

void setHeaderInfoFont(PDFont headerInfoFont)

Set the header information font

####setHeaderInfoFontSize

void setHeaderInfoFontSize(float headerInfoFontSize)

Set the header information font size

####setHeaderCoordinates

void setHeaderCoordinates(float[] headerCoordinates)

Set the header coordinates. This is a float array that gives the x, y coordinates of the beggining of the header info.

###Table Configurations

####setTableTopY

void setTableTopY(float tableTopY)

Changes the table top Coordinate

###Table Header Configurations

####setTableHeaderFont

void setTableHeaderFont(PDFont tableHeaderFont)

Changes the text font of the table header.

####setTableHeaderFontSize

void setTableHeaderFontSize(float tableHeaderFontSize)

Changes the text font size of the table header.

####setTableHeaderBackgroundColor

void setTableHeaderBackgroundColor(int[] tableHeaderBackgroundColor)

Changes the background colour of the table header. This takes a integer array of size 3 which contains the RGB value of the color

###Table Body Configurations

####setTextFont

void setTextFont(PDFont textFont)

Changes the font of the Table body.

####setTableFontColor

void setTableFontColor(int[] tableFontColor)

Changes the font colour of the table body font. This takes a integer array of size 3 which contains the RGB value of the color

####setFontSize

void setFontSize(float fontSize)

Changes the font size of the Table body font.

####setTableBodyFillColor

void setTableBodyFillColor(int[] tableBodyFillColor)

Changes the body colour of the table body. This takes a Integer array of size 3 which contains the RGB value of the color

####setAlternativeRowColor

void setAlternativeRowColor(int[] alternativeRowColor)

Changes the body colour of the table body alternative rows. This takes a Integer array of size 3 which contains the RGB value of the color

####setRowHeight

void setRowHeight(float rowHeight)

Changes the row Height of the table.

####setCellMargin

void setCellMargin(float cellMargin)

Changes the size of the cell Margin of the table.

###PDF Page Configurations

####setPageSize

void setPageSize(PDRectangle pageSize)

Set the page Size

####setMargin

void setMargin(float margin)

Set the Margin of the page

###PDF Footer Configurations

####setFooterContent

void setFooterContent(String footerContent)

Set the Footer Content

####setFooterCoordinates

void setFooterCoordinates(float[] footerCoordinates)

Set the Coordinates of the Footer