Add Tables to PDF in Java
Aspose.PDF for Java provides a rich Table API for building tables with layout and content customization.
Create a basic table
Use this example when you need to add a simple table with uniform borders and text cells.
- Create a new PDF Document and add a page.
- Create a Table and configure its borders.
- Add rows and cells, attach the table to the page, and save the document.
public static void createTable(Path outputFile) {
try (Document document = new Document()) {
Page page = document.getPages().add();
Table table = new Table();
table.setBorder(new BorderInfo(BorderSide.All, 5, Color.getLightGray()));
table.setDefaultCellBorder(new BorderInfo(BorderSide.All, 5, Color.getLightGray()));
for (int rowCount = 0; rowCount < 10; rowCount++) {
Row row = table.getRows().add();
row.getCells().add("Column (" + rowCount + ", 1)");
row.getCells().add("Column (" + rowCount + ", 2)");
row.getCells().add("Column (" + rowCount + ", 3)");
}
page.getParagraphs().add(table);
document.save(outputFile.toString());
}
}
Add cells with row span and column span
Use this example when the table needs merged cells across rows or columns.
- Create a new PDF Document and add a page.
- Create a Table and add rows.
- Configure
ColSpanandRowSpanon the target cells, then save the PDF.
public static void addRowspanOrColspan(Path outputFile) {
try (Document document = new Document()) {
Page page = document.getPages().add();
Table table = new Table();
table.setBorder(new BorderInfo(BorderSide.All, 0.5f, Color.getBlack()));
table.setDefaultCellBorder(new BorderInfo(BorderSide.All, 0.5f, Color.getBlack()));
Row row1 = table.getRows().add();
for (int cellCount = 1; cellCount < 5; cellCount++) {
row1.getCells().add("Test 1" + cellCount);
}
Row row2 = table.getRows().add();
row2.getCells().add("Test 2 1");
Cell cell = row2.getCells().add("Test 2 2");
cell.setColSpan(2);
row2.getCells().add("Test 2 4");
Row row3 = table.getRows().add();
row3.getCells().add("Test 3 1");
row3.getCells().add("Test 3 2");
row3.getCells().add("Test 3 3");
row3.getCells().add("Test 3 4");
Row row4 = table.getRows().add();
row4.getCells().add("Test 4 1");
cell = row4.getCells().add("Test 4 2");
cell.setRowSpan(2);
row4.getCells().add("Test 4 3");
row4.getCells().add("Test 4 4");
Row row5 = table.getRows().add();
row5.getCells().add("Test 5 1");
row5.getCells().add("Test 5 3");
row5.getCells().add("Test 5 4");
page.getParagraphs().add(table);
document.save(outputFile.toString());
}
}
Add table borders and cell padding
Use this example when you need to configure borders, padding, and cell wrapping behavior.
- Create a new PDF Document and add a page.
- Create a Table and configure widths, borders, and padding.
- Add rows and save the resulting document.
public static void addBorders(Path outputFile) {
try (Document document = new Document()) {
Page page = document.getPages().add();
Table table = new Table();
page.getParagraphs().add(table);
table.setColumnWidths("50 50 50");
table.setDefaultCellBorder(new BorderInfo(BorderSide.All, 0.1f));
table.setBorder(new BorderInfo(BorderSide.All, 1));
table.setDefaultCellPadding(new MarginInfo(5, 5, 5, 5));
Row row1 = table.getRows().add();
row1.getCells().add("col1");
row1.getCells().add("col2");
row1.getCells().add();
row1.getCells().get_Item(2).getParagraphs().add(new TextFragment("col3 with large text string"));
row1.getCells().get_Item(2).setWordWrapped(false);
Row row2 = table.getRows().add();
row2.getCells().add("item1");
row2.getCells().add("item2");
row2.getCells().add("item3");
document.save(outputFile.toString());
}
}
Enable auto-fit table layout
Use this example when the table should automatically adjust to the available page width.
- Create a new PDF Document and add a page.
- Create a Table and set
ColumnAdjustment.AutoFitToWindow. - Add sample rows and save the PDF.
public static void autoFit(Path outputFile) {
try (Document document = new Document()) {
Page page = document.getPages().add();
Table table = new Table();
page.getParagraphs().add(table);
table.setColumnWidths("50 50 50");
table.setColumnAdjustment(ColumnAdjustment.AutoFitToWindow);
table.setDefaultCellBorder(new BorderInfo(BorderSide.All, 0.1f));
table.setBorder(new BorderInfo(BorderSide.All, 1));
table.setDefaultCellPadding(new MarginInfo(5, 5, 5, 5));
Row row1 = table.getRows().add();
row1.getCells().add("col1");
row1.getCells().add("col2");
row1.getCells().add("col3");
Row row2 = table.getRows().add();
row2.getCells().add("item1");
row2.getCells().add("item2");
row2.getCells().add("item3");
document.save(outputFile.toString());
}
}
Add an image inside a table cell
Use this example when the table needs to display raster image content inside one of its cells.
- Create a new PDF Document and add a page.
- Create a Table and add a row with text and image cells.
- Configure the Image size and save the document.
public static void addImage(Path imageFile, Path outputFile) {
try (Document document = new Document()) {
Page page = document.getPages().add();
Table table = new Table();
table.setColumnWidths("200 100");
Row row = table.getRows().add();
row.getCells().add().getParagraphs().add(new TextFragment(imageFile.toString()));
Image image = new Image();
image.setFile(imageFile.toString());
image.setFixWidth(50);
image.setFixHeight(50);
row.getCells().add().getParagraphs().add(image);
page.getParagraphs().add(table);
document.save(outputFile.toString());
}
}
Add SVG images inside table cells
Use this example when the table should render SVG files row by row.
- Create a new PDF Document and add a page.
- Create a Table and iterate through the SVG files.
- Add one row per image, configure the SVG Image, and save the PDF.
public static void addSvgImage(List<Path> imageFiles, Path outputFile) {
try (Document document = new Document()) {
Page page = document.getPages().add();
Table table = new Table();
table.setColumnWidths("200 100");
for (Path imageFile : imageFiles) {
Row row = table.getRows().add();
row.getCells().add().getParagraphs().add(new TextFragment(imageFile.toString()));
Image image = new Image();
image.setFileType(ImageFileType.Svg);
image.setFile(imageFile.toString());
image.setFixWidth(50);
image.setFixHeight(50);
row.getCells().add().getParagraphs().add(image);
}
page.getParagraphs().add(table);
document.save(outputFile.toString());
}
}
Add HTML fragments to table cells
Use this example when table content should include inline HTML formatting.
- Create a new PDF Document and add a page.
- Create a Table and configure borders.
- Add HtmlFragment objects to the cells and save the document.
public static void addHtmlFragments(Path outputFile) {
try (Document document = new Document()) {
Page page = document.getPages().add();
Table table = new Table();
table.setBorder(new BorderInfo(BorderSide.All, 0.5f, Color.getLightGray()));
table.setDefaultCellBorder(new BorderInfo(BorderSide.All, 0.5f, Color.getLightGray()));
for (int rowCount = 1; rowCount < 10; rowCount++) {
Row row = table.getRows().add();
row.getCells().add().getParagraphs().add(new HtmlFragment("Column <strong>(" + rowCount + ", 1)</strong>"));
row.getCells().add().getParagraphs().add(new HtmlFragment("Column <span style='color:red'>(" + rowCount + ", 2)</span>"));
row.getCells().add().getParagraphs().add(new HtmlFragment("Column <span style='text-decoration: underline'>(" + rowCount + ", 3)</span>"));
}
page.getParagraphs().add(table);
document.save(outputFile.toString());
}
}
Add LaTeX fragments to table cells
Use this example when table content should render TeX or LaTeX expressions.
- Create a new PDF Document and add a page.
- Create a Table with borders.
- Add TeXFragment objects to the cells and save the output file.
public static void addLatexFragments(Path outputFile) {
try (Document document = new Document()) {
Page page = document.getPages().add();
Table table = new Table();
table.setBorder(new BorderInfo(BorderSide.All, 0.5f, Color.getLightGray()));
table.setDefaultCellBorder(new BorderInfo(BorderSide.All, 0.5f, Color.getLightGray()));
for (int rowCount = 1; rowCount < 10; rowCount++) {
Row row = table.getRows().add();
row.getCells().add().getParagraphs().add(new TeXFragment("Column $\\mathbf{(" + rowCount + ", 1)}$"));
row.getCells().add().getParagraphs().add(new TeXFragment("Column $\\textcolor{red}{(" + rowCount + ", 2)}$"));
row.getCells().add().getParagraphs().add(new TeXFragment("Column $\\underline{(" + rowCount + ", 3)}$"));
}
page.getParagraphs().add(table);
document.save(outputFile.toString());
}
}
Force a table onto a new page
Use this example when a second table should start on a separate page after a large table.
- Create a new PDF Document and configure page settings.
- Build the first large Table and add it to the page.
- Create a second table, set
InNewPage, and save the document.
public static void addTableOnNewPage(Path outputFile) {
try (Document document = new Document()) {
document.getPageInfo().getMargin().setLeft(37);
document.getPageInfo().getMargin().setRight(37);
document.getPageInfo().getMargin().setTop(37);
document.getPageInfo().getMargin().setBottom(37);
document.getPageInfo().setLandscape(true);
Page page = document.getPages().add();
Table table = new Table();
table.setColumnWidths("50 100");
for (int i = 1; i < 121; i++) {
Row row = table.getRows().add();
row.setFixedRowHeight(15);
row.getCells().add().getParagraphs().add(new TextFragment("Content 1"));
row.getCells().add().getParagraphs().add(new TextFragment("Content 2"));
}
page.getParagraphs().add(table);
Table table1 = new Table();
table1.setColumnWidths("100 100");
for (int i = 1; i < 11; i++) {
Row row = table1.getRows().add();
row.getCells().add().getParagraphs().add(new TextFragment("Content 3"));
row.getCells().add().getParagraphs().add(new TextFragment("Content 4"));
}
table1.setInNewPage(true);
page.getParagraphs().add(table1);
document.save(outputFile.toString());
}
}
Build a vertically broken table with repeating columns
Use this example when a wide table should continue vertically and repeat key columns.
- Create a new PDF Document and add a page.
- Create a Table and configure vertical breaking with repeating columns.
- Add the header and data rows, then save the document.
public static void addTableHideBorders(Path outputFile) {
try (Document document = new Document()) {
Page page = document.getPages().add();
Table table = new Table();
table.setBroken(TableBroken.Vertical);
table.setDefaultCellBorder(new BorderInfo(BorderSide.All));
table.setRepeatingColumnsCount(2);
page.getParagraphs().add(table);
Row row = table.getRows().add();
Cell cell = row.getCells().add("header 1");
cell.setColSpan(2);
cell.setBackgroundColor(Color.getLightGray());
row.getCells().add("header 3");
Cell cell2 = row.getCells().add("header 4");
cell2.setColSpan(2);
cell2.setBackgroundColor(Color.getLightBlue());
row.getCells().add("header 6");
Cell cell3 = row.getCells().add("header 7");
cell3.setColSpan(2);
cell3.setBackgroundColor(Color.getLightGreen());
Cell cell4 = row.getCells().add("header 9");
cell4.setColSpan(3);
cell4.setBackgroundColor(Color.getLightCoral());
for (int i = 12; i < 18; i++) {
row.getCells().add("header " + i);
}
for (int rowCounter = 0; rowCounter < 3; rowCounter++) {
Row row1 = table.getRows().add();
for (int i = 1; i < 18; i++) {
row1.getCells().add("col " + rowCounter + ", " + i);
}
}
document.save(outputFile.toString());
}
}
Reuse the borders and padding example
Use this helper when the margins and padding scenario should delegate to the shared border example.
- Call the existing table border and padding method.
- Reuse the same table layout logic without duplicating code.
public static void addMarginsOrPadding(Path outputFile) {
addBorders(outputFile);
}
Create a table with rounded corners
Use this example when the table should use rounded corner styling instead of standard rectangular borders.
- Create a new PDF Document and add a page.
- Create a Table and configure rounded border settings.
- Add rows to the table and save the PDF.
public static void createTableWithRoundCorner(Path outputFile) {
try (Document document = new Document()) {
Page page = document.getPages().add();
Table table = new Table();
BorderInfo borderInfo = new BorderInfo(BorderSide.All);
borderInfo.setRoundedBorderRadius(15);
table.setCornerStyle(BorderCornerStyle.Round);
table.setBorder(borderInfo);
for (int rowCount = 0; rowCount < 10; rowCount++) {
Row row = table.getRows().add();
row.getCells().add("Column (" + rowCount + ", 1)");
row.getCells().add("Column (" + rowCount + ", 2)");
row.getCells().add("Column (" + rowCount + ", 3)");
}
page.getParagraphs().add(table);
document.save(outputFile.toString());
}
}
Add repeating header rows
Use this example when multi-page tables should repeat their header rows on every continuation page.
- Create a new PDF Document and add a page.
- Create a vertically broken Table and configure repeating row count and style.
- Add header rows and data rows, then save the document.
public static void addRepeatingRows(Path outputFile) {
try (Document document = new Document()) {
Page page = document.getPages().add();
Table table = new Table();
table.setBroken(TableBroken.Vertical);
table.setRepeatingRowsCount(2);
TextState textState = new TextState();
textState.setFontSize(12);
textState.setFont(FontRepository.findFont("TimesNewRoman"));
textState.setForegroundColor(Color.getRed());
table.setRepeatingRowsStyle(textState);
table.setColumnWidths("100 100 100");
table.setDefaultCellBorder(new BorderInfo(BorderSide.All, 0.5f, Color.getBlack()));
table.setBorder(new BorderInfo(BorderSide.All, 1, Color.getBlack()));
Row headerRow1 = table.getRows().add();
headerRow1.getCells().add("Header 1-1");
headerRow1.getCells().add("Header 1-2");
headerRow1.getCells().add("Header 1-3");
for (Cell cell : headerRow1.getCells()) {
cell.setBackgroundColor(Color.getLightGray());
}
Row headerRow2 = table.getRows().add();
headerRow2.getCells().add("Header 2-1");
headerRow2.getCells().add("Header 2-2");
headerRow2.getCells().add("Header 2-3");
for (Cell cell : headerRow2.getCells()) {
cell.setBackgroundColor(Color.getLightBlue());
}
for (int i = 1; i < 101; i++) {
Row row = table.getRows().add();
row.getCells().add("Data " + i + "-1");
row.getCells().add("Data " + i + "-2");
row.getCells().add("Data " + i + "-3");
}
page.getParagraphs().add(table);
document.save(outputFile.toString());
}
}
Add repeating columns in a wide table
Use this example when the first columns should repeat while the table breaks vertically on the same page.
- Create a new PDF Document and configure page size.
- Create a Table and set repeating columns plus auto-fit behavior.
- Add header and data rows, then save the PDF.
public static void addRepeatingColumns(Path outputFile) {
try (Document document = new Document()) {
Page page = document.getPages().add();
page.setPageSize(PageSize.getA5().getHeight(), PageSize.getA5().getWidth());
BorderInfo border = new BorderInfo(BorderSide.All, 0.5f, Color.getLightGray());
Table table = new Table();
table.setBroken(TableBroken.VerticalInSamePage);
table.setColumnAdjustment(ColumnAdjustment.AutoFitToContent);
table.setRepeatingColumnsCount(5);
table.setBorder(border);
table.setDefaultCellBorder(border);
page.getParagraphs().add(table);
Row row = table.getRows().add();
for (int i = 1; i < 6; i++) {
Cell cell = row.getCells().add("header " + i);
cell.setBackgroundColor(Color.getLightGray());
}
for (int i = 6; i < 18; i++) {
row.getCells().add("header " + i);
}
for (int rowCounter = 1; rowCounter < 6; rowCounter++) {
row = table.getRows().add();
for (int i = 1; i < 6; i++) {
Cell cell = row.getCells().add("cell " + rowCounter + "," + i);
cell.setBackgroundColor(Color.getLightGray());
}
for (int i = 6; i < 18; i++) {
row.getCells().add("cell " + rowCounter + "," + i);
}
}
document.save(outputFile.toString());
}
}
Insert page breaks between table rows
Use this example when specific table rows should begin on a new page.
- Create a new PDF Document and add a page.
- Create a Table and populate many rows.
- Mark selected rows with
InNewPageand save the document.
public static void insertPageBreak(Path outputFile) {
try (Document document = new Document()) {
Page page = document.getPages().add();
Table table = new Table();
table.setBorder(new BorderInfo(BorderSide.All, Color.getRed()));
table.setDefaultCellBorder(new BorderInfo(BorderSide.All, Color.getRed()));
table.setColumnWidths("100 100");
for (int counter = 0; counter < 201; counter++) {
Row row = new Row();
table.getRows().add(row);
row.getCells().add().getParagraphs().add(new TextFragment("Cell " + counter + ", 0"));
row.getCells().add().getParagraphs().add(new TextFragment("Cell " + counter + ", 1"));
if (counter % 10 == 0 && counter != 0) {
row.setInNewPage(true);
}
}
page.getParagraphs().add(table);
document.save(outputFile.toString());
}
}
Rotate text inside table cells
Use this example when cell text should be displayed at different rotation angles.
- Create a new PDF Document and add a page.
- Create a Table and add a row with multiple cells.
- Create rotated TextFragment objects, add them to the cells, and save the PDF.
public static void rotatedTextTable(Path outputFile) {
try (Document document = new Document()) {
Page page = document.getPages().add();
Table table = new Table();
table.setBorder(new BorderInfo(BorderSide.All, 0.5f, Color.getBlack()));
table.setDefaultCellBorder(new BorderInfo(BorderSide.All, 0.5f, Color.getBlack()));
Row row = table.getRows().add();
row.setMinRowHeight(200);
for (int cellCount = 0; cellCount < 4; cellCount++) {
Cell cell = row.getCells().add();
TextFragment textFragment = new TextFragment("Cell 1 " + (cellCount - 1));
textFragment.getTextState().setRotation(90 * cellCount);
textFragment.setHorizontalAlignment(HorizontalAlignment.Center);
cell.getParagraphs().add(textFragment);
}
page.getParagraphs().add(table);
document.save(outputFile.toString());
}
}