Fix border\margin\padding treating for grid and mutlicol

DEVSIX-8418

Author: introfog

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

@@ -23,7 +23,6 @@ This file is part of the iText (R) project.
 package com.itextpdf.layout.renderer;
 
 import com.itextpdf.kernel.geom.Rectangle;
-import com.itextpdf.layout.borders.Border;
 import com.itextpdf.layout.element.GridContainer;
 import com.itextpdf.layout.layout.LayoutArea;
 import com.itextpdf.layout.layout.LayoutContext;
@@ -45,6 +44,7 @@ This file is part of the iText (R) project.
 public class GridContainerRenderer extends BlockRenderer {
     private boolean isFirstLayout = true;
     private float containerHeight = 0.0f;
+    private float containerWidth = 0.0f;
     /**
      * Creates a Grid renderer from its corresponding layout object.
      * @param modelElement the {@link GridContainer} which this object should manage
@@ -72,14 +72,13 @@ public LayoutResult layout(LayoutContext layoutContext) {
 
         Rectangle actualBBox = layoutContext.getArea().getBBox().clone();
         Float blockWidth = retrieveWidth(actualBBox.getWidth());
-        if (blockWidth != null) {
-            actualBBox.setWidth((float) blockWidth);
-        }
 
         ContinuousContainer.setupContinuousContainerIfNeeded(this);
         applyPaddings(actualBBox, false);
         applyBorderBox(actualBBox, false);
         applyMargins(actualBBox, false);
+        applyWidth(actualBBox, blockWidth, OverflowPropertyValue.VISIBLE);
+        containerWidth = actualBBox.getWidth();
 
         Float blockHeight = retrieveHeight();
         if (blockHeight != null && (float) blockHeight < actualBBox.getHeight()) {
@@ -100,7 +99,7 @@ public LayoutResult layout(LayoutContext layoutContext) {
         } else {
             this.occupiedArea = calculateContainerOccupiedArea(layoutContext, false);
             return new LayoutResult(LayoutResult.PARTIAL, this.occupiedArea,
-                    createSplitRenderer(layoutResult.getSplitRenderers()),
+                    GridMulticolUtil.createSplitRenderer(layoutResult.getSplitRenderers(), this),
                     createOverflowRenderer(layoutResult.getOverflowRenderers()));
         }
     }
@@ -141,18 +140,6 @@ private static Boolean determineCollapsingMargins(IRenderer renderer) {
         return Boolean.FALSE;
     }
 
-    private AbstractRenderer createSplitRenderer(List<IRenderer> children) {
-        AbstractRenderer splitRenderer = (AbstractRenderer) getNextRenderer();
-        splitRenderer.parent = parent;
-        splitRenderer.modelElement = modelElement;
-        splitRenderer.occupiedArea = occupiedArea;
-        splitRenderer.isLastRendererForModelElement = false;
-        splitRenderer.setChildRenderers(children);
-        splitRenderer.addAllProperties(getOwnProperties());
-        ContinuousContainer.setupContinuousContainerIfNeeded(splitRenderer);
-        return splitRenderer;
-    }
-
     private AbstractRenderer createOverflowRenderer(List<IRenderer> children) {
         GridContainerRenderer overflowRenderer = (GridContainerRenderer) getNextRenderer();
         overflowRenderer.isFirstLayout = false;
@@ -273,67 +260,25 @@ private static LayoutContext getCellLayoutContext(LayoutContext layoutContext, R
     // Calculate grid container occupied area based on its width/height properties and cell layout areas
     private LayoutArea calculateContainerOccupiedArea(LayoutContext layoutContext, boolean isFull) {
         LayoutArea area = layoutContext.getArea().clone();
-        final float totalHeight = updateOccupiedHeight(containerHeight, isFull);
-        if (totalHeight < area.getBBox().getHeight() || isFull) {
-            area.getBBox().setHeight(totalHeight);
-            final Rectangle initialBBox = layoutContext.getArea().getBBox();
-            area.getBBox().setY(initialBBox.getY() + initialBBox.getHeight() - area.getBBox().getHeight());
-            recalculateHeightAndWidthAfterLayout(area.getBBox(), isFull);
-        }
-        return area;
-    }
-
-    // Recalculate height/width after grid sizing and re-apply height/width properties
-    private void recalculateHeightAndWidthAfterLayout(Rectangle bBox, boolean isFull) {
-        Float height = retrieveHeight();
-        if (height != null) {
-            height = updateOccupiedHeight((float) height, isFull);
-            float heightDelta = bBox.getHeight() - (float) height;
-            bBox.moveUp(heightDelta);
-            bBox.setHeight((float) height);
-        }
-        Float blockWidth = retrieveWidth(bBox.getWidth());
-        if (blockWidth != null) {
-            bBox.setWidth((float) blockWidth);
-        }
-    }
+        final Rectangle areaBBox = area.getBBox();
 
-    private float updateOccupiedHeight(float initialHeight, boolean isFull) {
-        if (isFull) {
-            initialHeight += safelyRetrieveFloatProperty(Property.PADDING_BOTTOM);
-            initialHeight += safelyRetrieveFloatProperty(Property.MARGIN_BOTTOM);
-            if (!this.hasOwnProperty(Property.BORDER) || this.<Border>getProperty(Property.BORDER) == null) {
-                initialHeight += safelyRetrieveFloatProperty(Property.BORDER_BOTTOM);
+        final float totalContainerHeight = GridMulticolUtil.updateOccupiedHeight(containerHeight, isFull, isFirstLayout, this);
+        if (totalContainerHeight < areaBBox.getHeight() || isFull) {
+            Float height = retrieveHeight();
+            if (height == null) {
+                areaBBox.setHeight(totalContainerHeight);
+            } else {
+                height = GridMulticolUtil.updateOccupiedHeight((float) height, isFull, isFirstLayout, this);
+                areaBBox.setHeight((float) height);
             }
         }
-        initialHeight += safelyRetrieveFloatProperty(Property.PADDING_TOP);
-
-        initialHeight += safelyRetrieveFloatProperty(Property.MARGIN_TOP);
 
-        if (!this.hasOwnProperty(Property.BORDER) || this.<Border>getProperty(Property.BORDER) == null) {
-            initialHeight += safelyRetrieveFloatProperty(Property.BORDER_TOP);
-        }
+        final Rectangle initialBBox = layoutContext.getArea().getBBox();
+        areaBBox.setY(initialBBox.getY() + initialBBox.getHeight() - areaBBox.getHeight());
 
-        // isFirstLayout is necessary to handle the case when grid container laid out on more
-        // than 2 pages, and on the last page layout result is full, but there is no bottom border
-        float TOP_AND_BOTTOM = isFull && isFirstLayout ? 2 : 1;
-        //If container laid out on more than 3 pages, then it is a page where there are no bottom and top borders
-        if (!isFull && !isFirstLayout) {
-            TOP_AND_BOTTOM = 0;
-        }
-        initialHeight += safelyRetrieveFloatProperty(Property.BORDER) * TOP_AND_BOTTOM;
-        return initialHeight;
-    }
-
-    private float safelyRetrieveFloatProperty(int property) {
-        final Object value = this.<Object>getProperty(property);
-        if (value instanceof UnitValue) {
-            return ((UnitValue) value).getValue();
-        }
-        if (value instanceof Border) {
-            return ((Border) value).getWidth();
-        }
-        return 0F;
+        final float totalContainerWidth = GridMulticolUtil.updateOccupiedWidth(containerWidth, this);
+        areaBBox.setWidth(totalContainerWidth);
+        return area;
     }
 
     // Grid layout algorithm is based on a https://drafts.csswg.org/css-grid/#layout-algorithm

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

@@ -0,0 +1,119 @@
+/*
+    This file is part of the iText (R) project.
+    Copyright (c) 1998-2024 Apryse Group NV
+    Authors: Apryse 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.renderer;
+
+import com.itextpdf.layout.borders.Border;
+import com.itextpdf.layout.properties.ContinuousContainer;
+import com.itextpdf.layout.properties.Property;
+import com.itextpdf.layout.properties.UnitValue;
+
+import java.util.List;
+
+/**
+ * The class stores common logic for multicol and grid layout.
+ */
+final class GridMulticolUtil {
+    private GridMulticolUtil() {
+        // do nothing
+    }
+
+    /**
+     * Creates a split renderer.
+     *
+     * @param children children of the split renderer
+     * @param renderer parent renderer
+     *
+     * @return a new {@link AbstractRenderer} instance
+     */
+    static AbstractRenderer createSplitRenderer(List<IRenderer> children, AbstractRenderer renderer) {
+        AbstractRenderer splitRenderer = (AbstractRenderer) renderer.getNextRenderer();
+        splitRenderer.parent = renderer.parent;
+        splitRenderer.modelElement = renderer.modelElement;
+        splitRenderer.occupiedArea = renderer.occupiedArea;
+        splitRenderer.isLastRendererForModelElement = false;
+        splitRenderer.setChildRenderers(children);
+        splitRenderer.addAllProperties(renderer.getOwnProperties());
+        ContinuousContainer.setupContinuousContainerIfNeeded(splitRenderer);
+        return splitRenderer;
+    }
+
+    static float updateOccupiedWidth(float initialWidth, AbstractRenderer renderer) {
+        float result = initialWidth;
+        result += safelyRetrieveFloatProperty(Property.PADDING_LEFT, renderer);
+        result += safelyRetrieveFloatProperty(Property.PADDING_RIGHT, renderer);
+
+        result += safelyRetrieveFloatProperty(Property.MARGIN_LEFT, renderer);
+        result += safelyRetrieveFloatProperty(Property.MARGIN_RIGHT, renderer);
+
+        if (!renderer.hasOwnProperty(Property.BORDER) || renderer.<Border>getProperty(Property.BORDER) == null) {
+            result += safelyRetrieveFloatProperty(Property.BORDER_LEFT, renderer);
+        }
+        if (!renderer.hasOwnProperty(Property.BORDER) || renderer.<Border>getProperty(Property.BORDER) == null) {
+            result += safelyRetrieveFloatProperty(Property.BORDER_RIGHT, renderer);
+        }
+        result += safelyRetrieveFloatProperty(Property.BORDER, renderer) * 2;
+
+        return result;
+    }
+
+    static float updateOccupiedHeight(float initialHeight, boolean isFull, boolean isFirstLayout,
+            AbstractRenderer renderer) {
+
+        float result = initialHeight;
+        if (isFull) {
+            result += safelyRetrieveFloatProperty(Property.PADDING_BOTTOM, renderer);
+            result += safelyRetrieveFloatProperty(Property.MARGIN_BOTTOM, renderer);
+            if (!renderer.hasOwnProperty(Property.BORDER) || renderer.<Border>getProperty(Property.BORDER) == null) {
+                result += safelyRetrieveFloatProperty(Property.BORDER_BOTTOM, renderer);
+            }
+        }
+        result += safelyRetrieveFloatProperty(Property.PADDING_TOP, renderer);
+
+        result += safelyRetrieveFloatProperty(Property.MARGIN_TOP, renderer);
+
+        if (!renderer.hasOwnProperty(Property.BORDER) || renderer.<Border>getProperty(Property.BORDER) == null) {
+            result += safelyRetrieveFloatProperty(Property.BORDER_TOP, renderer);
+        }
+
+        // isFirstLayout is necessary to handle the case when multicol container layouted in more
+        // than 2 pages, and on the last page layout result is full, but there is no bottom border
+        float TOP_AND_BOTTOM = isFull && isFirstLayout ? 2 : 1;
+        // Multicol container layouted in more than 3 pages, and there is a page where there are no bottom and top borders
+        if (!isFull && !isFirstLayout) {
+            TOP_AND_BOTTOM = 0;
+        }
+        result += safelyRetrieveFloatProperty(Property.BORDER, renderer) * TOP_AND_BOTTOM;
+        return result;
+    }
+
+    private static float safelyRetrieveFloatProperty(int property, AbstractRenderer renderer) {
+        final Object value = renderer.<Object>getProperty(property);
+        if (value instanceof UnitValue) {
+            return ((UnitValue) value).getValue();
+        }
+        if (value instanceof Border) {
+            return ((Border) value).getWidth();
+        }
+        return 0F;
+    }
+}