Introduce generic approach for y-line extraction control; make some of the util methods public in AbstractRenderer

DEVSIX-984

Author: yulian-gaponenko

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

@@ -43,8 +43,11 @@ This file is part of the iText (R) project.
 package com.itextpdf.forms;
 
 import com.itextpdf.forms.fields.PdfFormField;
+import com.itextpdf.kernel.geom.Rectangle;
+import com.itextpdf.kernel.pdf.PdfArray;
 import com.itextpdf.kernel.pdf.PdfDocument;
 import com.itextpdf.kernel.pdf.PdfReader;
+import com.itextpdf.kernel.pdf.PdfString;
 import com.itextpdf.kernel.pdf.PdfWriter;
 import com.itextpdf.kernel.utils.CompareTool;
 import com.itextpdf.test.ExtendedITextTest;
@@ -55,6 +58,7 @@ This file is part of the iText (R) project.
 import org.junit.experimental.categories.Category;
 
 import java.io.IOException;
+import java.util.Arrays;
 
 @Category(IntegrationTest.class)
 public class FormFieldFlatteningTest extends ExtendedITextTest {
@@ -82,6 +86,25 @@ public void formFlatteningTest01() throws IOException, InterruptedException {
         Assert.assertNull(new CompareTool().compareByContent(filename, sourceFolder + "cmp_formFlatteningTest01.pdf", destinationFolder, "diff_"));
     }
 
+    @Test
+    public void formFlatteningChoiceFieldTest01() throws IOException, InterruptedException {
+        String srcFilename = sourceFolder + "formFlatteningSourceChoiceField.pdf";
+        String filename = destinationFolder + "formFlatteningChoiceFieldTest01.pdf";
+
+        PdfDocument doc = new PdfDocument(new PdfReader(srcFilename), new PdfWriter(filename));
+
+        PdfAcroForm form = PdfAcroForm.getAcroForm(doc, true);
+        form.flattenFields();
+
+        doc.close();
+
+        CompareTool compareTool = new CompareTool();
+        String errorMessage = compareTool.compareByContent(filename, sourceFolder + "cmp_formFlatteningChoiceFieldTest01.pdf", destinationFolder, "diff_");
+        if (errorMessage != null) {
+            Assert.fail(errorMessage);
+        }
+    }
+
     @Test
     public void formFlatteningTest_DefaultAppearanceGeneration_Rot0() throws IOException, InterruptedException {
         String srcFilePattern = "FormFlatteningDefaultAppearance_0_";

forms/src/test/resources/com/itextpdf/forms/FormFieldFlatteningTest/cmp_formFlatteningChoiceFieldTest01.pdf

@@ -1033,6 +1033,47 @@ public Rectangle getInnerAreaBBox() {
         return rect;
     }
 
+    /**
+     * Applies margins of the renderer on the given rectangle
+     *
+     * @param rect    a rectangle margins will be applied on.
+     * @param reverse indicates whether margins will be applied
+     *                inside (in case of false) or outside (in case of true) the rectangle.
+     * @return a {@link Rectangle border box} of the renderer
+     * @see #getMargins
+     */
+    public Rectangle applyMargins(Rectangle rect, boolean reverse) {
+        return this.applyMargins(rect, getMargins(), reverse);
+    }
+
+    /**
+     * Applies the border box of the renderer on the given rectangle
+     * If the border of a certain side is null, the side will remain as it was.
+     *
+     * @param rect    a rectangle the border box will be applied on.
+     * @param reverse indicates whether the border box will be applied
+     *                inside (in case of false) or outside (in case of false) the rectangle.
+     * @return a {@link Rectangle border box} of the renderer
+     * @see #getBorders
+     */
+    public Rectangle applyBorderBox(Rectangle rect, boolean reverse) {
+        Border[] borders = getBorders();
+        return applyBorderBox(rect, borders, reverse);
+    }
+
+    /**
+     * Applies paddings of the renderer on the given rectangle
+     *
+     * @param rect    a rectangle paddings will be applied on.
+     * @param reverse indicates whether paddings will be applied
+     *                inside (in case of false) or outside (in case of false) the rectangle.
+     * @return a {@link Rectangle border box} of the renderer
+     * @see #getPaddings
+     */
+    public Rectangle applyPaddings(Rectangle rect, boolean reverse) {
+        return applyPaddings(rect, getPaddings(), reverse);
+    }
+
     public boolean isFirstOnRootArea() {
         return isFirstOnRootArea(false);
     }
@@ -1043,24 +1084,24 @@ protected void applyDestinationsAndAnnotation(DrawContext drawContext) {
         applyLinkAnnotation(drawContext.getDocument());
     }
 
-    static boolean isBorderBoxSizing(IRenderer renderer) {
+    protected static boolean isBorderBoxSizing(IRenderer renderer) {
         BoxSizingPropertyValue boxSizing = renderer.<BoxSizingPropertyValue>getProperty(Property.BOX_SIZING);
         return boxSizing != null && boxSizing.equals(BoxSizingPropertyValue.BORDER_BOX);
     }
 
-    boolean isOverflowProperty(OverflowPropertyValue equalsTo, int overflowProperty) {
+    protected boolean isOverflowProperty(OverflowPropertyValue equalsTo, int overflowProperty) {
         return isOverflowProperty(equalsTo, this.<OverflowPropertyValue>getProperty(overflowProperty));
     }
 
-    static boolean isOverflowProperty(OverflowPropertyValue equalsTo, IRenderer renderer, int overflowProperty) {
+    protected static boolean isOverflowProperty(OverflowPropertyValue equalsTo, IRenderer renderer, int overflowProperty) {
         return isOverflowProperty(equalsTo, renderer.<OverflowPropertyValue>getProperty(overflowProperty));
     }
 
-    static boolean isOverflowProperty(OverflowPropertyValue equalsTo, OverflowPropertyValue rendererOverflowProperty) {
+    protected static boolean isOverflowProperty(OverflowPropertyValue equalsTo, OverflowPropertyValue rendererOverflowProperty) {
         return equalsTo.equals(rendererOverflowProperty) || equalsTo.equals(OverflowPropertyValue.FIT) && rendererOverflowProperty == null;
     }
 
-    static boolean isOverflowFit(OverflowPropertyValue rendererOverflowProperty) {
+    protected static boolean isOverflowFit(OverflowPropertyValue rendererOverflowProperty) {
         return rendererOverflowProperty == null || OverflowPropertyValue.FIT.equals(rendererOverflowProperty);
     }
 
@@ -1188,7 +1229,7 @@ protected Float retrieveMinWidth(float parentBoxWidth) {
      *
      * @param updatedWidthValue element's new fixed content box width.
      */
-    void updateWidth(UnitValue updatedWidthValue) {
+    protected void updateWidth(UnitValue updatedWidthValue) {
         if (updatedWidthValue.isPointValue() && isBorderBoxSizing(this)) {
             updatedWidthValue.setValue(updatedWidthValue.getValue() + calculatePaddingBorderWidth(this));
         }
@@ -1287,7 +1328,7 @@ private float[] calculateRadii(BorderRadius[] radii, Rectangle area, boolean hor
      *
      * @param updatedHeight element's new fixed content box height, shall be not null.
      */
-    void updateHeight(UnitValue updatedHeight) {
+    protected void updateHeight(UnitValue updatedHeight) {
         if (isBorderBoxSizing(this) && updatedHeight.isPointValue()) {
             updatedHeight.setValue(updatedHeight.getValue() + calculatePaddingBorderHeight(this));
 
@@ -1343,8 +1384,7 @@ protected Float retrieveMaxHeight() {
      *
      * @param updatedMaxHeight element's new content box max-height, shall be not null.
      */
-
-    void updateMaxHeight(UnitValue updatedMaxHeight) {
+    protected void updateMaxHeight(UnitValue updatedMaxHeight) {
         if (isBorderBoxSizing(this) && updatedMaxHeight.isPointValue()) {
             updatedMaxHeight.setValue(updatedMaxHeight.getValue() + calculatePaddingBorderHeight(this));
 
@@ -1393,7 +1433,7 @@ protected Float retrieveMinHeight() {
      *
      * @param updatedMinHeight element's new content box min-height, shall be not null.
      */
-    void updateMinHeight(UnitValue updatedMinHeight) {
+    protected void updateMinHeight(UnitValue updatedMinHeight) {
         if (isBorderBoxSizing(this) && updatedMinHeight.isPointValue()) {
             updatedMinHeight.setValue(updatedMinHeight.getValue() + calculatePaddingBorderHeight(this));
         }
@@ -1448,9 +1488,7 @@ protected Float getFirstYLineRecursively() {
     }
 
     protected Float getLastYLineRecursively() {
-        if (isOverflowProperty(OverflowPropertyValue.HIDDEN, Property.OVERFLOW_X)
-                || isOverflowProperty(OverflowPropertyValue.HIDDEN, Property.OVERFLOW_Y)) {
-            // TODO may be this logic should also be based on BlockFormattingContextUtil?
+        if (!allowLastYLineRecursiveExtraction()) {
             return null;
         }
         for (int i = childRenderers.size() - 1; i >= 0; i--) {
@@ -1465,17 +1503,9 @@ protected Float getLastYLineRecursively() {
         return null;
     }
 
-    /**
-     * Applies margins of the renderer on the given rectangle
-     *
-     * @param rect    a rectangle margins will be applied on.
-     * @param reverse indicates whether margins will be applied
-     *                inside (in case of false) or outside (in case of true) the rectangle.
-     * @return a {@link Rectangle border box} of the renderer
-     * @see #getMargins
-     */
-    protected Rectangle applyMargins(Rectangle rect, boolean reverse) {
-        return this.applyMargins(rect, getMargins(), reverse);
+    protected boolean allowLastYLineRecursiveExtraction() {
+        return !isOverflowProperty(OverflowPropertyValue.HIDDEN, Property.OVERFLOW_X)
+                && !isOverflowProperty(OverflowPropertyValue.HIDDEN, Property.OVERFLOW_Y);
     }
 
     /**
@@ -1525,19 +1555,6 @@ protected UnitValue[] getPaddings() {
         return getPaddings(this);
     }
 
-    /**
-     * Applies paddings of the renderer on the given rectangle
-     *
-     * @param rect    a rectangle paddings will be applied on.
-     * @param reverse indicates whether paddings will be applied
-     *                inside (in case of false) or outside (in case of false) the rectangle.
-     * @return a {@link Rectangle border box} of the renderer
-     * @see #getPaddings
-     */
-    protected Rectangle applyPaddings(Rectangle rect, boolean reverse) {
-        return applyPaddings(rect, getPaddings(), reverse);
-    }
-
     /**
      * Applies given paddings on the given rectangle
      *
@@ -1567,21 +1584,6 @@ protected Rectangle applyPaddings(Rectangle rect, UnitValue[] paddings, boolean
         return rect.applyMargins(paddings[0].getValue(), paddings[1].getValue(), paddings[2].getValue(), paddings[3].getValue(), reverse);
     }
 
-    /**
-     * Applies the border box of the renderer on the given rectangle
-     * If the border of a certain side is null, the side will remain as it was.
-     *
-     * @param rect    a rectangle the border box will be applied on.
-     * @param reverse indicates whether the border box will be applied
-     *                inside (in case of false) or outside (in case of false) the rectangle.
-     * @return a {@link Rectangle border box} of the renderer
-     * @see #getBorders
-     */
-    protected Rectangle applyBorderBox(Rectangle rect, boolean reverse) {
-        Border[] borders = getBorders();
-        return applyBorderBox(rect, borders, reverse);
-    }
-
     /**
      * Applies the given border box (borders) on the given rectangle
      *

forms/src/test/resources/com/itextpdf/forms/FormFieldFlatteningTest/formFlatteningSourceChoiceField.pdf

@@ -564,9 +564,7 @@ protected Float getFirstYLineRecursively() {
 
     @Override
     protected Float getLastYLineRecursively() {
-        if (isOverflowProperty(OverflowPropertyValue.HIDDEN, Property.OVERFLOW_X)
-                || isOverflowProperty(OverflowPropertyValue.HIDDEN, Property.OVERFLOW_Y)) {
-            // TODO may be this logic should also be based on BlockFormattingContextUtil?
+        if (!allowLastYLineRecursiveExtraction()) {
             return null;
         }
         if (lines == null || lines.size() == 0) {

layout/src/main/java/com/itextpdf/layout/renderer/AbstractRenderer.java

@@ -161,7 +161,7 @@ protected Rectangle applyPaddings(Rectangle rect, UnitValue[] paddings, boolean
     }
 
     @Override
-    protected Rectangle applyPaddings(Rectangle rect, boolean reverse) {
+    public Rectangle applyPaddings(Rectangle rect, boolean reverse) {
         if (bordersHandler instanceof SeparatedTableBorders) {
             super.applyPaddings(rect, reverse);
         } else {
@@ -1313,11 +1313,21 @@ protected MinMaxWidth getMinMaxWidth() {
         return new MinMaxWidth(minWidth, maxColTotalWidth, additionalWidth);
     }
 
+    /**
+     * @deprecated Will be removed in next major release (iText 7.2).
+     * The aim of this method overriding here is achieved by overriding {@link #allowLastYLineRecursiveExtraction} method.
+     */
     @Override
+    @Deprecated
     protected Float getLastYLineRecursively() {
         return null;
     }
 
+    @Override
+    protected boolean allowLastYLineRecursiveExtraction() {
+        return false;
+    }
+
     private void initializeTableLayoutBorders() {
         boolean isSeparated = BorderCollapsePropertyValue.SEPARATE.equals(this.<BorderCollapsePropertyValue>getProperty(Property.BORDER_COLLAPSE));
         bordersHandler = isSeparated