Discard FORCED_PLACEMENT property of a block renderer after some child is rendered

DEVSIX-6658

Author: Vitali Prudnikovich

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

@@ -184,6 +184,10 @@ public LayoutResult layout(LayoutContext layoutContext) {
         // the first renderer (one of childRenderers or their children) to produce LayoutResult.NOTHING
         IRenderer causeOfNothing = null;
         boolean anythingPlaced = false;
+        // We have to remember initial FORCED_PLACEMENT property of this renderer to use it later
+        // to define if rotated content should be placed or not
+        final boolean initialForcePlacementForRotationAdjustments =
+                Boolean.TRUE.equals(getPropertyAsBoolean(Property.FORCED_PLACEMENT));
         for (int childPos = 0; childPos < childRenderers.size(); childPos++) {
             IRenderer childRenderer = childRenderers.get(childPos);
             LayoutResult result;
@@ -334,6 +338,7 @@ public LayoutResult layout(LayoutContext layoutContext) {
                 }
             }
             anythingPlaced = anythingPlaced || result.getStatus() != LayoutResult.NOTHING;
+            handleForcedPlacement(anythingPlaced);
 
             // The second condition check (after &&) is needed only if margins collapsing is enabled
             if (result.getOccupiedArea() != null && (!FloatingHelper.isRendererFloating(childRenderer) || includeFloatsInOccupiedArea)) {
@@ -373,7 +378,8 @@ public LayoutResult layout(LayoutContext layoutContext) {
         }
 
         int layoutResult = LayoutResult.FULL;
-        boolean processOverflowedFloats = !waitingOverflowFloatRenderers.isEmpty() && !wasHeightClipped && !Boolean.TRUE.equals(getPropertyAsBoolean(Property.FORCED_PLACEMENT));
+        boolean processOverflowedFloats = !waitingOverflowFloatRenderers.isEmpty() && !wasHeightClipped &&
+                !Boolean.TRUE.equals(getPropertyAsBoolean(Property.FORCED_PLACEMENT));
 
         AbstractRenderer overflowRenderer = null;
         if (!includeFloatsInOccupiedArea || !processOverflowedFloats) {
@@ -453,7 +459,7 @@ public LayoutResult layout(LayoutContext layoutContext) {
                     LoggerFactory.getLogger(getClass())
                             .warn(MessageFormatUtil.format(LayoutLogMessageConstant.ELEMENT_DOES_NOT_FIT_AREA,
                                     "It fits by height so it will be forced placed"));
-                } else if (!Boolean.TRUE.equals(getPropertyAsBoolean(Property.FORCED_PLACEMENT))) {
+                } else if (!initialForcePlacementForRotationAdjustments) {
                     floatRendererAreas.retainAll(nonChildFloatingRendererAreas);
                     return new MinMaxWidthLayoutResult(LayoutResult.NOTHING, null, null, this, this);
                 }
@@ -646,7 +652,6 @@ AbstractRenderer[] createSplitAndOverflowRenderers(int childPos, int layoutStatu
             splitRenderer.childRenderers.add(childResult.getSplitRenderer());
         }
 
-
         replaceSplitRendererKidFloats(waitingFloatsSplitRenderers, splitRenderer);
         for (IRenderer renderer : splitRenderer.childRenderers) {
             renderer.setParent(splitRenderer);
@@ -1084,6 +1089,14 @@ public MinMaxWidth getMinMaxWidth() {
         return minMaxWidth;
     }
 
+    void handleForcedPlacement(boolean anythingPlaced) {
+        // We placed something meaning that we don't need this property anymore while processing other children
+        // to do not force place them
+        if (anythingPlaced && hasOwnProperty(Property.FORCED_PLACEMENT)) {
+            deleteOwnProperty(Property.FORCED_PLACEMENT);
+        }
+    }
+
     private void replaceSplitRendererKidFloats(Map<Integer, IRenderer> waitingFloatsSplitRenderers, IRenderer splitRenderer) {
         for (Map.Entry<Integer, IRenderer> waitingSplitRenderer : waitingFloatsSplitRenderers.entrySet()) {
             if (waitingSplitRenderer.getValue() != null) {

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

@@ -330,6 +330,12 @@ Rectangle recalculateLayoutBoxBeforeChildLayout(Rectangle layoutBox,
         return layoutBoxCopy;
     }
 
+    @Override
+    void handleForcedPlacement(boolean anythingPlaced) {
+        // In (horizontal) FlexContainerRenderer Property.FORCED_PLACEMENT is still valid for other children
+        // so do nothing
+    }
+
     void setHypotheticalCrossSize(Float mainSize, Float hypotheticalCrossSize) {
         hypotheticalCrossSizes.put(mainSize.floatValue(), hypotheticalCrossSize);
     }

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

@@ -127,13 +127,15 @@ public static Float retrieveRotatedLayoutWidth(float availableWidth, AbstractRen
             backup.<UnitValue>storeProperty(Property.HEIGHT);
             backup.<UnitValue>storeProperty(Property.MIN_HEIGHT);
             backup.<UnitValue>storeProperty(Property.MAX_HEIGHT);
+            backup.storeBoolProperty(Property.FORCED_PLACEMENT);
             MinMaxWidth minMaxWidth = renderer.getMinMaxWidth();
             //Using this width for initial layout helps in case of small elements. They may have more free spaces but it's more likely they fit.
             float length = (minMaxWidth.getMaxWidth() + minMaxWidth.getMinWidth()) / 2 + MinMaxWidthUtils.getEps();
             LayoutResult layoutResult = renderer.layout(new LayoutContext(new LayoutArea(1, new Rectangle(length, AbstractRenderer.INF))));
             backup.restoreProperty(Property.HEIGHT);
             backup.restoreProperty(Property.MIN_HEIGHT);
             backup.restoreProperty(Property.MAX_HEIGHT);
+            backup.restoreProperty(Property.FORCED_PLACEMENT);
 
             Rectangle additions = new Rectangle(0, 0);
             renderer.applyPaddings(additions, true);
@@ -188,6 +190,15 @@ public Float storeFloatProperty(int property) {
             return value;
         }
 
+        public Boolean storeBoolProperty(int property) {
+            Boolean value = renderer.getPropertyAsBoolean(property);
+            if (value != null) {
+                propertiesBackup.put(property, new PropertyBackup(value, renderer.hasOwnProperty(property)));
+                renderer.setProperty(property, null);
+            }
+            return value;
+        }
+
         public <T> T storeProperty(int property) {
             T value = renderer.<T>getProperty(property);
             if (value != null) {

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

@@ -1267,7 +1267,6 @@ public void floatsOnPageSplit06_03() throws IOException, InterruptedException {
         div.add(img);
         div.add(new Paragraph("some small text"));
 
-        // TODO DEVSIX-1655: blocks don't extend their height to MIN_HEIGHT if forced placement is applied, why?
         document.add(div);
 
         document.close();
@@ -1333,7 +1332,7 @@ public void floatsOnPageSplit08_01() throws IOException, InterruptedException {
     }
 
     @Test
-    @LogMessages(messages = @LogMessage(messageTemplate = LayoutLogMessageConstant.ELEMENT_DOES_NOT_FIT_AREA))
+    @LogMessages(messages = @LogMessage(messageTemplate = LayoutLogMessageConstant.ELEMENT_DOES_NOT_FIT_AREA, count = 2))
     public void floatsOnPageSplit08_02() throws IOException, InterruptedException {
         String cmpFileName = sourceFolder + "cmp_floatsOnPageSplit08_02.pdf";
         String outFile = destinationFolder + "floatsOnPageSplit08_02.pdf";
@@ -1358,10 +1357,6 @@ public void floatsOnPageSplit08_02() throws IOException, InterruptedException {
         document.add(containerDiv);
         document.close();
 
-        // TODO DEVSIX-1655: currently forced placement is applied on containerDiv, which results in all it's content
-        // being forced placed at once, rather than content being split more gracefully (it makes sense to put the second
-        // image on the next empty area, not on current area).
-
         Assert.assertNull(new CompareTool().compareByContent(outFile, cmpFileName, destinationFolder, "diff28_02_"));
     }
 
@@ -1382,14 +1377,12 @@ public void floatsOnPageSplit08_03() throws IOException, InterruptedException {
 
         // Adding normal image that will not fit on the first page and requires forced placement.
         containerDiv.add(img);
-// Adding more text that is naturally expected to be correctly shown.
+        // Adding more text that is naturally expected to be correctly shown.
         containerDiv.add(new Paragraph(text));
 
         document.add(containerDiv);
         document.close();
 
-        // TODO DEVSIX-1655: text in the container div gets lost. And floating property doesn't actually affect this.
-
         Assert.assertNull(new CompareTool().compareByContent(outFile, cmpFileName, destinationFolder, "diff28_03_"));
     }
 
@@ -1476,8 +1469,6 @@ public void floatsOnPageSplit11() throws IOException, InterruptedException {
         document.add(containerDiv);
         document.close();
 
-        // TODO DEVSIX-1655: Forced placement is applied to the parent element, forcing it to return FULL even though part of the child element overflowed.
-
         Assert.assertNull(new CompareTool().compareByContent(outFile, cmpFileName, destinationFolder, "diff31_"));
     }
 

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

@@ -278,7 +278,7 @@ public void imageTest07() throws IOException, InterruptedException {
 
     @Test
     @LogMessages(messages = {
-            @LogMessage(messageTemplate = LayoutLogMessageConstant.ELEMENT_DOES_NOT_FIT_AREA)
+            @LogMessage(messageTemplate = LayoutLogMessageConstant.ELEMENT_DOES_NOT_FIT_AREA, count = 2)
     })
     public void imageTest08() throws IOException, InterruptedException {
         String outFileName = destinationFolder + "imageTest08.pdf";