TestXSLFTable.java
/* ====================================================================
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
==================================================================== */
package org.apache.poi.xslf.usermodel;
import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertInstanceOf;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertSame;
import static org.junit.jupiter.api.Assertions.assertTrue;
import java.awt.Color;
import java.awt.Dimension;
import java.awt.Graphics2D;
import java.awt.Rectangle;
import java.awt.geom.Rectangle2D;
import java.awt.image.BufferedImage;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.List;
import org.apache.poi.sl.draw.DrawTableShape;
import org.apache.poi.sl.usermodel.*;
import org.apache.poi.sl.usermodel.TableCell.BorderEdge;
import org.apache.poi.util.RandomSingleton;
import org.apache.poi.util.TempFile;
import org.apache.poi.xslf.XSLFTestDataSamples;
import org.apache.poi.xslf.util.PPTX2PNG;
import org.junit.jupiter.api.Test;
import org.openxmlformats.schemas.drawingml.x2006.main.CTTableCell;
import org.openxmlformats.schemas.presentationml.x2006.main.CTGraphicalObjectFrame;
class TestXSLFTable {
@Test
void testResize() throws Exception {
String[][] data = getDummyData(20);
final int maxHeight = 400;
XMLSlideShow ppt = new XMLSlideShow();
int rowIdx=1;
XSLFSlide slide = ppt.createSlide();
// a red bordered box in the background, to show/verify the table dimensions
XSLFAutoShape as = slide.createAutoShape();
as.setShapeType(ShapeType.RECT);
as.setStrokeStyle(Color.RED, 2., StrokeStyle.LineDash.LG_DASH);
XSLFTable tab = slide.createTable(1, data[0].length);
tab.setAnchor(new Rectangle2D.Double(50,50,0,0));
tab.setColumnWidth(0, 60);
tab.setColumnWidth(1, 60);
tab.setColumnWidth(2, 60);
tab.insertColumn(0);
assertEquals(tab.getColumnWidth(1), tab.getColumnWidth(0), 0.00001);
assertNotNull(tab.getCell(0, 0).getTextBody());
tab.addColumn();
XSLFTableCell cell = tab.getCell(0, data[0].length + 1);
assertEquals(1, cell.getTextBody().getParagraphs().size());
assertEquals("", cell.getTextBody().getParagraph(0).getText());
assertEquals(tab.getColumnWidth(tab.getNumberOfColumns() - 2), tab.getColumnWidth(tab.getNumberOfColumns() - 1), 0.00001);
assertNotNull(tab.getCell(0, tab.getNumberOfColumns() - 1).getTextBody());
tab.removeColumn(0);
tab.removeColumn(tab.getNumberOfColumns() - 1);
assertEquals(data[0].length, tab.getNumberOfColumns());
assertNull(tab.getTableStyle());
int startRow = rowIdx-1;
XSLFTableRow row = tab.getRows().get(0);
for (int colIdx=0; colIdx<data[0].length; colIdx++) {
XSLFTextRun tr = row.getCells().get(colIdx).setText(data[0][colIdx]);
tr.setFontSize(20.);
tr.setFontFamily("Arial");
}
while (rowIdx<data.length) {
row = tab.addRow();
for (int col=0; col<data[rowIdx].length; col++) {
XSLFTextRun tr = row.addCell().setText(data[rowIdx][col]);
tr.setFontSize(15.);
tr.setFontFamily("Arial");
}
row = tab.insertRow(rowIdx);
for (int col=0; col<data[rowIdx].length; col++) {
XSLFTextRun tr = tab
.getCell(rowIdx, col)
.setText(data[rowIdx][col]);
tr.setFontSize(12.);
tr.setFontFamily("Arial");
}
tab.updateCellAnchor();
if (tab.getAnchor().getHeight() > maxHeight) {
tab.removeRow(rowIdx-startRow);
break;
}
rowIdx += 2;
}
as.setAnchor(tab.getAnchor());
File fileOut = TempFile.createTempFile("tabtest", ".pptx");
try (FileOutputStream fos = new FileOutputStream(fileOut)) {
ppt.write(fos);
}
String[] args = {
"-format", "null", // png,gif,jpg or null for test
"-slide", "-1", // -1 for all
"-outdir", fileOut.getParentFile().getCanonicalPath(),
"-quiet",
fileOut.getAbsolutePath()
};
PPTX2PNG.main(args);
}
private static String[][] getDummyData(int rows) {
String[] header = { "Row#", "ID", "Name", "Description", "Price", "Percent", "Current Value" };
String[][] data = new String[rows+1][header.length];
System.arraycopy(header, 0, data[0], 0, header.length);
String[] names = { "car", "rubber duckie", "phone", "gadget" };
String[] desc = { "new", "used", "untouched" };
for (int row=1; row<=rows; row++) {
String[] line = new String[header.length];
line[0] = Integer.toString(row);
line[1] = Integer.toString(RandomSingleton.getInstance().nextInt(1000));
line[2] = names[RandomSingleton.getInstance().nextInt(names.length)];
line[3] = "The "+desc[RandomSingleton.getInstance().nextInt(desc.length)]+" "+line[2]+" in "+(2017+row);
line[4] = "$"+RandomSingleton.getInstance().nextInt(50000);
line[5] = RandomSingleton.getInstance().nextInt(100)+"%";
line[6] = "$"+RandomSingleton.getInstance().nextInt(50000);
System.arraycopy(line, 0, data[row], 0, header.length);
}
return data;
}
@Test
void testRead() throws IOException {
XMLSlideShow ppt = XSLFTestDataSamples.openSampleDocument("shapes.pptx");
XSLFSlide slide = ppt.getSlides().get(3);
List<XSLFShape> shapes = slide.getShapes();
assertEquals(1, shapes.size());
assertInstanceOf(XSLFTable.class, shapes.get(0));
XSLFTable tbl = (XSLFTable)shapes.get(0);
assertEquals(3, tbl.getNumberOfColumns());
assertEquals(6, tbl.getNumberOfRows());
assertNotNull(tbl.getCTTable());
List<XSLFTableRow> rows = tbl.getRows();
assertEquals(6, rows.size());
assertEquals(90.0, tbl.getColumnWidth(0), 0);
assertEquals(240.0, tbl.getColumnWidth(1), 0);
assertEquals(150.0, tbl.getColumnWidth(2), 0);
assertNotNull(tbl.getTableStyle());
for(XSLFTableRow row : tbl){
// all rows have the same height
assertEquals(29.2, row.getHeight(), 0);
}
XSLFTableRow row0 = rows.get(0);
List<XSLFTableCell> cells0 = row0.getCells();
assertEquals(3, cells0.size());
assertEquals("header1", cells0.get(0).getText());
assertEquals("header2", cells0.get(1).getText());
assertEquals("header3", cells0.get(2).getText());
XSLFTableRow row1 = rows.get(1);
List<XSLFTableCell> cells1 = row1.getCells();
assertEquals(3, cells1.size());
assertEquals("A1", cells1.get(0).getText());
assertEquals("B1", cells1.get(1).getText());
assertEquals("C1", cells1.get(2).getText());
ppt.close();
}
@Test
void testCreate() throws IOException {
XMLSlideShow ppt1 = new XMLSlideShow();
XSLFSlide slide = ppt1.createSlide();
XSLFTable tbl = slide.createTable();
assertNotNull(tbl.getCTTable());
assertNotNull(tbl.getCTTable().getTblGrid());
assertNotNull(tbl.getCTTable().getTblPr());
assertInstanceOf(CTGraphicalObjectFrame.class, tbl.getXmlObject());
assertEquals("Table 2", tbl.getShapeName());
assertEquals(2, tbl.getShapeId());
assertEquals(0, tbl.getRows().size());
assertEquals(0, tbl.getCTTable().sizeOfTrArray());
assertEquals(0, tbl.getCTTable().getTblGrid().sizeOfGridColArray());
assertEquals(0, tbl.getNumberOfColumns());
assertEquals(0, tbl.getNumberOfRows());
assertNull(tbl.getTableStyle());
XSLFTableRow row0 = tbl.addRow();
assertNotNull(row0.getXmlObject());
assertEquals(1, tbl.getNumberOfRows());
assertSame(row0, tbl.getRows().get(0));
assertEquals(20.0, row0.getHeight(), 0);
row0.setHeight(30.0);
assertEquals(30.0, row0.getHeight(), 0);
assertEquals(0, row0.getCells().size());
XSLFTableCell cell0 = row0.addCell();
assertNotNull(cell0.getXmlObject());
// by default table cell has no borders
CTTableCell tc = (CTTableCell)cell0.getXmlObject();
assertTrue(tc.getTcPr().getLnB().isSetNoFill());
assertTrue(tc.getTcPr().getLnT().isSetNoFill());
assertTrue(tc.getTcPr().getLnL().isSetNoFill());
assertTrue(tc.getTcPr().getLnR().isSetNoFill());
assertSame(cell0, row0.getCells().get(0));
assertEquals(1, tbl.getNumberOfColumns());
assertEquals(100.0, tbl.getColumnWidth(0), 0);
cell0.addNewTextParagraph().addNewTextRun().setText("POI");
assertEquals("POI", cell0.getText());
XSLFTableCell cell1 = row0.addCell();
assertSame(cell1, row0.getCells().get(1));
assertEquals(2, tbl.getNumberOfColumns());
assertEquals(100.0, tbl.getColumnWidth(1), 0);
cell1.addNewTextParagraph().addNewTextRun().setText("Apache");
assertEquals("Apache", cell1.getText());
for (BorderEdge edge : BorderEdge.values()) {
assertNull(cell1.getBorderWidth(edge));
cell1.setBorderWidth(edge, 2.0);
assertEquals(2.0, cell1.getBorderWidth(edge), 0);
assertNull(cell1.getBorderColor(edge));
cell1.setBorderColor(edge, Color.yellow);
assertEquals(Color.yellow, cell1.getBorderColor(edge));
}
assertEquals(VerticalAlignment.TOP, cell1.getVerticalAlignment());
cell1.setVerticalAlignment(VerticalAlignment.MIDDLE);
assertEquals(VerticalAlignment.MIDDLE, cell1.getVerticalAlignment());
cell1.setVerticalAlignment(null);
assertEquals(VerticalAlignment.TOP, cell1.getVerticalAlignment());
XMLSlideShow ppt2 = XSLFTestDataSamples.writeOutAndReadBack(ppt1);
ppt1.close();
slide = ppt2.getSlides().get(0);
tbl = (XSLFTable)slide.getShapes().get(0);
assertEquals(2, tbl.getNumberOfColumns());
assertEquals(1, tbl.getNumberOfRows());
assertEquals("POI", tbl.getCell(0, 0).getText());
assertEquals("Apache", tbl.getCell(0, 1).getText());
ppt2.close();
}
@Test
void removeTable() throws IOException {
XMLSlideShow ss = XSLFTestDataSamples.openSampleDocument("shapes.pptx");
XSLFSlide sl = ss.getSlides().get(0);
XSLFTable tab = (XSLFTable)sl.getShapes().get(4);
assertNotNull(tab.getTableStyle());
sl.removeShape(tab);
XMLSlideShow ss2 = XSLFTestDataSamples.writeOutAndReadBack(ss);
ss.close();
sl = ss2.getSlides().get(0);
for (XSLFShape s : sl.getShapes()) {
assertFalse(s instanceof XSLFTable);
}
ss2.close();
}
@Test
void checkTextHeight() throws IOException {
// from bug 59686
XMLSlideShow ppt = new XMLSlideShow();
XSLFSlide sl = ppt.createSlide();
XSLFTable tab = sl.createTable();
tab.setAnchor(new Rectangle2D.Double(50,50,300,50));
XSLFTableRow tr = tab.addRow();
XSLFTableCell tc0 = tr.addCell();
tc0.setText("bla bla bla bla");
tab.setColumnWidth(0, 50);
assertNull(tab.getTableStyle());
// usually text height == 88, but font rendering is platform dependent
// so we use something more reliable
assertTrue(tc0.getTextHeight() > 50);
assertEquals(0, tc0.getLineWidth(), 0);
ppt.close();
}
@Test
void checkNullPointerException() throws IOException {
String file = "au.asn.aes.www_conferences_2011_presentations_Fri_20Room4Level4_20930_20Maloney.pptx";
try (XMLSlideShow ss = XSLFTestDataSamples.openSampleDocument(file)) {
Dimension pgsize = ss.getPageSize();
for (Slide<?, ?> s : ss.getSlides()) {
BufferedImage img = new BufferedImage(pgsize.width, pgsize.height, BufferedImage.TYPE_INT_ARGB);
Graphics2D graphics = img.createGraphics();
// draw stuff
assertDoesNotThrow(() -> s.draw(graphics));
graphics.dispose();
img.flush();
}
}
}
@Test
void simpleMerge() throws IOException {
// github-221
try (XMLSlideShow slideshow = new XMLSlideShow()) {
XSLFSlide slide = slideshow.createSlide();
XSLFTable newTable = slide.createTable(3, 3);
newTable.setAnchor(new Rectangle(100, 100, 100, 100));
XSLFTableRow tableRow = newTable.addRow();
assertEquals(0, tableRow.getCells().size());
XSLFTableCell cell = tableRow.addCell();
XSLFTextParagraph textparagraph = cell.addNewTextParagraph();
XSLFTextRun textrun = textparagraph.addNewTextRun();
textrun.setText("Any Text");
textrun.setFontColor(Color.BLUE);
textparagraph.setTextAlign(TextParagraph.TextAlign.CENTER);
tableRow.addCell();
tableRow.addCell();
tableRow.mergeCells(0, 1);
new DrawTableShape(newTable).setAllBorders(3., StrokeStyle.LineDash.LG_DASH_DOT, Color.BLUE);
assertEquals(3, newTable.getCTTable().getTblGrid().sizeOfGridColArray());
assertNull(newTable.getTableStyle());
}
}
private void verifyTableCellStyleColors(XSLFTableCell cell, String text, Color fontColor, Color fillColor) {
assertEquals(text, cell.getText());
PaintStyle colorText1 = cell.getTextParagraphs().get(0).getTextRuns().get(0).getFontColor();
assertInstanceOf(PaintStyle.SolidPaint.class, colorText1);
assertEquals(fontColor, ((PaintStyle.SolidPaint)colorText1).getSolidColor().getColor());
assertEquals(fillColor, cell.getFillColor());
}
@Test
void testTableCellStyle() throws IOException {
XMLSlideShow ppt = XSLFTestDataSamples.openSampleDocument("table-with-different-font-colors.pptx");
// First slide: test row-related table styles
List<XSLFShape> shapes = ppt.getSlides().get(0).getShapes();
assertEquals(1, shapes.size());
assertInstanceOf(XSLFTable.class, shapes.get(0));
XSLFTable tbl = (XSLFTable)shapes.get(0);
assertEquals(4, tbl.getNumberOfColumns());
assertEquals(4, tbl.getNumberOfRows());
assertNotNull(tbl.getCTTable());
assertNotNull(tbl.getTableStyle());
// Yellow font color due to "first row" table style
verifyTableCellStyleColors(tbl.getRows().get(0).getCells().get(0), "Text 1",
new Color(255, 255, 0), new Color(21, 96, 130));
// Dark green font color due to direct format
verifyTableCellStyleColors(tbl.getRows().get(0).getCells().get(2), "Text 3",
new Color(0, 176, 80), new Color(21, 96, 130));
// Grey font color due to "even row" table style + fallback
verifyTableCellStyleColors(tbl.getRows().get(1).getCells().get(0), "Text 5",
new Color(119, 119, 119), new Color(204, 210, 216));
// Light blue font color due to "odd row" table style
verifyTableCellStyleColors(tbl.getRows().get(2).getCells().get(0), "Text 9",
new Color(0, 255, 255), new Color(231, 234, 237));
// Red font color due to direct format
verifyTableCellStyleColors(tbl.getRows().get(2).getCells().get(2), "Text 11",
new Color(255, 0, 0), new Color(231, 234, 237));
// Blue font color due to "last row" table style
verifyTableCellStyleColors(tbl.getRows().get(3).getCells().get(0), "Text 13",
new Color(0, 0, 255), new Color(21, 96, 130));
// Second slide: test column-related table styles
shapes = ppt.getSlides().get(1).getShapes();
assertEquals(1, shapes.size());
assertInstanceOf(XSLFTable.class, shapes.get(0));
tbl = (XSLFTable)shapes.get(0);
assertEquals(4, tbl.getNumberOfColumns());
assertEquals(4, tbl.getNumberOfRows());
assertNotNull(tbl.getCTTable());
assertNotNull(tbl.getTableStyle());
// Green font color due to "first column" table style
verifyTableCellStyleColors(tbl.getRows().get(0).getCells().get(0), "Text 1",
new Color(0, 255, 0), new Color(21, 96, 130));
// Grey font color due to "even column" table style + fallback
verifyTableCellStyleColors(tbl.getRows().get(0).getCells().get(1), "Text 2",
new Color(119, 119, 119), new Color(204, 210, 216));
// Light blue font color due to "odd column" table style
verifyTableCellStyleColors(tbl.getRows().get(0).getCells().get(2), "Text 3",
new Color(0, 255, 255), new Color(231, 234, 237));
// Red font color due to "last column" table style
verifyTableCellStyleColors(tbl.getRows().get(0).getCells().get(3), "Text 4",
new Color(255, 0, 0), new Color(21, 96, 130));
ppt.close();
}
}