Deprecate one of Canvas constructors

Remove references to deprecated constructor
Add unit tests

DEVSIX-3767

Author: BlackEgoist

forms/src/main/java/com/itextpdf/forms/fields/PdfFormField.java

@@ -2477,7 +2477,7 @@ protected void drawTextAppearance(Rectangle rect, PdfFont font, float fontSize,
             x = rect.getWidth() / 2;
         }
 
-        Canvas modelCanvas = new Canvas(canvas, getDocument(), new Rectangle(0, -height, 0, 2 * height));
+        Canvas modelCanvas = new Canvas(canvas, new Rectangle(0, -height, 0, 2 * height));
         modelCanvas.setProperty(Property.APPEARANCE_STREAM_LAYOUT, true);
 
         Style paragraphStyle = new Style().setFont(font).setFontSize(fontSize);
@@ -2549,7 +2549,7 @@ protected void drawMultiLineTextAppearance(Rectangle rect, PdfFont font, String
         canvas.beginVariableText();
 
         Rectangle areaRect = new Rectangle(0, 0, width, height);
-        Canvas modelCanvas = new Canvas(canvas, getDocument(), areaRect);
+        Canvas modelCanvas = new Canvas(canvas, areaRect);
         modelCanvas.setProperty(Property.APPEARANCE_STREAM_LAYOUT, true);
 
         Paragraph paragraph = createParagraphForTextFieldValue(value).setFont(font)
@@ -2606,7 +2606,7 @@ private void drawChoiceAppearance(Rectangle rect, float fontSize, String value,
                 clip().
                 endPath();
 
-        Canvas modelCanvas = new Canvas(canvas, getDocument(), new Rectangle(3, 0, Math.max(0, width - widthBorder), Math.max(0, height - heightBorder)));
+        Canvas modelCanvas = new Canvas(canvas, new Rectangle(3, 0, Math.max(0, width - widthBorder), Math.max(0, height - heightBorder)));
         modelCanvas.setProperty(Property.APPEARANCE_STREAM_LAYOUT, true);
         for (int index = 0; index < strings.size(); index++) {
             Boolean isFull = modelCanvas.getRenderer().getPropertyAsBoolean(Property.FULL);
@@ -2998,7 +2998,7 @@ protected void drawButton(PdfCanvas canvas, float x, float y, float width, float
 
         Paragraph paragraph = new Paragraph(text).setFont(font).setFontSize(fontSize).setMargin(0).setMultipliedLeading(1).
                 setVerticalAlignment(VerticalAlignment.MIDDLE);
-        Canvas modelCanvas = new Canvas(canvas, getDocument(), new Rectangle(0, -height, width, 2 * height));
+        Canvas modelCanvas = new Canvas(canvas, new Rectangle(0, -height, width, 2 * height));
         modelCanvas.setProperty(Property.APPEARANCE_STREAM_LAYOUT, true);
         modelCanvas.showTextAligned(paragraph, width / 2, height / 2, TextAlignment.CENTER, VerticalAlignment.MIDDLE);
     }

forms/src/test/java/com/itextpdf/forms/PdfFormFieldTest.java

@@ -614,7 +614,7 @@ public void fillFormWithDefaultResourcesUpdateFont() throws IOException, Interru
         field.setFont(PdfFontFactory.createFont(StandardFonts.COURIER));
         field.setValue("New value size must be 8, but with different font.");
 
-        new Canvas(new PdfCanvas(pdfDoc.getFirstPage()), pdfDoc, new Rectangle(30, 500, 500, 200))
+        new Canvas(new PdfCanvas(pdfDoc.getFirstPage()), new Rectangle(30, 500, 500, 200))
                 .add(new Paragraph("The text font after modification it via PDF viewer (e.g. Acrobat) shall be preserved."));
 
         pdfDoc.close();

layout/src/main/java/com/itextpdf/layout/Canvas.java

@@ -90,36 +90,70 @@ public class Canvas extends RootElement<Canvas> {
      * @param rootArea the maximum area that the Canvas may write upon
      */
     public Canvas(PdfPage page, Rectangle rootArea) {
-        this(initPdfCanvasOrThrowIfPageIsFlushed(page), page.getDocument(), rootArea);
+        this(initPdfCanvasOrThrowIfPageIsFlushed(page), rootArea);
         this.enableAutoTagging(page);
         this.isCanvasOfPage = true;
     }
 
+    /**
+     * Creates a new Canvas to manipulate a specific content stream, which might be for example a page
+     * or {@link PdfFormXObject} stream.
+     *
+     * @param pdfCanvas the low-level content stream writer
+     * @param rootArea the maximum area that the Canvas may write upon
+     */
+    public Canvas(PdfCanvas pdfCanvas, Rectangle rootArea) {
+        super();
+        this.pdfDocument = pdfCanvas.getDocument();
+        this.pdfCanvas = pdfCanvas;
+        this.rootArea = rootArea;
+    }
+
     /**
      * Creates a new Canvas to manipulate a specific document and content stream, which might be for example a page
      * or {@link PdfFormXObject} stream.
      *
      * @param pdfCanvas the low-level content stream writer
      * @param pdfDocument the document that the resulting content stream will be written to
      * @param rootArea the maximum area that the Canvas may write upon
+     *                 
+     * To be removed in 7.2
+     * @deprecated use {@link Canvas#Canvas(PdfCanvas, Rectangle)} instead.
      */
+    @Deprecated
     public Canvas(PdfCanvas pdfCanvas, PdfDocument pdfDocument, Rectangle rootArea) {
         super();
         this.pdfDocument = pdfDocument;
         this.pdfCanvas = pdfCanvas;
         this.rootArea = rootArea;
     }
 
+    /**
+     * Creates a new Canvas to manipulate a specific document and page.
+     *
+     * @param pdfCanvas         The low-level content stream writer
+     * @param rootArea          The maximum area that the Canvas may write upon
+     * @param immediateFlush    Whether to flush the canvas immediately after operations, false otherwise
+     */
+    public Canvas(PdfCanvas pdfCanvas, Rectangle rootArea, boolean immediateFlush) {
+        this(pdfCanvas, rootArea);
+        this.immediateFlush = immediateFlush;
+    }
+
     /**
      * Creates a new Canvas to manipulate a specific document and page.
      *
      * @param pdfCanvas         The low-level content stream writer
      * @param pdfDocument       The document that the resulting content stream will be written to
      * @param rootArea          The maximum area that the Canvas may write upon
      * @param immediateFlush    Whether to flush the canvas immediately after operations, false otherwise
+     *                          
+     * To be removed in 7.2
+     * @deprecated use {@link Canvas#Canvas(PdfCanvas, Rectangle, boolean)} instead.
      */
+    @Deprecated
     public Canvas(PdfCanvas pdfCanvas, PdfDocument pdfDocument, Rectangle rootArea, boolean immediateFlush) {
-        this(pdfCanvas, pdfDocument, rootArea);
+        this(pdfCanvas, rootArea);
         this.immediateFlush = immediateFlush;
     }
 
@@ -130,7 +164,7 @@ public Canvas(PdfCanvas pdfCanvas, PdfDocument pdfDocument, Rectangle rootArea,
      * @param pdfDocument the document that the resulting content stream will be written to
      */
     public Canvas(PdfFormXObject formXObject, PdfDocument pdfDocument) {
-        this(new PdfCanvas(formXObject, pdfDocument), pdfDocument, formXObject.getBBox().toRectangle());
+        this(new PdfCanvas(formXObject, pdfDocument), formXObject.getBBox().toRectangle());
     }
 
     /**

layout/src/test/java/com/itextpdf/layout/CanvasTest.java

@@ -90,7 +90,7 @@ public void canvasNoPageLinkTest() throws IOException, InterruptedException {
                 pageSize.getWidth() - 72,
                 50);
 
-        Canvas canvas = new Canvas(pdfCanvas, pdf, rectangle);
+        Canvas canvas = new Canvas(pdfCanvas, rectangle);
         canvas.add(
                 new Paragraph(
                         new Link("Google link!", PdfAction.createURI("https://www.google.com"))

layout/src/test/java/com/itextpdf/layout/CanvasUnitTest.java

@@ -0,0 +1,66 @@
+/*
+    This file is part of the iText (R) project.
+    Copyright (c) 1998-2020 iText Group NV
+    Authors: iText Software.
+
+    This program is offered under a commercial and under the AGPL license.
+    For commercial licensing, contact us at https://itextpdf.com/sales.  For AGPL licensing, see below.
+
+    AGPL licensing:
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+package com.itextpdf.layout;
+
+import com.itextpdf.io.source.ByteArrayOutputStream;
+import com.itextpdf.kernel.geom.Rectangle;
+import com.itextpdf.kernel.pdf.PdfDocument;
+import com.itextpdf.kernel.pdf.PdfPage;
+import com.itextpdf.kernel.pdf.PdfWriter;
+import com.itextpdf.kernel.pdf.canvas.PdfCanvas;
+import com.itextpdf.test.ExtendedITextTest;
+import com.itextpdf.test.annotations.type.UnitTest;
+
+import org.junit.Assert;
+import org.junit.Test;
+import org.junit.experimental.categories.Category;
+
+@Category(UnitTest.class)
+public class CanvasUnitTest extends ExtendedITextTest {
+
+    @Test
+    public void canvasImmediateFlushConstructorTest() {
+        PdfDocument pdf = new PdfDocument(new PdfWriter(new ByteArrayOutputStream()));
+        PdfPage page = pdf.addNewPage();
+        PdfCanvas pdfCanvas = new PdfCanvas(page.getLastContentStream(), page.getResources(), pdf);
+        Rectangle rectangle = new Rectangle(0, 0);
+        Canvas canvas = new Canvas(pdfCanvas, rectangle, false);
+
+        Assert.assertEquals(pdfCanvas.getDocument(), canvas.getPdfDocument());
+        Assert.assertFalse(canvas.immediateFlush);
+    }
+
+    @Test
+    //TODO remove test after deprecated constructor is removed
+    public void canvasImmediateFlushDeprecatedConstructorTest() {
+        PdfDocument pdf = new PdfDocument(new PdfWriter(new ByteArrayOutputStream()));
+        PdfPage page = pdf.addNewPage();
+        Rectangle pageSize = page.getPageSize();
+        PdfCanvas pdfCanvas = new PdfCanvas(page.getLastContentStream(), page.getResources(), pdf);
+        Rectangle rectangle = new Rectangle(0, 0);
+        Canvas canvas = new Canvas(pdfCanvas, pdf, rectangle, false);
+
+        Assert.assertEquals(pdfCanvas.getDocument(), canvas.getPdfDocument());
+        Assert.assertFalse(canvas.immediateFlush);
+    }
+}

layout/src/test/java/com/itextpdf/layout/FloatTest.java

@@ -453,7 +453,7 @@ public void floatsOnCanvas() throws IOException, InterruptedException {
         PdfDocument pdfDoc = new PdfDocument(new PdfWriter(outFile)).setTagged();
         PdfPage page = pdfDoc.addNewPage();
         PdfCanvas pdfCanvas = new PdfCanvas(page);
-        Canvas canvas = new Canvas(pdfCanvas, pdfDoc, page.getPageSize().applyMargins(36, 36, 36, 36, false));
+        Canvas canvas = new Canvas(pdfCanvas, page.getPageSize().applyMargins(36, 36, 36, 36, false));
         canvas.enableAutoTagging(page);
 
         Div div = new Div().setBackgroundColor(ColorConstants.RED);

layout/src/test/java/com/itextpdf/layout/ImageTest.java

@@ -902,7 +902,7 @@ public void precisionTest01() throws IOException, InterruptedException {
         PdfCanvas currentPdfCanvas = new PdfCanvas(page);
 
         Rectangle rc = new Rectangle(56.6929131f, 649.13385f, 481.889771f, 136.062988f);
-        Canvas canvas = new Canvas(currentPdfCanvas, pdfDoc, rc);
+        Canvas canvas = new Canvas(currentPdfCanvas, rc);
 
         Table table = new Table(UnitValue.createPointArray(new float[]{158f}));
         table.setTextAlignment(TextAlignment.LEFT);

layout/src/test/java/com/itextpdf/layout/OverflowTest.java

@@ -217,7 +217,7 @@ public void overflowHiddenOnCanvasTest01() throws IOException, InterruptedExcept
         PdfDocument pdfDocument = new PdfDocument(new PdfWriter(outFileName));
 
         PdfPage page = pdfDocument.addNewPage();
-        Canvas canvas = new Canvas(new PdfCanvas(page), pdfDocument, page.getPageSize().clone().applyMargins(36, 36, 36, 36, false));
+        Canvas canvas = new Canvas(new PdfCanvas(page), page.getPageSize().clone().applyMargins(36, 36, 36, 36, false));
 
         addParaWithImgSetOverflowX(canvas, OverflowPropertyValue.HIDDEN);
 
@@ -251,7 +251,7 @@ public void overflowVisibleOnCanvasTest01() throws IOException, InterruptedExcep
         PdfDocument pdfDocument = new PdfDocument(new PdfWriter(outFileName));
 
         PdfPage page = pdfDocument.addNewPage();
-        Canvas canvas = new Canvas(new PdfCanvas(page), pdfDocument, page.getPageSize().clone().applyMargins(36, 36, 36, 36, false));
+        Canvas canvas = new Canvas(new PdfCanvas(page), page.getPageSize().clone().applyMargins(36, 36, 36, 36, false));
 
         addParaWithImgSetOverflowX(canvas, OverflowPropertyValue.VISIBLE);
 

pdfa/src/test/java/com/itextpdf/pdfa/PdfA2LayoutOcgTest.java

@@ -94,7 +94,7 @@ public void checkIfOcgForPdfA2Works() throws IOException, InterruptedException {
 
         PdfCanvas pdfCanvas = new PdfCanvas(pdfDoc, 1);
 
-        Canvas canvas1 = new Canvas(pdfCanvas, pdfDoc, new Rectangle(0, 0, 590, 420));
+        Canvas canvas1 = new Canvas(pdfCanvas, new Rectangle(0, 0, 590, 420));
         PdfLayer imageLayer1 = new PdfLayer("*[email protected]", pdfDoc);
         imageLayer1.setOn(true);
         pdfCanvas.beginLayer(imageLayer1);

sign/src/main/java/com/itextpdf/signatures/PdfSignatureAppearance.java

@@ -901,7 +901,7 @@ private void addTextToCanvas(String text, PdfFont font, Rectangle dataRect) {
         PdfCanvas canvas;
         canvas = new PdfCanvas(n2, document);
         Paragraph paragraph = new Paragraph(text).setFont(font).setMargin(0).setMultipliedLeading(0.9f);
-        Canvas layoutCanvas = new Canvas(canvas, document, dataRect);
+        Canvas layoutCanvas = new Canvas(canvas, dataRect);
         paragraph.setFontColor(layer2FontColor);
         if (layer2FontSize == 0) {
             applyCopyFittingFontSize(paragraph, dataRect, layoutCanvas.getRenderer());