Implement supporting background-repeat CSS property

DEVSIX-4370

Author: introfog

src/main/java/com/itextpdf/html2pdf/css/apply/util/BackgroundApplierUtil.java

@@ -59,10 +59,12 @@ This file is part of the iText (R) project.
 import com.itextpdf.layout.property.BackgroundRepeat;
 import com.itextpdf.layout.property.BackgroundSize;
 import com.itextpdf.layout.property.BlendMode;
+import com.itextpdf.layout.property.BackgroundRepeat.BackgroundRepeatValue;
 import com.itextpdf.layout.property.Property;
 import com.itextpdf.layout.property.UnitValue;
 import com.itextpdf.styledxmlparser.css.CommonCssConstants;
 import com.itextpdf.styledxmlparser.css.util.CssGradientUtil;
+import com.itextpdf.styledxmlparser.css.util.CssMappingUtils;
 import com.itextpdf.styledxmlparser.css.util.CssUtils;
 import com.itextpdf.styledxmlparser.exceptions.StyledXMLParserException;
 
@@ -127,10 +129,11 @@ public static void applyBackground(Map<String, String> cssProps, ProcessorContex
                     applyBackgroundPosition(backgroundPositionXArray, backgroundPositionYArray, i, em, rem);
             final BlendMode blendMode = applyBackgroundBlendMode(backgroundBlendModeArray, i);
             boolean imageApplied = false;
+            final BackgroundRepeat repeat = applyBackgroundRepeat(backgroundRepeatArray, i);
+
             if (CssGradientUtil.isCssLinearGradientValue(backgroundImage)) {
-                imageApplied = applyLinearGradient(backgroundImage, backgroundImagesList, blendMode, position, em, rem);
+                imageApplied = applyLinearGradient(backgroundImage, backgroundImagesList, blendMode, position, em, rem, repeat);
             } else {
-                final BackgroundRepeat repeat = applyBackgroundRepeat(backgroundRepeatArray, i);
                 final PdfXObject image = context.getResourceResolver().retrieveImageExtended(
                         CssUtils.extractUrl(backgroundImage));
                 imageApplied = applyBackgroundImage(image, backgroundImagesList, repeat, blendMode, position);
@@ -251,12 +254,23 @@ private static void applyBackgroundPositionY(BackgroundPosition position, String
     private static BackgroundRepeat applyBackgroundRepeat(List<String> backgroundRepeatArray, int iteration) {
         final int index = getBackgroundSidePropertyIndex(backgroundRepeatArray.size(), iteration);
         if (index != -1) {
-            final boolean repeatX = CssConstants.REPEAT.equals(backgroundRepeatArray.get(index)) ||
-                    CssConstants.REPEAT_X.equals(backgroundRepeatArray.get(index));
-            final boolean repeatY = CssConstants.REPEAT.equals(backgroundRepeatArray.get(index)) ||
-                    CssConstants.REPEAT_Y.equals(backgroundRepeatArray.get(index));
-            return new BackgroundRepeat(repeatX, repeatY);
+            String[] repeatProps = backgroundRepeatArray.get(index).split(" ");
+            if (repeatProps.length == 1) {
+                if (CommonCssConstants.REPEAT_X.equals(repeatProps[0])) {
+                    return new BackgroundRepeat(BackgroundRepeatValue.REPEAT, BackgroundRepeatValue.NO_REPEAT);
+                } else if (CommonCssConstants.REPEAT_Y.equals(repeatProps[0])) {
+                    return new BackgroundRepeat(BackgroundRepeatValue.NO_REPEAT, BackgroundRepeatValue.REPEAT);
+                } else {
+                    BackgroundRepeatValue value = CssMappingUtils.parseBackgroundRepeat(repeatProps[0]);
+                    return new BackgroundRepeat(value);
+                }
+            } else if (repeatProps.length == 2) {
+                return new BackgroundRepeat(CssMappingUtils.parseBackgroundRepeat(repeatProps[0]),
+                        CssMappingUtils.parseBackgroundRepeat(repeatProps[1]));
+            }
         }
+        // Valid cases are processed by the block above, and in invalid
+        // situations, the REPEAT property on both axes is used by default
         return new BackgroundRepeat();
     }
 
@@ -296,13 +310,13 @@ private static boolean applyBackgroundImage(PdfXObject image, List<BackgroundIma
     }
 
     private static boolean applyLinearGradient(String image, List<BackgroundImage> backgroundImagesList,
-            BlendMode blendMode, BackgroundPosition position, float em, float rem) {
+            BlendMode blendMode, BackgroundPosition position, float em, float rem, final BackgroundRepeat repeat) {
         try {
             StrategyBasedLinearGradientBuilder gradientBuilder =
                     CssGradientUtil.parseCssLinearGradient(image, em, rem);
             if (gradientBuilder != null) {
                 backgroundImagesList.add(new BackgroundImage.Builder().setLinearGradientBuilder(gradientBuilder)
-                        .setBackgroundBlendMode(blendMode).setBackgroundPosition(position).build());
+                        .setBackgroundBlendMode(blendMode).setBackgroundPosition(position).setBackgroundRepeat(repeat).build());
                 return true;
             }
         } catch (StyledXMLParserException e) {

src/test/java/com/itextpdf/html2pdf/css/BackgroundRepeatTest.java

@@ -26,6 +26,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.test.annotations.type.IntegrationTest;
 
 import java.io.IOException;
+
 import org.junit.BeforeClass;
 import org.junit.Test;
 import org.junit.experimental.categories.Category;
@@ -42,181 +43,167 @@ public static void beforeClass() {
     }
 
     @Test
-    //TODO: DEVSIX-4370 update cmp file
     public void imageBckgRepeatTest() throws IOException, InterruptedException {
         convertToPdfAndCompare("imageBckgRepeat", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
-    //TODO: DEVSIX-4370 update cmp file
     public void imageBckgNoRepeatTest() throws InterruptedException, IOException {
         convertToPdfAndCompare("imageBckgNoRepeat", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
-    //TODO: DEVSIX-4370 update cmp file
     public void imageBckgRoundTest() throws InterruptedException, IOException {
         convertToPdfAndCompare("imageBckgRound", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
-    //TODO: DEVSIX-4370 update cmp file
     public void imageBckgSpaceTest() throws InterruptedException, IOException {
         convertToPdfAndCompare("imageBckgSpace", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
-    //TODO: DEVSIX-4370 update cmp file
+    public void imageBckgSpaceWithBigBorderTest() throws InterruptedException, IOException {
+        // TODO DEVSIX-2105
+        convertToPdfAndCompare("imageBckgSpaceWithBigBorder", SOURCE_FOLDER, DESTINATION_FOLDER);
+    }
+
+    @Test
     public void imageBckgRepeatXTest() throws InterruptedException, IOException {
         convertToPdfAndCompare("imageBckgRepeatX", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
-    //TODO: DEVSIX-4370 update cmp file
     public void imageBckgRepeatYTest() throws InterruptedException, IOException {
         convertToPdfAndCompare("imageBckgRepeatY", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
-    //TODO: DEVSIX-4370 update cmp file
     public void linearGradientBckgRepeatTest() throws InterruptedException, IOException {
         convertToPdfAndCompare("linearGradientBckgRepeat", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
-    //TODO: DEVSIX-4370 update cmp file
     public void linearGradientBckgNoRepeatTest() throws InterruptedException, IOException {
         convertToPdfAndCompare("linearGradientBckgNoRepeat", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
-    //TODO: DEVSIX-4370 update cmp file
     public void linearGradientBckgRoundTest() throws IOException, InterruptedException {
         convertToPdfAndCompare("linearGradientBckgRound", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
-    //TODO: DEVSIX-1708 update cmp file
     public void linearGradientBckgSpaceTest() throws IOException, InterruptedException {
         convertToPdfAndCompare("linearGradientBckgSpace", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
-    //TODO: DEVSIX-4370 update cmp file
     public void linearGradientBckgRepeatXTest() throws IOException, InterruptedException {
         convertToPdfAndCompare("linearGradientBckgRepeatX", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
-    //TODO: DEVSIX-4370 update cmp file
     public void linearGradientBckgRepeatYTest() throws IOException, InterruptedException {
         convertToPdfAndCompare("linearGradientBckgRepeatY", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
-    //TODO: DEVSIX-4370 update cmp file
     public void imageBckgRepeatAndSpaceTest() throws IOException, InterruptedException {
         convertToPdfAndCompare("imageBckgRepeatAndSpace", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
-    //TODO: DEVSIX-4370 update cmp file
     public void imageBckgRoundAndSpaceTest() throws IOException, InterruptedException {
         convertToPdfAndCompare("imageBckgRoundAndSpace", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
-    //TODO: DEVSIX-4370 update cmp file
     public void bckgRepeatAndBckgPositionXTest() throws IOException, InterruptedException {
         convertToPdfAndCompare("bckgRepeatAndBckgPositionX", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
-    //TODO: DEVSIX-4370 update cmp file
     public void bckgRepeatAndBckgPositionYTest() throws IOException, InterruptedException {
         convertToPdfAndCompare("bckgRepeatAndBckgPositionY", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
-    //TODO: DEVSIX-4370 update cmp file
     public void bckgRoundSpaceAndBckgPositionXTest() throws IOException, InterruptedException {
         convertToPdfAndCompare("bckgRoundSpaceAndBckgPositionX", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
-    //TODO: DEVSIX-4370 update cmp file
     public void bckgSpaceRoundAndBckgPositionYTest() throws IOException, InterruptedException {
         convertToPdfAndCompare("bckgSpaceRoundAndBckgPositionY", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
-    //TODO: DEVSIX-4370 update cmp file
     public void bckgRepeatXAndBckgPositionYTest() throws IOException, InterruptedException {
         convertToPdfAndCompare("bckgRepeatXAndBckgPositionY", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
-    //TODO: DEVSIX-4370 update cmp file
     public void bckgRepeatYAndBckgPositionXTest() throws IOException, InterruptedException {
         convertToPdfAndCompare("bckgRepeatYAndBckgPositionX", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
-    //TODO: DEVSIX-4370 update cmp file
     public void bckgRoundAndBckgPositionTest() throws IOException, InterruptedException {
         convertToPdfAndCompare("bckgRoundAndBckgPosition", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
-    //TODO: DEVSIX-4370 update cmp file
     public void bckgRoundAndNegativeBckgPositionTest() throws IOException, InterruptedException {
         convertToPdfAndCompare("bckgRoundAndNegativeBckgPosition", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
-    //TODO: DEVSIX-4370 update cmp file
     public void bckgSpaceAndBckgPositionTest() throws IOException, InterruptedException {
         convertToPdfAndCompare("bckgSpaceAndBckgPosition", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
-    //TODO: DEVSIX-4370 update cmp file
     public void bckgSpaceAndBckgPositionPageSeparationTest() throws IOException, InterruptedException {
         convertToPdfAndCompare("bckgSpaceAndBckgPositionPageSeparation", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
-    //TODO: DEVSIX-4370 update cmp file
     public void bckgSpaceAndNegativeBckgPositionTest() throws IOException, InterruptedException {
         convertToPdfAndCompare("bckgSpaceAndNegativeBckgPosition", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
-    //TODO: DEVSIX-4370 update cmp file
+    public void bckgSpaceAndBckgPositionAdvancedTest() throws IOException, InterruptedException {
+        convertToPdfAndCompare("bckgSpaceAndBckgPositionAdvanced", SOURCE_FOLDER, DESTINATION_FOLDER);
+    }
+
+    @Test
+    public void bcgRoundAndBckgSizeAutoAndContainAdvancedTest() throws IOException, InterruptedException {
+        convertToPdfAndCompare("bcgRoundAndBckgSizeAutoAndContainAdvanced", SOURCE_FOLDER, DESTINATION_FOLDER);
+    }
+
+    @Test
     public void bckgRoundRemainsLessHalfOfImageTest() throws IOException, InterruptedException {
         convertToPdfAndCompare("bckgRoundRemainsLessHalfOfImage", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
-    //TODO: DEVSIX-4370 update cmp file
     public void bckgRoundRemainsMoreHalfOfImageTest() throws IOException, InterruptedException {
         convertToPdfAndCompare("bckgRoundRemainsMoreHalfOfImage", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
-    //TODO: DEVSIX-4370 update cmp file
     public void bckgRoundCompressAndStretchImageTest() throws IOException, InterruptedException {
         convertToPdfAndCompare("bckgRoundCompressAndStretchImage", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
-    //TODO: DEVSIX-4370 update cmp file
     public void imageBckgRoundBckgSizeLessThanImageTest() throws IOException, InterruptedException {
         convertToPdfAndCompare("imageBckgRoundBckgSizeLessThanImage", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
-    //TODO: DEVSIX-4370 update cmp file
     public void imageBckgSpaceBckgSizeLessThanImageTest() throws IOException, InterruptedException {
         convertToPdfAndCompare("imageBckgSpaceBckgSizeLessThanImage", SOURCE_FOLDER, DESTINATION_FOLDER);
     }

src/test/java/com/itextpdf/html2pdf/css/BackgroundTest.java

@@ -79,13 +79,11 @@ public void backgroundSizeTest01() throws IOException, InterruptedException {
     }
 
     @Test
-    // TODO DEVSIX-4370 support background repeat for linear-gradient
     public void backgroundAttachmentMarginRoot1Test() throws IOException, InterruptedException {
         convertToPdfAndCompare("backgroundAttachmentMarginRoot1", sourceFolder, destinationFolder);
     }
 
     @Test
-    // TODO DEVSIX-4370 support background repeat for linear-gradient
     public void backgroundAttachmentMarginRoot2Test() throws IOException, InterruptedException {
         convertToPdfAndCompare("backgroundAttachmentMarginRoot2", sourceFolder, destinationFolder);
     }

src/test/java/com/itextpdf/html2pdf/css/LinearGradientTest.java

@@ -243,6 +243,7 @@ public void backgroundImageLinearGradientInHeaderTest() throws IOException, Inte
 
     @Test
     public void backgroundImageLinearGradientInAbbrTest() throws IOException, InterruptedException {
+        // TODO DEVSIX-4617 process abbr tag with "text-decoration: underline dotted" CSS styles
         convertToPdfAndCompare("backgroundImageLinearGradientInAbbr", sourceFolder, destinationFolder);
     }