Add support of pages target-counter(s). Finalize whole target-counter logic

DEVSIX-4692

Author: Eugene Bochilo

kernel/src/main/java/com/itextpdf/kernel/numbering/AlphabetNumbering.java

@@ -69,19 +69,19 @@ public static String toAlphabetNumber(int number, char[] alphabet) {
 
         number--;
         int bytes = 1;
-        int start = 0;
-        int symbols = cardinality;
+        long start = 0;
+        long symbols = cardinality;
 
         while (number >= symbols + start) {
             bytes++;
             start += symbols;
             symbols *= cardinality;
         }
 
-        int c = number - start;
+        long c = number - start;
         char[] value = new char[bytes];
         while (bytes > 0) {
-            value[--bytes] = alphabet[c % cardinality];
+            value[--bytes] = alphabet[(int) (c % cardinality)];
             c /= cardinality;
         }
 

kernel/src/test/java/com/itextpdf/kernel/numbering/GreekAlphabetNumberingTest.java

@@ -42,7 +42,6 @@ This file is part of the iText (R) project.
  */
 package com.itextpdf.kernel.numbering;
 
-import com.itextpdf.kernel.numbering.GreekAlphabetNumbering;
 import com.itextpdf.test.ExtendedITextTest;
 import com.itextpdf.test.annotations.type.UnitTest;
 import org.junit.Assert;
@@ -91,4 +90,9 @@ public void testLowerCaseSymbol() {
         // Symbol font use regular WinAnsi codes for greek letters.
         Assert.assertEquals("abgdezhqiklmnxoprstufcywaa", builder.toString());
     }
+
+    @Test
+    public void intIsNotEnoughForInternalCalculationsTest() {
+        Assert.assertEquals("ζλαββωσ", GreekAlphabetNumbering.toGreekAlphabetNumberLowerCase(1234567890));
+    }
 }

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

