Consider the margins of this document while obtaining list item's effective area

DEVSIX-6371

Author: Evgeniy Prudnikov

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

@@ -49,7 +49,6 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.pdf.PdfDocument;
 import com.itextpdf.kernel.pdf.PdfPage;
 import com.itextpdf.kernel.pdf.tagging.StandardRoles;
-import com.itextpdf.layout.Document;
 import com.itextpdf.layout.element.ListItem;
 import com.itextpdf.layout.element.Paragraph;
 import com.itextpdf.layout.layout.LayoutContext;
@@ -364,8 +363,20 @@ private Rectangle obtainEffectiveArea(DrawContext drawContext) {
             pageSize = pdfDocument.getDefaultPageSize();
         }
 
-        Document document = new Document(pdfDocument);
-        return new Rectangle(pageSize).applyMargins(document.getTopMargin(), document.getRightMargin(), document.getBottomMargin(),
-                                     document.getLeftMargin(), false);
+        RootRenderer rootRenderer = this.getRootRenderer();
+        //TODO DEVSIX-6372 Obtaining DocumentRenderer's margins results in a ClassCastException
+        Float[] margins = new Float[] {rootRenderer.<Float>getProperty(Property.MARGIN_TOP),
+                rootRenderer.<Float>getProperty(Property.MARGIN_RIGHT),
+                rootRenderer.<Float>getProperty(Property.MARGIN_BOTTOM),
+                rootRenderer.<Float>getProperty(Property.MARGIN_LEFT)};
+        for (int i = 0; i < margins.length; i++) {
+            margins[i] = replaceIfNull(margins[i], 0f);
+        }
+        return new Rectangle(pageSize)
+                .applyMargins((float) margins[0], (float) margins[1], (float) margins[2], (float) margins[3], false);
+    }
+
+    private static float replaceIfNull(Float value, float defaultValue) {
+        return (float) (null == value ? defaultValue : value);
     }
 }

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

@@ -62,7 +62,10 @@ This file is part of the iText (R) project.
 import com.itextpdf.layout.element.IBlockElement;
 import com.itextpdf.layout.element.Image;
 import com.itextpdf.layout.element.Link;
+import com.itextpdf.layout.element.ListItem;
 import com.itextpdf.layout.element.Paragraph;
+import com.itextpdf.layout.properties.ListNumberingType;
+import com.itextpdf.layout.properties.Property;
 import com.itextpdf.layout.testutil.TestConfigurationEvent;
 import com.itextpdf.layout.testutil.TestProductEvent;
 import com.itextpdf.test.ExtendedITextTest;
@@ -144,6 +147,63 @@ public void canvasWithPageLinkTest() throws IOException, InterruptedException {
         Assert.assertNull(new CompareTool().compareByContent(out, cmp, DESTINATION_FOLDER));
     }
 
