Add support for inline block elements

DEVSIX-1053

Author: Snipx

io/src/main/java/com/itextpdf/io/LogMessageConstant.java

@@ -76,6 +76,7 @@ public final class LogMessageConstant {
     public static final String IMAGE_HAS_JPXDECODE_FILTER = "Image cannot be inline if it has JPXDecode filter. It will be added as an ImageXObject";
     public static final String IMAGE_SIZE_CANNOT_BE_MORE_4KB = "Inline image size cannot be more than 4KB. It will be added as an ImageXObject";
     public static final String INCORRECT_PAGEROTATION = "Encounterd a page rotation that was not a multiple of 90°/ (Pi/2) when generating default appearances for form fields";
+    public static final String INLINE_BLOCK_ELEMENT_WILL_BE_CLIPPED = "Inline block element does not fit into parent element and will be clipped";
     public static final String INPUT_STREAM_CONTENT_IS_LOST_ON_PDFSTREAM_SERIALIZATION = "PdfStream contains not null input stream. It's content will be lost in serialized object.";
     public static final String INVALID_INDIRECT_REFERENCE = "Invalid indirect reference {0} {1} R";
     public static final String INVALID_KEY_VALUE_KEY_0_HAS_NULL_VALUE = "Invalid key value: key {0} has null value.";

layout/src/main/java/com/itextpdf/layout/element/Paragraph.java

@@ -106,6 +106,11 @@ public Paragraph add(ILeafElement element) {
         return this;
     }
 
+    public Paragraph add(IBlockElement element) {
+        childElements.add(element);
+        return this;
+    }
+
     /**
      * Adds a {@link java.util.List} of layout elements to the Paragraph.
      * @param elements the content to be added, any {@link ILeafElement}

layout/src/main/java/com/itextpdf/layout/margincollapse/MarginsCollapseHandler.java

@@ -46,9 +46,11 @@ This file is part of the iText (R) project.
 import com.itextpdf.layout.IPropertyContainer;
 import com.itextpdf.layout.property.FloatPropertyValue;
 import com.itextpdf.layout.property.Property;
+import com.itextpdf.layout.renderer.AbstractRenderer;
 import com.itextpdf.layout.renderer.BlockRenderer;
 import com.itextpdf.layout.renderer.CellRenderer;
 import com.itextpdf.layout.renderer.IRenderer;
+import com.itextpdf.layout.renderer.LineRenderer;
 import com.itextpdf.layout.renderer.RootRenderer;
 import com.itextpdf.layout.renderer.TableRenderer;
 
@@ -473,7 +475,9 @@ private static boolean marginsCouldBeSelfCollapsing(IRenderer renderer) {
         return !(renderer instanceof TableRenderer)
                 && !rendererIsFloated(renderer)
                 && !hasBottomBorders(renderer) && !hasTopBorders(renderer)
-                && !hasBottomPadding(renderer) && !hasTopPadding(renderer) && !hasPositiveHeight(renderer);
+                && !hasBottomPadding(renderer) && !hasTopPadding(renderer) && !hasPositiveHeight(renderer)
+                // inline block
+                && !(isBlockElement(renderer) && renderer instanceof AbstractRenderer && ((AbstractRenderer) renderer).getParent() instanceof LineRenderer);
     }
 
     private static boolean firstChildMarginAdjoinedToParent(IRenderer parent) {
@@ -486,7 +490,6 @@ private static boolean lastChildMarginAdjoinedToParent(IRenderer parent) {
                 && !rendererIsFloated(parent) && !hasBottomBorders(parent) && !hasBottomPadding(parent) && !hasHeightProp(parent);
     }
 
-
     private static boolean isBlockElement(IRenderer renderer) {
         return renderer instanceof BlockRenderer || renderer instanceof TableRenderer;
     }

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

@@ -741,6 +741,22 @@ protected Float getFirstYLineRecursively() {
         return ((AbstractRenderer) childRenderers.get(0)).getFirstYLineRecursively();
     }
 
+    protected Float getLastYLineRecursively() {
+        if (childRenderers.size() == 0) {
+            return null;
+        }
+        for (int i = childRenderers.size() - 1; i >= 0; i--) {
+            IRenderer child = childRenderers.get(i);
+            if (child instanceof AbstractRenderer) {
+                Float lastYLine = ((AbstractRenderer) child).getLastYLineRecursively();
+                if (lastYLine != null) {
+                    return lastYLine;
+                }
+            }
+        }
+        return null;
+    }
+
     /**
      * Applies margins of the renderer on the given rectangle
      *

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

@@ -43,6 +43,7 @@ This file is part of the iText (R) project.
  */
 package com.itextpdf.layout.renderer;
 
+import com.itextpdf.io.LogMessageConstant;
 import com.itextpdf.io.font.otf.Glyph;
 import com.itextpdf.io.font.otf.GlyphLine;
 import com.itextpdf.io.util.ArrayUtil;
@@ -62,6 +63,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.layout.property.Property;
 import com.itextpdf.layout.property.TabAlignment;
 import com.itextpdf.layout.property.UnitValue;
+import org.slf4j.LoggerFactory;
 
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -74,6 +76,10 @@ public class LineRenderer extends AbstractRenderer {
 
     protected float maxAscent;
     protected float maxDescent;
+    private float maxTextAscent;
+    private float maxTextDescent;
+    private float maxBlockAscent;
+    private float maxBlockDescent;
 
     // bidi levels
     protected byte[] levels;
@@ -92,6 +98,10 @@ public LineLayoutResult layout(LayoutContext layoutContext) {
         float curWidth = 0;
         maxAscent = 0;
         maxDescent = 0;
+        maxTextAscent = 0;
+        maxTextDescent = 0;
+        maxBlockAscent = -1e20f;
+        maxBlockDescent = 1e20f;
         int childPos = 0;
 
         MinMaxWidth minMaxWidth = new MinMaxWidth(0, layoutBox.getWidth());
@@ -117,7 +127,7 @@ public LineLayoutResult layout(LayoutContext layoutContext) {
 
         while (childPos < childRenderers.size()) {
             IRenderer childRenderer = childRenderers.get(childPos);
-            LayoutResult childResult;
+            LayoutResult childResult = null;
             Rectangle bbox = new Rectangle(layoutBox.getX() + curWidth, layoutBox.getY(), layoutBox.getWidth() - curWidth, layoutBox.getHeight());
 
             if (childRenderer instanceof TextRenderer) {
@@ -241,7 +251,33 @@ public LineLayoutResult layout(LayoutContext layoutContext) {
                 continue;
             }
 
-            childResult = childRenderer.layout(new LayoutContext(new LayoutArea(layoutContext.getArea().getPageNumber(), bbox)));
+            MinMaxWidth childBlockMinMaxWidth = null;
+            boolean isInlineBlockChild = isInlineBlockChild(childRenderer);
+            if (!childWidthWasReplaced) {
+                if (isInlineBlockChild && childRenderer instanceof AbstractRenderer) {
+                    childBlockMinMaxWidth = ((AbstractRenderer)childRenderer).getMinMaxWidth(layoutContext.getArea().getBBox().getWidth());
+                    // TODO fix eps?
+                    float eps = 0.001f;
+                    float childMaxWidth = childBlockMinMaxWidth.getMaxWidth() + eps;
+                    // Decrease the calculated width by margins, paddings and borders so that even for 100% width the content definitely fits
+                    // TODO DEVSIX-1174 fix depending on box-sizing
+                    if (childBlockMinMaxWidth != null) {
+                        if (childMaxWidth > bbox.getWidth() && bbox.getWidth() != layoutContext.getArea().getBBox().getWidth()) {
+                            childResult = new LineLayoutResult(LayoutResult.NOTHING, null, null, childRenderer, childRenderer);
+                        } else {
+                            if (bbox.getWidth() == layoutContext.getArea().getBBox().getWidth() && childBlockMinMaxWidth.getMinWidth() > layoutContext.getArea().getBBox().getWidth()) {
+                                LoggerFactory.getLogger(LineRenderer.class).warn(LogMessageConstant.INLINE_BLOCK_ELEMENT_WILL_BE_CLIPPED);
+                                childRenderer.setProperty(Property.FORCED_PLACEMENT, true);
+                            }
+                            bbox.setWidth(childMaxWidth);
+                        }
+                    }
+                }
+            }
+
+            if (childResult == null) {
+                childResult = childRenderer.layout(new LayoutContext(new LayoutArea(layoutContext.getArea().getPageNumber(), bbox)));
+            }
 
             // Get back child width so that it's not lost
             if (childWidthWasReplaced) {
@@ -259,17 +295,44 @@ public LineLayoutResult layout(LayoutContext layoutContext) {
                     minChildWidth = ((MinMaxWidthLayoutResult) childResult).getNotNullMinMaxWidth(bbox.getWidth()).getMinWidth();
                 }
                 maxChildWidth = ((MinMaxWidthLayoutResult) childResult).getNotNullMinMaxWidth(bbox.getWidth()).getMaxWidth();
+            } else if (childBlockMinMaxWidth != null) {
+                minChildWidth = childBlockMinMaxWidth.getMinWidth();
+                maxChildWidth = childBlockMinMaxWidth.getMaxWidth();
             }
 
             float childAscent = 0;
             float childDescent = 0;
-            if (childRenderer instanceof ILeafElementRenderer) {
+            if (childRenderer instanceof ILeafElementRenderer && childResult.getStatus() != LayoutResult.NOTHING) {
                 childAscent = ((ILeafElementRenderer) childRenderer).getAscent();
                 childDescent = ((ILeafElementRenderer) childRenderer).getDescent();
+            } else if (isInlineBlockChild && childResult.getStatus() != LayoutResult.NOTHING) {
+                if (childRenderer instanceof AbstractRenderer) {
+                    Float yLine = ((AbstractRenderer)childRenderer).getLastYLineRecursively();
+                    if (yLine == null) {
+                        childAscent = childRenderer.getOccupiedArea().getBBox().getHeight();
+                    } else {
+                        childAscent = childRenderer.getOccupiedArea().getBBox().getTop() - (float)yLine;
+                        childDescent = -((float)yLine - childRenderer.getOccupiedArea().getBBox().getBottom());
+                    }
+                } else {
+                    childAscent = childRenderer.getOccupiedArea().getBBox().getHeight();
+                }
             }
 
             maxAscent = Math.max(maxAscent, childAscent);
+            // TODO treat images as blocks
+            if (childRenderer instanceof TextRenderer || childRenderer instanceof ImageRenderer) {
+                maxTextAscent = Math.max(maxTextAscent, childAscent);
+            } else if (!isChildFloating) {
+                maxBlockAscent = Math.max(maxBlockAscent, childAscent);
+            }
             maxDescent = Math.min(maxDescent, childDescent);
+            // TODO treat images as blocks
+            if (childRenderer instanceof TextRenderer || childRenderer instanceof ImageRenderer) {
+                maxTextDescent = Math.min(maxTextDescent, childDescent);
+            } else if (!isChildFloating) {
+                maxBlockDescent = Math.min(maxBlockDescent, childDescent);
+            }
             float maxHeight = maxAscent - maxDescent;
 
             boolean newLineOccurred = (childResult instanceof TextLayoutResult && ((TextLayoutResult) childResult).isSplitForcedByNewline());
@@ -302,7 +365,9 @@ public LineLayoutResult layout(LayoutContext layoutContext) {
                 widthHandler.updateMaxChildWidth(tabWidth + maxChildWidth);
                 hangingTabStop = null;
             } else if (null == hangingTabStop) {
-                curWidth += childResult.getOccupiedArea().getBBox().getWidth();
+                if (childResult.getOccupiedArea() != null && childResult.getOccupiedArea().getBBox() != null) {
+                    curWidth += childResult.getOccupiedArea().getBBox().getWidth();
+                }
                 widthHandler.updateMinChildWidth(minChildWidth);
                 widthHandler.updateMaxChildWidth(maxChildWidth);
             }
@@ -325,13 +390,23 @@ public LineLayoutResult layout(LayoutContext layoutContext) {
                     split[1].childRenderers.add(childRenderer);
                     split[1].childRenderers.addAll(childRenderers.subList(childPos + 1, childRenderers.size()));
                 } else {
-                    if (childResult.getStatus() == LayoutResult.PARTIAL || childResult.getStatus() == LayoutResult.FULL) {
+                    boolean forcePlacement = Boolean.TRUE.equals(getPropertyAsBoolean(Property.FORCED_PLACEMENT));
+                    boolean isInlineBlockAndFirstOnRootArea = isInlineBlockChild && isFirstOnRootArea();
+                    if (childResult.getStatus() == LayoutResult.PARTIAL && (!isInlineBlockChild || forcePlacement || isInlineBlockAndFirstOnRootArea) || childResult.getStatus() == LayoutResult.FULL) {
                         split[0].addChild(childResult.getSplitRenderer());
                         anythingPlaced = true;
                     }
 
                     if (null != childResult.getOverflowRenderer()) {
-                        split[1].childRenderers.add(childResult.getOverflowRenderer());
+                        if (isInlineBlockChild && !forcePlacement && !isInlineBlockAndFirstOnRootArea) {
+                            split[1].childRenderers.add(childRenderer);
+                        } else {
+                            if (isInlineBlockChild && childResult.getOverflowRenderer().getChildRenderers().size() == 0) {
+                                LoggerFactory.getLogger(LineRenderer.class).warn(LogMessageConstant.INLINE_BLOCK_ELEMENT_WILL_BE_CLIPPED);
+                            } else {
+                                split[1].childRenderers.add(childResult.getOverflowRenderer());
+                            }
+                        }
                     }
                     split[1].childRenderers.addAll(childRenderers.subList(childPos + 1, childRenderers.size()));
                 }
@@ -540,9 +615,9 @@ public float getYLine() {
     public float getLeadingValue(Leading leading) {
         switch (leading.getType()) {
             case Leading.FIXED:
-                return leading.getValue();
+                return Math.max(leading.getValue(), maxBlockAscent - maxBlockDescent);
             case Leading.MULTIPLIED:
-                return occupiedArea.getBBox().getHeight() * leading.getValue();
+                return getTopLeadingIndent(leading) + getBottomLeadingIndent(leading);
             default:
                 throw new IllegalStateException();
         }
@@ -558,6 +633,11 @@ protected Float getFirstYLineRecursively() {
         return getYLine();
     }
 
+    @Override
+    protected Float getLastYLineRecursively() {
+        return getYLine();
+    }
+
     public void justify(float width) {
         float ratio = (float) this.getPropertyAsFloat(Property.SPACING_RATIO);
         float freeWidth = occupiedArea.getBBox().getX() + width -
@@ -649,6 +729,10 @@ protected LineRenderer[] split() {
         splitRenderer.parent = parent;
         splitRenderer.maxAscent = maxAscent;
         splitRenderer.maxDescent = maxDescent;
+        splitRenderer.maxTextAscent = maxTextAscent;
+        splitRenderer.maxTextDescent = maxTextDescent;
+        splitRenderer.maxBlockAscent = maxBlockAscent;
+        splitRenderer.maxBlockDescent = maxBlockDescent;
         splitRenderer.levels = levels;
         splitRenderer.addAllProperties(getOwnProperties());
 
@@ -669,7 +753,8 @@ protected LineRenderer adjustChildrenYLine() {
                 float descent = ((ILeafElementRenderer) renderer).getDescent();
                 renderer.move(0, actualYLine - renderer.getOccupiedArea().getBBox().getBottom() + descent);
             } else {
-                renderer.move(0, occupiedArea.getBBox().getY() - renderer.getOccupiedArea().getBBox().getBottom());
+                Float yLine = isInlineBlockChild(renderer) && renderer instanceof AbstractRenderer ? ((AbstractRenderer) renderer).getLastYLineRecursively() : null;
+                renderer.move(0, actualYLine - (yLine == null ? renderer.getOccupiedArea().getBBox().getBottom() : (float)yLine));
             }
         }
         return this;
@@ -717,11 +802,33 @@ protected MinMaxWidth getMinMaxWidth(float availableWidth) {
     }
 
     float getTopLeadingIndent(Leading leading) {
-        return (getLeadingValue(leading) - occupiedArea.getBBox().getHeight()) / 2;
+        switch (leading.getType()) {
+            case Leading.FIXED:
+                return (Math.max(leading.getValue(), maxBlockAscent - maxBlockDescent) - occupiedArea.getBBox().getHeight()) / 2;
+            case Leading.MULTIPLIED:
+                float fontSize = (float)this.getPropertyAsFloat(Property.FONT_SIZE, 0f);
+                // TODO contains image to be removed
+                float textAscent = maxTextAscent == 0 && maxTextDescent == 0 && Math.abs(maxAscent) + Math.abs(maxDescent) != 0 && !containsImage() ? fontSize * 0.8f : maxTextAscent;
+                float textDescent = maxTextAscent == 0 && maxTextDescent == 0 && Math.abs(maxAscent) + Math.abs(maxDescent) != 0 && !containsImage() ? -fontSize * 0.2f : maxTextDescent;
+                return Math.max(textAscent + ((textAscent - textDescent) * (leading.getValue() - 1)) / 2, maxBlockAscent) - maxAscent;
+            default:
+                throw new IllegalStateException();
+        }
     }
 
     float getBottomLeadingIndent(Leading leading) {
-        return (getLeadingValue(leading) - occupiedArea.getBBox().getHeight()) / 2;
+        switch (leading.getType()) {
+            case Leading.FIXED:
+                return (Math.max(leading.getValue(), maxBlockAscent - maxBlockDescent) - occupiedArea.getBBox().getHeight()) / 2;
+            case Leading.MULTIPLIED:
+                float fontSize = (float)this.getPropertyAsFloat(Property.FONT_SIZE, 0f);
+                // TODO contains image to be removed
+                float textAscent = maxTextAscent == 0 && maxTextDescent == 0 && !containsImage() ? fontSize * 0.8f : maxTextAscent;
+                float textDescent = maxTextAscent == 0 && maxTextDescent == 0 && !containsImage() ? -fontSize * 0.2f : maxTextDescent;
+                return Math.max(-textDescent + ((textAscent - textDescent) * (leading.getValue() - 1)) / 2, -maxBlockDescent) + maxDescent;
+            default:
+                throw new IllegalStateException();
+        }
     }
 
     private LineRenderer[] splitNotFittingFloat(int childPos, LayoutResult childResult) {
@@ -966,6 +1073,9 @@ private void resolveChildrenFonts() {
         }
     }
 
+    private boolean isInlineBlockChild(IRenderer child) {
+        return child instanceof BlockRenderer || child instanceof TableRenderer;
+    }
 
     static class RendererGlyph {
         public RendererGlyph(Glyph glyph, TextRenderer textRenderer) {

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

@@ -494,6 +494,20 @@ protected Float getFirstYLineRecursively() {
         return lines.get(0).getFirstYLineRecursively();
     }
 
+    @Override
+    protected Float getLastYLineRecursively() {
+        if (lines == null || lines.size() == 0) {
+            return null;
+        }
+        for (int i = lines.size() - 1; i >= 0; i--) {
+            Float yLine = lines.get(i).getLastYLineRecursively();
+            if (yLine != null) {
+                return yLine;
+            }
+        }
+        return null;
+    }
+
     @Deprecated
     protected ParagraphRenderer createOverflowRenderer() {
         return (ParagraphRenderer) getNextRenderer();

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

@@ -1193,6 +1193,11 @@ protected MinMaxWidth getMinMaxWidth(float availableWidth) {
         return new MinMaxWidth(additionalWidth, availableWidth, minWidth, maxColTotalWidth);
     }
 
+    @Override
+    protected Float getLastYLineRecursively() {
+        return null;
+    }
+
     private void initializeTableLayoutBorders() {
         bordersHandler = new CollapsedTableBorders(rows, ((Table) getModelElement()).getNumberOfColumns(), getBorders());
         bordersHandler.initializeBorders();

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

@@ -1002,6 +1002,11 @@ protected Float getFirstYLineRecursively() {
         return getYLine();
     }
 
+    @Override
+    protected Float getLastYLineRecursively() {
+        return getYLine();
+    }
+
     /**
      * Returns the length of the {@link com.itextpdf.layout.renderer.TextRenderer#line line} which is the result of the layout call.
      *