@@ -37,10 +37,7 @@ public class TargetCounterHandler {
      */
     private Map<String, Integer> renderersPages = new HashMap<>();
 
-    /**
-     * Indicates if relayout is required.
-     */
-    private boolean isRelayoutRequired = false;
+    private Map<String, Integer> previousRenderersPages = new HashMap<>();
 
     /**
      * Creates a copy of the given {@link TargetCounterHandler} instance.
@@ -49,6 +46,7 @@ public class TargetCounterHandler {
      */
     public TargetCounterHandler(TargetCounterHandler targetCounterHandler) {
         this.renderersPages = targetCounterHandler.renderersPages;
+        this.previousRenderersPages = targetCounterHandler.previousRenderersPages;
     }
 
     /**
@@ -66,12 +64,8 @@ public static void addPageByID(IRenderer renderer) {
         if (id != null) {
             final TargetCounterHandler targetCounterHandler = getTargetCounterHandler(renderer);
             if (targetCounterHandler != null && renderer.getOccupiedArea() != null) {
-                final Integer prevPageNumber = targetCounterHandler.renderersPages.get(id);
                 final int currentPageNumber = renderer.getOccupiedArea().getPageNumber();
-                if (prevPageNumber == null || currentPageNumber > prevPageNumber) {
-                    targetCounterHandler.renderersPages.put(id, currentPageNumber);
-                    targetCounterHandler.isRelayoutRequired = true;
-                }
+                targetCounterHandler.renderersPages.put(id, currentPageNumber);
             }
         }
     }
@@ -85,7 +79,7 @@ public static void addPageByID(IRenderer renderer) {
      */
     public static Integer getPageByID(IRenderer renderer, String id) {
         final TargetCounterHandler targetCounterHandler = getTargetCounterHandler(renderer);
-        return targetCounterHandler == null ? null : targetCounterHandler.renderersPages.get(id);
+        return targetCounterHandler == null ? null : targetCounterHandler.previousRenderersPages.get(id);
     }
 
     /**
@@ -95,7 +89,7 @@ public static Integer getPageByID(IRenderer renderer, String id) {
      * @param id target id
      * @return true if value is defined for this id, false otherwise
      */
-    public static boolean isValueDefinedForThisID(IRenderer renderer, String id) {
+    public static boolean isValueDefinedForThisId(IRenderer renderer, String id) {
         final TargetCounterHandler targetCounterHandler = getTargetCounterHandler(renderer);
         return targetCounterHandler != null && targetCounterHandler.renderersPages.containsKey(id);
     }
@@ -106,7 +100,19 @@ public static boolean isValueDefinedForThisID(IRenderer renderer, String id) {
      * @return true if relayout is required, false otherwise
      */
     public boolean isRelayoutRequired() {
-        return isRelayoutRequired;
+        for (Map.Entry<String, Integer> rendererPage : renderersPages.entrySet()) {
+            if (!rendererPage.getValue().equals(previousRenderersPages.get(rendererPage.getKey()))) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    /**
+     * Prepares handler to relayout.
+     */
+    public void prepareHandlerToRelayout() {
+        previousRenderersPages = new HashMap<>(renderersPages);
     }
 
     private static TargetCounterHandler getTargetCounterHandler(IRenderer renderer) {

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

@@ -48,18 +48,21 @@ public class TargetCounterHandlerTest extends ExtendedITextTest {
 
     @Test
     public void BlockRendererAddByIDTest() {
+        DocumentRenderer documentRenderer = new DocumentRenderer(null);
         DivRenderer divRenderer = new DivRenderer(new Div());
-        divRenderer.setParent(new DocumentRenderer(null));
+        divRenderer.setParent(documentRenderer);
         String id = "id5";
         divRenderer.setProperty(Property.ID, id);
         LayoutContext layoutContext = new LayoutContext(new LayoutArea(4, new Rectangle(50, 50)));
         divRenderer.layout(layoutContext);
 
+        documentRenderer.getTargetCounterHandler().prepareHandlerToRelayout();
         Assert.assertEquals((Integer) 4, TargetCounterHandler.getPageByID(divRenderer, id));
     }
 
     @Test
     public void TextRendererAddByIDTest() throws IOException {
+        DocumentRenderer documentRenderer = new DocumentRenderer(null);
         TextRenderer textRenderer = new TextRenderer(new Text("a"));
 
         textRenderer.setProperty(Property.TEXT_RISE, 20F);
@@ -68,57 +71,69 @@ public void TextRendererAddByIDTest() throws IOException {
         textRenderer.setProperty(Property.FONT, PdfFontFactory.createFont(StandardFonts.HELVETICA));
         textRenderer.setProperty(Property.FONT_SIZE, new UnitValue(UnitValue.POINT, 20));
 
-        textRenderer.setParent(new DocumentRenderer(null));
+        textRenderer.setParent(documentRenderer);
         String id = "id7";
         textRenderer.setProperty(Property.ID, id);
         LayoutContext layoutContext = new LayoutContext(new LayoutArea(4, new Rectangle(50, 50)));
         textRenderer.layout(layoutContext);
 
+        documentRenderer.getTargetCounterHandler().prepareHandlerToRelayout();
         Assert.assertEquals((Integer) 4, TargetCounterHandler.getPageByID(textRenderer, id));
     }
 
     @Test
     public void TableRendererAddByIDTest() {
+        DocumentRenderer documentRenderer = new DocumentRenderer(null);
         TableRenderer tableRenderer = new TableRenderer(new Table(5));
-        tableRenderer.setParent(new DocumentRenderer(null));
+        tableRenderer.setParent(documentRenderer);
         String id = "id5";
         tableRenderer.setProperty(Property.ID, id);
         LayoutContext layoutContext = new LayoutContext(new LayoutArea(4, new Rectangle(50, 50)));
         tableRenderer.layout(layoutContext);
 
+        documentRenderer.getTargetCounterHandler().prepareHandlerToRelayout();
         Assert.assertEquals((Integer) 4, TargetCounterHandler.getPageByID(tableRenderer, id));
     }
 
     @Test
     public void ParagraphRendererAddByIDTest() {
+        DocumentRenderer documentRenderer = new DocumentRenderer(null);
         ParagraphRenderer paragraphRenderer = new ParagraphRenderer(new Paragraph());
-        paragraphRenderer.setParent(new DocumentRenderer(null));
+        paragraphRenderer.setParent(documentRenderer);
         String id = "id5";
         paragraphRenderer.setProperty(Property.ID, id);
         LayoutContext layoutContext = new LayoutContext(new LayoutArea(4, new Rectangle(50, 50)));
         paragraphRenderer.layout(layoutContext);
+
+        documentRenderer.getTargetCounterHandler().prepareHandlerToRelayout();
         Assert.assertEquals((Integer) 4, TargetCounterHandler.getPageByID(paragraphRenderer, id));
     }
 
     @Test
     public void ImageRendererAddByIDTest() {
+        DocumentRenderer documentRenderer = new DocumentRenderer(null);
         ImageRenderer imageRenderer = new ImageRenderer(new Image(ImageDataFactory.createRawImage(new byte[]{50, 21})));
-        imageRenderer.setParent(new DocumentRenderer(null));
+        imageRenderer.setParent(documentRenderer);
         String id = "id6";
         imageRenderer.setProperty(Property.ID, id);
         LayoutContext layoutContext = new LayoutContext(new LayoutArea(4, new Rectangle(50, 50)));
         imageRenderer.layout(layoutContext);
+
+        documentRenderer.getTargetCounterHandler().prepareHandlerToRelayout();
         Assert.assertEquals((Integer) 4, TargetCounterHandler.getPageByID(imageRenderer, id));
     }
 
     @Test
     public void LineRendererAddByIDTest() {
+        DocumentRenderer documentRenderer = new DocumentRenderer(null);
         LineRenderer lineRenderer = new LineRenderer();
-        lineRenderer.setParent(new DocumentRenderer(null));
+        lineRenderer.setParent(documentRenderer);
         String id = "id6";
         lineRenderer.setProperty(Property.ID, id);
         LayoutContext layoutContext = new LayoutContext(new LayoutArea(4, new Rectangle(50, 50)));
         lineRenderer.layout(layoutContext);
+
+        documentRenderer.getTargetCounterHandler().prepareHandlerToRelayout();
         Assert.assertEquals((Integer) 4, TargetCounterHandler.getPageByID(lineRenderer, id));
     }
 }

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

@@ -71,6 +71,38 @@ public LayoutArea getOccupiedArea() {
         Assert.assertNull(page);
     }
 
+    @Test
+    public void isValueDefinedForThisIdNotDocumentRendererTest() {
+        RootRenderer documentRenderer = new RootRenderer() {
+
+            @Override
+            public IRenderer getNextRenderer() {
+                return null;
+            }
+
+            @Override
+            protected void flushSingleRenderer(IRenderer resultRenderer) {
+            }
+
+            @Override
+            protected LayoutArea updateCurrentArea(LayoutResult overflowResult) {
+                return null;
+            }
+        };
+        final String id = "id";
+
+        IRenderer renderer = new TextRenderer(new Text("renderer")) {
+            @Override
+            public LayoutArea getOccupiedArea() {
+                return null;
+            }
+        };
+        renderer.setParent(documentRenderer);
+        renderer.setProperty(Property.ID, id);
+
+        Assert.assertFalse(TargetCounterHandler.isValueDefinedForThisId(renderer, id));
+    }
+
     @Test
     public void addAndGetPageByDestinationNullOccupiedAreaTest() {
         DocumentRenderer documentRenderer = new DocumentRenderer(null);
@@ -107,6 +139,7 @@ public LayoutArea getOccupiedArea() {
         TargetCounterHandler.addPageByID(renderer);
         TargetCounterHandler.addPageByID(renderer);
 
+        documentRenderer.getTargetCounterHandler().prepareHandlerToRelayout();
         Integer page = TargetCounterHandler.getPageByID(renderer, id);
         Assert.assertEquals((Integer) 8, page);
     }
@@ -128,8 +161,9 @@ public LayoutArea getOccupiedArea() {
         TargetCounterHandler.addPageByID(renderer);
         TargetCounterHandler.addPageByID(renderer);
 
+        documentRenderer.getTargetCounterHandler().prepareHandlerToRelayout();
         Integer page = TargetCounterHandler.getPageByID(renderer, id);
-        Assert.assertEquals((Integer) 4, page);
+        Assert.assertEquals((Integer) 2, page);
     }
 
     @Test
@@ -148,6 +182,7 @@ public LayoutArea getOccupiedArea() {
         renderer.setProperty(Property.ID, id);
         TargetCounterHandler.addPageByID(renderer);
 
+        documentRenderer.getTargetCounterHandler().prepareHandlerToRelayout();
         Integer page = TargetCounterHandler.getPageByID(renderer, id);
         Assert.assertEquals((Integer) expectedPage, page);
 
@@ -172,7 +207,51 @@ public LayoutArea getOccupiedArea() {
         };
         renderer.setParent(documentRenderer);
         renderer.setProperty(Property.ID, id);
+        Assert.assertFalse(documentRenderer.isRelayoutRequired());
         TargetCounterHandler.addPageByID(renderer);
         Assert.assertTrue(documentRenderer.isRelayoutRequired());
+        documentRenderer.getTargetCounterHandler().prepareHandlerToRelayout();
+        Assert.assertFalse(documentRenderer.isRelayoutRequired());
+    }
+
+    @Test
+    public void copyConstructorTest() {
+        DocumentRenderer documentRenderer = new DocumentRenderer(null);
+        String id = "id";
+
+        IRenderer renderer = new TextRenderer(new Text("renderer")) {
+
+            @Override
+            public LayoutArea getOccupiedArea() {
+                int page = 4;
+                return new LayoutArea(page, new Rectangle(50, 50));
+            }
+        };
+        renderer.setParent(documentRenderer);
+        renderer.setProperty(Property.ID, id);
+        TargetCounterHandler.addPageByID(renderer);
+        TargetCounterHandler copy = new TargetCounterHandler(documentRenderer.getTargetCounterHandler());
+        Assert.assertTrue(copy.isRelayoutRequired());
+    }
+
+    @Test
+    public void isValueDefinedForThisId() {
+        DocumentRenderer documentRenderer = new DocumentRenderer(null);
+        String id = "id";
+        String notAddedId = "not added id";
+
+        IRenderer renderer = new TextRenderer(new Text("renderer")) {
+
+            @Override
+            public LayoutArea getOccupiedArea() {
+                int page = 4;
+                return new LayoutArea(page, new Rectangle(50, 50));
+            }
+        };
+        renderer.setParent(documentRenderer);
+        renderer.setProperty(Property.ID, id);
+        TargetCounterHandler.addPageByID(renderer);
+        Assert.assertTrue(TargetCounterHandler.isValueDefinedForThisId(renderer, id));
+        Assert.assertFalse(TargetCounterHandler.isValueDefinedForThisId(renderer, notAddedId));
     }
 }