+    @Test
+    public void listItemWithoutMarginsInCanvasTest() throws IOException, InterruptedException {
+        String testName = "listItemWithoutMarginsInCanvasTest";
+        String out = DESTINATION_FOLDER + testName + ".pdf";
+        String cmp = SOURCE_FOLDER + "cmp_" + testName + ".pdf";
+        PdfDocument pdf = new PdfDocument(new PdfWriter(out));
+        PdfPage page = pdf.addNewPage();
+        Rectangle pageSize = page.getPageSize();
+
+        Canvas canvas = new Canvas(page, pageSize);
+        com.itextpdf.layout.element.List list = new com.itextpdf.layout.element.List();
+        list.setListSymbol(ListNumberingType.DECIMAL);
+        list.add(new ListItem("list item 1"));
+        list.add(new ListItem("list item 2"));
+        canvas.add(list);
+        canvas.close();
+        pdf.close();
+
+        Assert.assertNull(new CompareTool().compareByContent(out, cmp, DESTINATION_FOLDER));
+    }
+
+    @Test
+    public void notApplyingMarginsInCanvasTest() throws IOException, InterruptedException {
+        String testName = "notApplyingMarginsInCanvasTest";
+        String out = DESTINATION_FOLDER + testName + ".pdf";
+        String cmp = SOURCE_FOLDER + "cmp_" + testName + ".pdf";
+        PdfDocument pdf = new PdfDocument(new PdfWriter(out));
+        PdfPage page = pdf.addNewPage();
+        Rectangle pageSize = page.getPageSize();
+
+        Canvas canvas = new Canvas(page, pageSize);
+        canvas.setProperty(Property.MARGIN_LEFT, 36);
+        canvas.add(new Paragraph("Hello"));
+        canvas.close();
+        pdf.close();
+
+        Assert.assertNull(new CompareTool().compareByContent(out, cmp, DESTINATION_FOLDER));
+    }
+
+    @Test
+    public void nullableMarginsInCanvasRendererTest() throws IOException, InterruptedException {
+        String testName = "nullableMarginsInCanvasRenderer";
+        String out = DESTINATION_FOLDER + testName + ".pdf";
+        String cmp = SOURCE_FOLDER + "cmp_" + testName + ".pdf";
+        PdfDocument pdf = new PdfDocument(new PdfWriter(out));
+        PdfPage page = pdf.addNewPage();
+        Rectangle pageSize = page.getPageSize();
+
+        Canvas canvas = new Canvas(page, pageSize);
+        canvas.setProperty(Property.MARGIN_LEFT, null);
+        canvas.add(new Paragraph("Hello"));
+        canvas.close();
+        pdf.close();
+
+        Assert.assertNull(new CompareTool().compareByContent(out, cmp, DESTINATION_FOLDER));
+    }
+
     @Test
     public void canvasWithPageEnableTaggingTest01() throws IOException, InterruptedException {
         String testName = "canvasWithPageEnableTaggingTest01";

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

@@ -460,6 +460,86 @@ public void listItemTest02() throws IOException, InterruptedException {
         Assert.assertNull(new CompareTool().compareByContent(outFileName, cmpFileName, destinationFolder, "diff"));
     }
 
+    @Test
+    public void listItemWithoutMarginsTest() throws IOException, InterruptedException {
+        String outFileName = destinationFolder + "listItemWithoutMarginsTest.pdf";
+        String cmpFileName = sourceFolder + "cmp_listItemWithoutMarginsTest.pdf";
+        PdfDocument pdf = new PdfDocument(new PdfWriter(outFileName));
+        Document document = new Document(pdf);
+        document.setMargins(0, 0, 0, 0);
+
+        List list = new List();
+        list.setListSymbol(ListNumberingType.DECIMAL);
+        list.add(new ListItem("list item 1"));
+        list.add(new ListItem("list item 2"));
+
+        document.add(list);
+        document.close();
+
+        Assert.assertNull(new CompareTool().compareByContent(outFileName, cmpFileName, destinationFolder, "diff"));
+    }
+
+    @Test
+    public void listItemBigMarginsTest() throws IOException, InterruptedException {
+        String outFileName = destinationFolder + "listItemBigMarginsTest.pdf";
+        String cmpFileName = sourceFolder + "cmp_listItemBigMarginsTest.pdf";
+        PdfDocument pdf = new PdfDocument(new PdfWriter(outFileName));
+        Document document = new Document(pdf);
+        int margin = 100;
+        document.setMargins(margin, margin, margin, margin);
+
+        List list = new List();
+        list.setListSymbol(ListNumberingType.DECIMAL);
+        list.add(new ListItem("list item 1"));
+        list.add(new ListItem("list item 2"));
+
+        document.add(list);
+        document.close();
+
+        Assert.assertNull(new CompareTool().compareByContent(outFileName, cmpFileName, destinationFolder, "diff"));
+    }
+
+    @Test
+    public void maxMarginWidthWhereTheBulletIsNotDrawnTest() throws IOException, InterruptedException {
+        String outFileName = destinationFolder + "maxMarginWidthWhereTheBulletIsNotDrawn.pdf";
+        String cmpFileName = sourceFolder + "cmp_maxMarginWidthWhereTheBulletIsNotDrawn.pdf";
+        PdfDocument pdf = new PdfDocument(new PdfWriter(outFileName));
+        Document document = new Document(pdf);
+        int margin = 50;
+        document.setMargins(margin, margin, margin, margin);
+
+        List list = new List();
+        list.setListSymbol(ListNumberingType.DECIMAL);
+        list.add(new ListItem("list item 1"));
+        list.add(new ListItem("list item 2"));
+        Float marginLeft = document.<Float>getDefaultProperty(Property.MARGIN_LEFT);
+        list.setFixedPosition((float) marginLeft, 780, 200);
+        document.add(list);
+        document.close();
+        Assert.assertNull(new CompareTool().compareByContent(outFileName, cmpFileName, destinationFolder, "diff"));
+    }
+
+    @Test
+    public void initialMarginWidthWhereTheBulletIsDrawnTest() throws IOException, InterruptedException {
+        String outFileName = destinationFolder + "initialMarginWidthWhereTheBulletIsDrawn.pdf";
+        String cmpFileName = sourceFolder + "cmp_initialMarginWidthWhereTheBulletIsDrawn.pdf";
+        PdfDocument pdf = new PdfDocument(new PdfWriter(outFileName));
+        Document document = new Document(pdf);
+        int margin = 49;
+        document.setMargins(margin, margin, margin, margin);
+
+        List list = new List();
+        list.setListSymbol(ListNumberingType.DECIMAL);
+        list.add(new ListItem("list item 1"));
+        list.add(new ListItem("list item 2"));
+        Float marginLeft = document.<Float>getDefaultProperty(Property.MARGIN_LEFT);
+        list.setFixedPosition((float) marginLeft, 780, 200);
+        document.add(list);
+        document.close();
+
+        Assert.assertNull(new CompareTool().compareByContent(outFileName, cmpFileName, destinationFolder, "diff"));
+    }
+
     @LogMessages(messages = {
             @LogMessage(messageTemplate = IoLogMessageConstant.CLIP_ELEMENT, count = 4)
     })
@@ -471,7 +551,6 @@ public void listWithSetHeightProperties01() throws IOException, InterruptedExcep
         PdfDocument pdfDoc = new PdfDocument(new PdfWriter(outFileName));
         Document doc = new Document(pdfDoc);
 
-
         doc.add(new Paragraph("Default layout:"));
         ListItem item = new ListItem();
         ListItem nestedItem = new ListItem();

layout/src/test/java/com/itextpdf/layout/renderer/AbstractRendererUnitTest.java

@@ -687,4 +687,14 @@ public void nullChildTest() {
             AssertUtil.doesNotThrow(() -> renderer.linkRenderToDocument(divRenderer, doc.getPdfDocument()));
         }
     }
+
+    @Test
+    //TODO DEVSIX-6372 Obtaining DocumentRenderer's margins results in a ClassCastException
+    public void obtainingMarginsErrorTest() {
+        PdfDocument doc = new PdfDocument(new PdfWriter(new ByteArrayOutputStream()));
+        Document document = new Document(doc);
+        RootRenderer renderer = document.getRenderer();
+        Rectangle rect = new Rectangle(0, 0);
+        Assert.assertThrows(ClassCastException.class, () -> renderer.applyMargins(rect, false));
+    }
 }