Improve LayoutResult.NOTHING processing of the cells and a container itself, add proper forced placement logic

DEVSIX-8329

Author: vitali-pr

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

@@ -31,6 +31,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.layout.properties.ContinuousContainer;
 import com.itextpdf.layout.properties.GridFlow;
 import com.itextpdf.layout.properties.GridValue;
+import com.itextpdf.layout.properties.OverflowPropertyValue;
 import com.itextpdf.layout.properties.Property;
 import com.itextpdf.layout.properties.UnitValue;
 
@@ -85,31 +86,15 @@ public LayoutResult layout(LayoutContext layoutContext) {
         Grid grid = constructGrid(this, actualBBox);
         GridLayoutResult layoutResult = layoutGrid(layoutContext, actualBBox, grid);
 
-        //TODO DEVSIX-8329 improve nothing processing, consider checking for cause of nothing here?
-        //TODO DEVSIX-8329 improve forced placement logic
-        if (layoutResult.getOverflowRenderers().isEmpty() && layoutResult.getSplitRenderers().isEmpty()) {
+        if (layoutResult.getOverflowRenderers().isEmpty()) {
             this.occupiedArea = calculateContainerOccupiedArea(layoutContext, grid, true);
             return new LayoutResult(LayoutResult.FULL, this.occupiedArea, null, null);
         } else if (layoutResult.getSplitRenderers().isEmpty()) {
-            if (Boolean.TRUE.equals(this.<Boolean>getProperty(Property.FORCED_PLACEMENT))) {
-                this.occupiedArea = calculateContainerOccupiedArea(layoutContext, grid, true);
-                return new LayoutResult(LayoutResult.FULL,  this.occupiedArea, this, null);
-            }
             IRenderer cause = this;
             if (!layoutResult.getCauseOfNothing().isEmpty()) {
                 cause = layoutResult.getCauseOfNothing().get(0);
             }
             return new LayoutResult(LayoutResult.NOTHING, null, null, this, cause);
-        } else if (layoutResult.getOverflowRenderers().isEmpty()) {
-            final ContinuousContainer continuousContainer = this.<ContinuousContainer>getProperty(
-                    Property.TREAT_AS_CONTINUOUS_CONTAINER_RESULT);
-            if (continuousContainer != null) {
-                continuousContainer.reApplyProperties(this);
-            }
-            this.childRenderers.clear();
-            this.addAllChildRenderers(layoutResult.getSplitRenderers());
-            this.occupiedArea = calculateContainerOccupiedArea(layoutContext, grid, true);
-            return new LayoutResult(LayoutResult.FULL, this.occupiedArea, this, null);
         } else {
             this.occupiedArea = calculateContainerOccupiedArea(layoutContext, grid, false);
             return new LayoutResult(LayoutResult.PARTIAL, this.occupiedArea,
@@ -118,6 +103,16 @@ public LayoutResult layout(LayoutContext layoutContext) {
         }
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public void addChild(IRenderer renderer) {
+        renderer.setProperty(Property.OVERFLOW_X, OverflowPropertyValue.VISIBLE);
+        renderer.setProperty(Property.OVERFLOW_Y, OverflowPropertyValue.VISIBLE);
+        super.addChild(renderer);
+    }
+
     private AbstractRenderer createSplitRenderer(List<IRenderer> children) {
         AbstractRenderer splitRenderer = (AbstractRenderer) getNextRenderer();
         splitRenderer.parent = parent;
@@ -131,6 +126,7 @@ private AbstractRenderer createSplitRenderer(List<IRenderer> children) {
     }
 
     private AbstractRenderer createOverflowRenderer(List<IRenderer> children) {
+        // TODO DEVSIX-8340 - We put the original amount of rows into overflow container.
         GridContainerRenderer overflowRenderer = (GridContainerRenderer) getNextRenderer();
         overflowRenderer.isFirstLayout = false;
         overflowRenderer.parent = parent;
@@ -145,30 +141,39 @@ private AbstractRenderer createOverflowRenderer(List<IRenderer> children) {
     private GridLayoutResult layoutGrid(LayoutContext layoutContext, Rectangle actualBBox, Grid grid) {
         GridLayoutResult layoutResult = new GridLayoutResult();
         ensureTemplateValuesFit(grid, actualBBox);
-        //TODO DEVSIX-8329 improve forced placement logic, right now if we have a cell which could not be fitted on its
-        // area or returns nothing as layout result RootRenderer sets FORCED_PLACEMENT on this class instance.
-        // And basically every cell inherits this value and force placed, but we only need to force place cells
-        // which were not fitted originally.
+
         for (GridCell cell : grid.getUniqueGridCells(Grid.GridOrder.ROW)) {
-            //If cell couldn't fit during cell layout area calculation than we need to put such cell straight to
-            //nothing result list
-            if (!cell.isValueFitOnCellArea()) {
-                layoutResult.getOverflowRenderers().add(cell.getValue());
-                layoutResult.getCauseOfNothing().add(cell.getValue());
-                continue;
-            }
-            //Calculate cell layout context by getting actual x and y on parent layout area for it
+            // Calculate cell layout context by getting actual x and y on parent layout area for it
             LayoutContext cellContext = getCellLayoutContext(layoutContext, actualBBox, cell);
-            //We need to check for forced placement here, because otherwise we would infinitely return partial result.
-            if (!Boolean.TRUE.equals(this.<Boolean>getProperty(Property.FORCED_PLACEMENT))
-                    && !actualBBox.contains(cellContext.getArea().getBBox())) {
-                layoutResult.getOverflowRenderers().add(cell.getValue());
-                continue;
-            }
 
             IRenderer cellToRender = cell.getValue();
-            cellToRender.setProperty(Property.FILL_AVAILABLE_AREA, true);
             cellToRender.setProperty(Property.COLLAPSING_MARGINS, Boolean.FALSE);
+
+            // Now set the height for the individual items
+            // We know cell height upfront and this way we tell the element what it can occupy
+            Rectangle cellBBox = cellContext.getArea().getBBox();
+            if (!cellToRender.hasProperty(Property.HEIGHT)) {
+                final Rectangle rectangleWithoutBordersMarginsPaddings = cellBBox.clone();
+                if (cellToRender instanceof AbstractRenderer) {
+                    final AbstractRenderer abstractCellRenderer = ((AbstractRenderer) cellToRender);
+                    // We subtract margins/borders/paddings because we should take into account that
+                    // borders/paddings/margins should also fit into a cell.
+                    if (AbstractRenderer.isBorderBoxSizing(cellToRender)) {
+                        abstractCellRenderer.applyMargins(rectangleWithoutBordersMarginsPaddings, false);
+                    } else {
+                        abstractCellRenderer.applyMarginsBordersPaddings(rectangleWithoutBordersMarginsPaddings, false);
+                    }
+                }
+
+                cellToRender.setProperty(Property.HEIGHT,
+                        UnitValue.createPointValue(rectangleWithoutBordersMarginsPaddings.getHeight()));
+            }
+
+            // Adjust cell BBox to the remaining part of the layout bbox
+            // This way we can layout elements partially
+            cellBBox.setHeight(cellBBox.getTop() - actualBBox.getBottom())
+                    .setY(actualBBox.getY());
+
             LayoutResult cellResult = cellToRender.layout(cellContext);
 
             if (cellResult.getStatus() == LayoutResult.NOTHING) {

layout/src/test/java/com/itextpdf/layout/element/GridContainerTest.java

@@ -489,6 +489,7 @@ public void threeColumnsWithSquareCellAndCellWithExplicitHeightTest() throws IOE
 
         try (Document document = new Document(new PdfDocument(new PdfWriter(filename)))) {
             GridContainer grid = new GridContainer();
+            grid.setBackgroundColor(ColorConstants.GREEN);
             SolidBorder border = new SolidBorder(ColorConstants.BLUE, 1);
             grid.setProperty(Property.GRID_TEMPLATE_COLUMNS, templateColumns);
             Paragraph paragraph1 = new Paragraph("One");

layout/src/test/java/com/itextpdf/layout/element/gridcontainer/GridContainerLayoutTest.java

@@ -35,8 +35,10 @@ This file is part of the iText (R) project.
 import com.itextpdf.layout.borders.SolidBorder;
 import com.itextpdf.layout.element.Div;
 import com.itextpdf.layout.element.GridContainer;
+import com.itextpdf.layout.element.Image;
 import com.itextpdf.layout.element.Paragraph;
 import com.itextpdf.layout.element.Text;
+import com.itextpdf.layout.logs.LayoutLogMessageConstant;
 import com.itextpdf.layout.properties.BackgroundImage;
 import com.itextpdf.layout.properties.BackgroundRepeat;
 import com.itextpdf.layout.properties.BackgroundRepeat.BackgroundRepeatValue;
@@ -45,6 +47,9 @@ This file is part of the iText (R) project.
 import com.itextpdf.layout.properties.Property;
 import com.itextpdf.layout.properties.UnitValue;
 import com.itextpdf.test.ExtendedITextTest;
+import com.itextpdf.test.LogLevelConstants;
+import com.itextpdf.test.annotations.LogMessage;
+import com.itextpdf.test.annotations.LogMessages;
 import com.itextpdf.test.annotations.type.IntegrationTest;
 
 import java.io.IOException;
@@ -198,26 +203,48 @@ public void emptyGridContainerTest() throws IOException, InterruptedException {
                 DESTINATION_FOLDER, "diff"));
     }
 
+    // TODO DEVSIX-8340
+    @Test
+    public void overflowGridContainerTest() throws IOException, InterruptedException {
+        String fileName = DESTINATION_FOLDER + "overflowGridContainer.pdf";
+        PdfDocument pdfDocument = new PdfDocument(new PdfWriter(fileName));
+        Document document = new Document(pdfDocument);
 
-    private GridContainer createGridBoxWithSizedDiv() {
-        GridContainer gridcontainer0 = new GridContainer();
+        GridContainer gridcontainer0 = createGridBoxWithText();
 
-        gridcontainer0.setProperty(Property.COLUMN_GAP_BORDER, null);
-        gridcontainer0.setProperty(Property.GRID_TEMPLATE_COLUMNS,
-                Arrays.asList(new UnitValue(1, 150.0f), new UnitValue(1, 150.0f), new UnitValue(1, 150.0f)));
-        gridcontainer0.setProperty(Property.COLUMN_GAP, 12.0f);
-        gridcontainer0.setBackgroundColor(ColorConstants.RED);
-        for (int i = 0; i < 4; i++) {
-            Div div1 = new Div();
-            div1.setBackgroundColor(ColorConstants.YELLOW);
-            div1.setHeight(20);
-            div1.setWidth(30);
-            div1.setProperty(Property.COLUMN_GAP_BORDER, null);
-            div1.setProperty(Property.COLUMN_GAP, 12.0f);
-            gridcontainer0.add(div1);
-        }
-        return gridcontainer0;
+        gridcontainer0.setBackgroundColor(ColorConstants.MAGENTA);
+        gridcontainer0.setProperty(Property.GRID_TEMPLATE_ROWS,
+                Arrays.asList(
+                        GridValue.createUnitValue(new UnitValue(1, 500.0f)),
+                        GridValue.createUnitValue(new UnitValue(1, 500.0f)),
+                        GridValue.createUnitValue(new UnitValue(1, 500.0f))));
+
+        gridcontainer0.add(new Image(ImageDataFactory.create(SOURCE_FOLDER + "rock_texture.jpg")).setHeight(150));
+        document.add(gridcontainer0);
+
+        document.close();
+
+        Assert.assertNull(new CompareTool().compareByContent(fileName, SOURCE_FOLDER + "cmp_overflowGridContainer.pdf",
+                DESTINATION_FOLDER, "diff"));
+    }
+
+    @Test
+    @LogMessages(messages = {
+            @LogMessage(messageTemplate = LayoutLogMessageConstant.ELEMENT_DOES_NOT_FIT_AREA, logLevel =
+                    LogLevelConstants.WARN)})
+    public void nothingResultTest() throws IOException, InterruptedException {
+        String fileName = DESTINATION_FOLDER + "nothingResult.pdf";
+        PdfDocument pdfDocument = new PdfDocument(new PdfWriter(fileName));
+        Document document = new Document(pdfDocument);
+
+        GridContainer gridcontainer = new GridContainer();
+        gridcontainer.add(new Image(ImageDataFactory.create(SOURCE_FOLDER + "rock_texture.jpg")).setHeight(1200));
+        document.add(gridcontainer);
+
+        document.close();
 
+        Assert.assertNull(new CompareTool().compareByContent(fileName, SOURCE_FOLDER + "cmp_nothingResult.pdf",
+                DESTINATION_FOLDER, "diff"));
     }
 
     private GridContainer createGridBoxWithText() {
@@ -289,6 +316,4 @@ private GridContainer createGridBoxWithText() {
         gridcontainer0.add(div13);
         return gridcontainer0;
     }
-
-
 }