Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Return table start PDPage from drawer #115

Merged
merged 3 commits into from
Jan 30, 2021
Merged

Return table start PDPage from drawer #115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c4e62f6
Return table start PDPage from drawer
grass-hopper-moc Jan 25, 2021
62c93b0
Removed console messages
grass-hopper-moc Jan 25, 2021
dc590f4
Changes for TableDrawer from PR review
grass-hopper-moc Jan 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
114 changes: 48 additions & 66 deletions src/main/java/org/vandeseer/easytable/RepeatedHeaderTableDrawer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,51 +1,45 @@
package org.vandeseer.easytable;

import lombok.AccessLevel;
import lombok.Builder;
import lombok.Getter;
import lombok.experimental.SuperBuilder;
import java.awt.geom.Point2D;
import java.io.IOException;
import java.util.function.Supplier;

import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.pdmodel.PDPage;
import org.vandeseer.easytable.structure.Row;

import java.awt.geom.Point2D;
import java.io.IOException;
import java.util.Queue;
import java.util.function.Supplier;
import lombok.Builder;
import lombok.experimental.SuperBuilder;

@SuperBuilder
public class RepeatedHeaderTableDrawer extends TableDrawer {

@Builder.Default
private int numberOfRowsToRepeat = 1;

private Float headerHeight;

@Getter(value = AccessLevel.NONE)
private boolean startTableInNewPage;

@Override
protected void drawPage(PageData pageData) {
if (pageData.firstRowOnPage != 0) {
float adaption = 0;
for (int i = 0; i < numberOfRowsToRepeat; i++) {
adaption += table.getRows().get(i).getHeight();
Point2D.Float startPoint = new Point2D.Float(this.startX, this.startY + calculateHeightForFirstRows() - adaption);
drawRow(startPoint, table.getRows().get(i), i, (drawer, drawingContext) -> {
drawer.drawBackground(drawingContext);
drawer.drawContent(drawingContext);
drawer.drawBorders(drawingContext);
});
}
}

drawerList.forEach(drawer ->
drawWithFunction(pageData, new Point2D.Float(this.startX, this.startY), drawer)
);
}

@Builder.Default
private int numberOfRowsToRepeat = 1;

private Float headerHeight;

@Override
protected void drawPage(PageData pageData) {
if (pageData.firstRowOnPage != 0) {
float adaption = 0;
for (int i = 0; i < numberOfRowsToRepeat; i++) {
adaption += table.getRows().get(i).getHeight();
Point2D.Float startPoint = new Point2D.Float(this.startX,
this.startY + calculateHeightForFirstRows() - adaption);
drawRow(startPoint, table.getRows().get(i), i, (drawer, drawingContext) -> {
drawer.drawBackground(drawingContext);
drawer.drawContent(drawingContext);
drawer.drawBorders(drawingContext);
});
}
}

drawerList.forEach(drawer -> drawWithFunction(pageData, new Point2D.Float(this.startX, this.startY), drawer));
}

@Override
protected Queue<PageData> computeRowsOnPagesWithNewPageStartOf(float yOffsetOnNewPage) {
protected void determinePageToStartTable(float yOffsetOnNewPage) {
float minimumRowsToFitHeight = 0;
int minimumRowsToFit = table.getRows().size() > numberOfRowsToRepeat ? numberOfRowsToRepeat + 1
: numberOfRowsToRepeat;
Expand All @@ -57,39 +51,27 @@ protected Queue<PageData> computeRowsOnPagesWithNewPageStartOf(float yOffsetOnNe
startY = yOffsetOnNewPage + calculateHeightForFirstRows();
startTableInNewPage = true;
}
return super.computeRowsOnPagesWithNewPageStartOf(yOffsetOnNewPage);
}

@Override
protected PDPage determinePageToDraw(int index, PDDocument document, Supplier<PDPage> pageSupplier) {
final PDPage pageToDrawOn;
if ((index == 0 && startTableInNewPage) || index > 0 || document.getNumberOfPages() == 0) {
startTableInNewPage = false;
pageToDrawOn = pageSupplier.get();
document.addPage(pageToDrawOn);
} else
pageToDrawOn = document.getPage(document.getNumberOfPages() - 1);
return pageToDrawOn;
public void draw(Supplier<PDDocument> documentSupplier, Supplier<PDPage> pageSupplier, float yOffset)
throws IOException {
super.draw(documentSupplier, pageSupplier, yOffset + calculateHeightForFirstRows());
}

@Override
public void draw(Supplier<PDDocument> documentSupplier, Supplier<PDPage> pageSupplier, float yOffset) throws IOException {
super.draw(documentSupplier, pageSupplier, yOffset + calculateHeightForFirstRows());
}

private float calculateHeightForFirstRows() {
if (headerHeight != null) {
return headerHeight;
}

float height = 0;
for (int i = 0; i < numberOfRowsToRepeat; i++) {
height += table.getRows().get(i).getHeight();
}

// Cache and return
headerHeight = height;
return height;
}
private float calculateHeightForFirstRows() {
if (headerHeight != null) {
return headerHeight;
}

float height = 0;
for (int i = 0; i < numberOfRowsToRepeat; i++) {
height += table.getRows().get(i).getHeight();
}

// Cache and return
headerHeight = height;
return height;
}

}
34 changes: 30 additions & 4 deletions src/main/java/org/vandeseer/easytable/TableDrawer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package org.vandeseer.easytable;

import lombok.AccessLevel;
import lombok.Getter;
import lombok.Setter;
import lombok.experimental.Accessors;
Expand Down Expand Up @@ -54,6 +55,13 @@ public class TableDrawer {
@Accessors(chain = true, fluent = true)
protected boolean compress;

@Getter
protected PDPage tableStartPage;

@Getter (AccessLevel.NONE)
protected boolean startTableInNewPage;


protected final List<BiConsumer<Drawer, DrawingContext>> drawerList = new LinkedList<>();
{
this.drawerList.add((drawer, drawingContext) -> {
Expand Down Expand Up @@ -96,7 +104,7 @@ protected Queue<PageData> computeRowsOnPagesWithNewPageStartOf(float yOffsetOnNe
if (isRowTooHighToBeDrawnOnPage(row, yOffsetOnNewPage)) {
throw new RowIsTooHighException("There is a row that is too high to be drawn on a single page");
}

if (isNotDrawableOnPage(y, row)) {
dataForPages.add(new PageData(firstRowOnPage, lastRowOnPage));
y = yOffsetOnNewPage;
Expand All @@ -116,16 +124,32 @@ protected Queue<PageData> computeRowsOnPagesWithNewPageStartOf(float yOffsetOnNe
private boolean isRowTooHighToBeDrawnOnPage(Row row, float yOffsetOnNewPage) {
return row.getHeight() > (yOffsetOnNewPage - endY);
}

protected void determinePageToStartTable(float yOffsetOnNewPage) {
if (startY - table.getRows().get(0).getHeight() < endY) {
startY = yOffsetOnNewPage;
startTableInNewPage = true;
}
}

public void draw(Supplier<PDDocument> documentSupplier, Supplier<PDPage> pageSupplier, float yOffset) throws IOException {
final PDDocument document = documentSupplier.get();

// We create one throwaway page to be able to calculate the page data upfront
float startOnNewPage = pageSupplier.get().getMediaBox().getHeight() - yOffset;
determinePageToStartTable(startOnNewPage);
final Queue<PageData> pageDataQueue = computeRowsOnPagesWithNewPageStartOf(startOnNewPage);

for (int i = 0; !pageDataQueue.isEmpty(); i++) {
final PDPage pageToDrawOn = determinePageToDraw(i, document, pageSupplier);

if ((i == 0 && startTableInNewPage) || i > 0 || document.getNumberOfPages() == 0) {
startTableInNewPage = false;
}

if (i == 0) {
tableStartPage = pageToDrawOn;
}

try (final PDPageContentStream newPageContentStream = new PDPageContentStream(document, pageToDrawOn, APPEND, compress)) {
this.contentStream(newPageContentStream)
Expand All @@ -139,11 +163,13 @@ public void draw(Supplier<PDDocument> documentSupplier, Supplier<PDPage> pageSup

protected PDPage determinePageToDraw(int index, PDDocument document, Supplier<PDPage> pageSupplier) {
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the returned value used at all? So either return the value and assign it where it is called (preferably) or just make the method void.

Copy link
Author

@grasshopper7 grasshopper7 Jan 25, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The returned PDPage is used by the draw(Supplier documentSupplier, Supplier pageSupplier, float yOffset) method. Not sure I got your suggestion.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, my bad. You are right. Still, there is a thing which I don't like about this method and which should be easy to fix: There is a side effect, namely setting the member variable tableStartPage within the method. At the same time this value is returned. Since it is called only once one could argue that it would make more sense to set the member variable after the method is called using its returned value.

(There is a 2nd side effect nonetheless though which is setting the member variable startTableInNewPage – but the fewer side effects the better in my opinion.)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Point taken. Have moved both the if conditions into the parent draw method.

final PDPage pageToDrawOn;
if (index > 0 || document.getNumberOfPages() == 0) {

if ((index == 0 && startTableInNewPage) || index > 0 || document.getNumberOfPages() == 0) {
pageToDrawOn = pageSupplier.get();
document.addPage(pageToDrawOn);
} else
pageToDrawOn = document.getPage(document.getNumberOfPages() - 1);
} else {
pageToDrawOn = document.getPage(document.getNumberOfPages() - 1);
Copy link
Owner

@vandeseer vandeseer Jan 25, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add brackets around the bodies of if s and else s. This is a general recommendation. It's very easy to make mistakes on refactorings and it's pretty simple to prevent 😉

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will do.

}
return pageToDrawOn;
}

Expand Down
106 changes: 106 additions & 0 deletions src/test/java/org/vandeseer/integrationtest/StartPageTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
package org.vandeseer.integrationtest;

import static junit.framework.TestCase.assertTrue;
import static junit.framework.TestCase.assertEquals;
import static org.apache.pdfbox.pdmodel.PDPageContentStream.AppendMode.APPEND;
import static org.vandeseer.TestUtils.getActualPdfFor;
import static org.vandeseer.TestUtils.getExpectedPdfFor;
import static org.apache.pdfbox.pdmodel.font.PDType1Font.HELVETICA;

import java.io.IOException;

import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.pdmodel.PDPage;
import org.apache.pdfbox.pdmodel.PDPageContentStream;
import org.apache.pdfbox.pdmodel.common.PDRectangle;
import org.apache.pdfbox.pdmodel.font.PDType1Font;
import org.junit.Before;
import org.junit.Test;
import org.vandeseer.TestUtils;
import org.vandeseer.easytable.TableDrawer;
import org.vandeseer.easytable.structure.Row;
import org.vandeseer.easytable.structure.Table;
import org.vandeseer.easytable.structure.Table.TableBuilder;
import org.vandeseer.easytable.structure.cell.TextCell;

import de.redsix.pdfcompare.CompareResult;
import de.redsix.pdfcompare.PdfComparator;

public class StartPageTest {

private static final String FULL_TABLE_EXISTING_PAGE_FILE_NAME = "fullTableExistingPage.pdf";
private static final String START_TABLE_EXISTING_PAGE_FILE_NAME = "startTableExistingPage.pdf";
private static final String START_TABLE_NEW_PAGE_FILE_NAME = "startTableNewPage.pdf";

private Table table;

private PDDocument document;

private PDPage currentPage;

private TableDrawer drawer;

@Before
public void before() throws IOException {
TestUtils.assertRegressionFolderExists();

document = new PDDocument();
currentPage = new PDPage(PDRectangle.A4);
document.addPage(currentPage);

try (final PDPageContentStream content = new PDPageContentStream(document, currentPage, APPEND, false)) {
content.beginText();
content.setFont(PDType1Font.TIMES_ROMAN, 15);
content.newLineAtOffset(50, 500);
content.showText("This line is added to ensure table is drawn on new page when space not available.");
content.endText();
content.close();

TableBuilder builder = Table.builder().addColumnsOfWidth(150, 150, 150).fontSize(25).font(HELVETICA)
.padding(5).borderWidth(1)
.addRow(Row.builder().add(TextCell.builder().text("Header").build())
.add(TextCell.builder().text("of").build()).add(TextCell.builder().text("Table").build())
.build());

for (int i = 1; i < 5; i++) {
builder.addRow(Row.builder().add(TextCell.builder().text("Row " + i).build())
.add(TextCell.builder().text("of").build()).add(TextCell.builder().text("Table").build())
.build()).build();
}
table = builder.build();
}
}

private void createTable(float startY, String outputFileName) throws IOException {

drawer = TableDrawer.builder().table(table).startX(50f).startY(startY).endY(50F).build();

drawer.draw(() -> document, () -> new PDPage(PDRectangle.A4), 50f);

document.save(TestUtils.TARGET_FOLDER + "/" + outputFileName);
document.close();

final CompareResult compareResult = new PdfComparator<>(getExpectedPdfFor(outputFileName),
getActualPdfFor(outputFileName)).compare();

assertTrue(compareResult.isEqual());
}

@Test
public void createCompleteTableInExistingPage() throws IOException {
createTable(200f, FULL_TABLE_EXISTING_PAGE_FILE_NAME);
assertEquals(currentPage, drawer.getTableStartPage());
}

@Test
public void createSplitTableStartInExistingPage() throws IOException {
createTable(120f, START_TABLE_EXISTING_PAGE_FILE_NAME);
assertEquals(currentPage, drawer.getTableStartPage());
}

@Test
public void createTableStartInNewPage() throws IOException {
createTable(70f, START_TABLE_NEW_PAGE_FILE_NAME);
assertEquals(document.getPage(document.getNumberOfPages() - 1), drawer.getTableStartPage());
}
}
Binary file added src/test/reference/fullTableExistingPage.pdf
View file
Open in desktop
Binary file not shown.
Binary file added src/test/reference/startTableExistingPage.pdf
View file
Open in desktop
Binary file not shown.
Binary file added src/test/reference/startTableNewPage.pdf
View file
Open in desktop
Binary file not shown.