Merge pull request #727 from fanthos/patch-1

danfickle · web-flow · commit dde1e84e5767 · 2021-06-27T16:31:49.000+10:00
Fast renderer should support initialPageNo
diff --git a/openhtmltopdf-core/src/main/java/com/openhtmltopdf/outputdevice/helper/BaseRendererBuilder.java b/openhtmltopdf-core/src/main/java/com/openhtmltopdf/outputdevice/helper/BaseRendererBuilder.java
@@ -626,6 +626,19 @@ public TFinalClass useExternalResourceAccessControl(
         return (TFinalClass) this;
     }
 
+    /**
+     * Allows the setting of the initial page number to use with the 
+     * <code>page</code> and <code>pages</code> CSS counters.
+     * Useful when appending to an existing document.
+     * Must be one or greater.
+     *
+     * @return this for method chaining.
+     */
+    public TFinalClass useInitialPageNumber(int initialPageNumber) {
+        state._initialPageNumber = initialPageNumber;
+        return (TFinalClass) this;
+    }
+
 	public enum TextDirection {
 		RTL, LTR
 	}
diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/expected/pr-727-initial-page-number.pdf b/openhtmltopdf-examples/src/main/resources/visualtest/expected/pr-727-initial-page-number.pdf
diff --git a/openhtmltopdf-examples/src/main/resources/visualtest/html/pr-727-initial-page-number.html b/openhtmltopdf-examples/src/main/resources/visualtest/html/pr-727-initial-page-number.html
@@ -0,0 +1,29 @@
+<html>
+<head>
+<style>
+@page {
+  size: 300px 150px;
+  margin: 25px;
+
+  @top-center {
+    content: counter(page) " of " counter(pages);
+  }
+  @bottom-center {
+    content: element(ftr);
+  }
+}
+.footer::before {
+  content: "Footer on page " counter(page) " of " counter(pages);
+}
+body {
+  margin: 0;
+}
+</style>
+</head>
+<body>
+<div class="footer" style="position: running(ftr);"></div>
+
+<h2 style="margin-top: 0;">Page five</h2>
+<h2 style="margin-top: 0; page-break-before: always;">Page six</h2>
+</body>
+</html>
diff --git a/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/VisualRegressionTest.java b/openhtmltopdf-examples/src/test/java/com/openhtmltopdf/visualregressiontests/VisualRegressionTest.java
@@ -1413,6 +1413,16 @@ public void testIssue649MultipleBgImagesPageBox() throws IOException {
         assertTrue(vt.runTest("issue-649-multiple-bg-images-page-box"));
     }
 
+    /**
+     * Tests setting an initial page number with CSS page and pages counters.
+     */
+    @Test
+    public void testPr727InitialPageNumber() throws IOException {
+        assertTrue(vt.runTest("pr-727-initial-page-number", builder -> {
+            builder.useInitialPageNumber(5);
+        }));
+    }
+
     // TODO:
     // + Elements that appear just on generated overflow pages.
     // + content property (page counters, etc)
diff --git a/openhtmltopdf-java2d/src/main/java/com/openhtmltopdf/java2d/api/Java2DRendererBuilder.java b/openhtmltopdf-java2d/src/main/java/com/openhtmltopdf/java2d/api/Java2DRendererBuilder.java
@@ -37,17 +37,6 @@ public Java2DRendererBuilder useLayoutGraphics(Graphics2D g2d) {
 		return this;
 	}
 
-	/**
-	 * Used to set an initial page number for use with page counters, etc.
-	 *
-	 * @param pageNumberInitial
-	 * @return this for method chaining
-	 */
-	public Java2DRendererBuilder useInitialPageNumber(int pageNumberInitial) {
-		state._initialPageNumber = pageNumberInitial;
-		return this;
-	}
-
     /**
      * Whether to use fonts available in the environment. Enabling environment fonts may mean different text
      * rendering behavior across different environments. The default is not to use environment fonts.
diff --git a/openhtmltopdf-pdfbox/src/main/java/com/openhtmltopdf/pdfboxout/PdfBoxRenderer.java b/openhtmltopdf-pdfbox/src/main/java/com/openhtmltopdf/pdfboxout/PdfBoxRenderer.java
@@ -138,7 +138,9 @@ public class PdfBoxRenderer implements Closeable, PageSupplier {
     private PageSupplier _pageSupplier;
 
     private final Closeable diagnosticConsumer;
-    
+
+    private final int _initialPageNumber;
+
     /**
      * This method is constantly changing as options are added to the builder.
      */
@@ -269,6 +271,8 @@ else if (doc.file != null) {
         }
         
         this._os = state._os;
+
+        this._initialPageNumber = state._initialPageNumber;
     }
 
     public Document getDocument() {
@@ -477,7 +481,7 @@ public void createPDF(OutputStream os, boolean finish) throws IOException {
     @Deprecated
     public void createPDF(OutputStream os, boolean finish, int initialPageNo) throws IOException {
         if (_useFastMode) {
-            createPdfFast(finish);
+            createPdfFast(finish, initialPageNo);
             return;
         }
         
@@ -493,7 +497,7 @@ public void createPDF(OutputStream os, boolean finish, int initialPageNo) throws
 
             RenderingContext c = newRenderingContext();
             c.setInitialPageNo(initialPageNo);
-        
+
             PageBox firstPage = pages.get(0);
             Rectangle2D firstPageSize = new Rectangle2D.Float(0, 0,
                     firstPage.getWidth(c) / _dotsPerPoint,
@@ -523,7 +527,7 @@ public void createPDF(OutputStream os, boolean finish, int initialPageNo) throws
     /**
      * Go fast!
      */
-    private void createPdfFast(boolean finish) throws IOException {
+    private void createPdfFast(boolean finish, int initialPageNo) throws IOException {
         boolean success = false;
 
         XRLog.log(Level.INFO, LogMessageId.LogMessageId0Param.GENERAL_PDF_USING_FAST_MODE);
@@ -537,7 +541,7 @@ private void createPdfFast(boolean finish) throws IOException {
             List<PageBox> pages = _root.getLayer().getPages();
 
             RenderingContext c = newRenderingContext();
-            c.setInitialPageNo(0);
+            c.setInitialPageNo(initialPageNo != 0 ? initialPageNo : _initialPageNumber);
             c.setFastRenderer(true);
         
             PageBox firstPage = pages.get(0);
@@ -596,6 +600,7 @@ private void writePDFFast(List<PageBox> pages, RenderingContext c, Rectangle2D f
         
         int pageCount = _root.getLayer().getPages().size();
         c.setPageCount(pageCount);
+
         firePreWrite(pageCount); // opportunity to adjust meta data
         setDidValues(doc); // set PDF header fields from meta data
         
