Support display:none and visibility:hidden for svg elements except text

DEVSIX-8753

Author: Dmitry Radchuk

svg/src/main/java/com/itextpdf/svg/renderers/impl/AbstractSvgNodeRenderer.java

@@ -142,6 +142,10 @@ public final void draw(SvgDrawContext context) {
         PdfCanvas currentCanvas = context.getCurrentCanvas();
 
         if (this.attributesAndStyles != null) {
+            if (isHidden()) {
+                return;
+            }
+
             String transformString = this.attributesAndStyles.get(SvgConstants.Attributes.TRANSFORM);
 
             if (transformString != null && !transformString.isEmpty()) {
@@ -274,6 +278,16 @@ protected void deepCopyAttributesAndStyles(ISvgNodeRenderer deepCopy) {
      */
     protected abstract void doDraw(SvgDrawContext context);
 
+    /**
+     * Check if this renderer should draw the element based on its attributes (e.g. visibility/display)
+     *
+     * @return true if element won't be drawn, false otherwise
+     */
+    protected boolean isHidden() {
+        return CommonCssConstants.NONE.equals(this.attributesAndStyles.get(CommonCssConstants.DISPLAY))
+                || CommonCssConstants.HIDDEN.equals(this.attributesAndStyles.get(CommonCssConstants.VISIBILITY));
+    }
+
     /**
      * Gets parent {@link ClipPathSvgNodeRenderer} if it exists or {@code null} otherwise.
      *
@@ -518,7 +532,11 @@ private TransparentColor getColorFromAttributeValue(SvgDrawContext context, Stri
                 Color resolvedColor = null;
                 float resolvedOpacity = 1;
                 normalizedName = normalizedName.substring(1);
-                final ISvgNodeRenderer colorRenderer = context.getNamedObject(normalizedName);
+                ISvgNodeRenderer colorRenderer = context.getNamedObject(normalizedName);
+                if (colorRenderer instanceof AbstractSvgNodeRenderer
+                        && ((AbstractSvgNodeRenderer)colorRenderer).isHidden()) {
+                    colorRenderer = null;
+                }
                 if (colorRenderer instanceof ISvgPaintServer) {
                     if (colorRenderer.getParent() == null) {
                         colorRenderer.setParent(this);
@@ -585,6 +603,9 @@ private boolean drawInClipPath(SvgDrawContext context) {
             if (template instanceof ClipPathSvgNodeRenderer) {
                 // Clone template to avoid muddying the state
                 ClipPathSvgNodeRenderer clipPath = (ClipPathSvgNodeRenderer) template.createDeepCopy();
+                if (clipPath.isHidden()) {
+                    return false;
+                }
                 // Resolve parent inheritance
                 SvgNodeRendererInheritanceResolver.applyInheritanceToSubTree(this, clipPath, context.getCssContext());
                 clipPath.setClippedRenderer(this);

svg/src/main/java/com/itextpdf/svg/renderers/impl/ClipPathSvgNodeRenderer.java

@@ -25,6 +25,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.geom.NoninvertibleTransformException;
 import com.itextpdf.kernel.geom.Rectangle;
 import com.itextpdf.kernel.pdf.canvas.PdfCanvas;
+import com.itextpdf.styledxmlparser.css.CommonCssConstants;
 import com.itextpdf.svg.logs.SvgLogMessageConstant;
 import com.itextpdf.svg.renderers.ISvgNodeRenderer;
 import com.itextpdf.svg.renderers.SvgDrawContext;
@@ -69,6 +70,10 @@ protected void doDraw(SvgDrawContext context) {
 
         PdfCanvas currentCanvas = context.getCurrentCanvas();
         for (ISvgNodeRenderer child : getChildren()) {
+            if (child instanceof AbstractSvgNodeRenderer
+                    && ((AbstractSvgNodeRenderer) child).isHidden()) {
+                continue;
+            }
             currentCanvas.saveState();
 
             child.setParent(this);
@@ -116,4 +121,10 @@ public void drawClippedRenderer(SvgDrawContext context) {
     public void setClippedRenderer(AbstractSvgNodeRenderer clippedRenderer) {
         this.clippedRenderer = clippedRenderer;
     }
+
+    @Override
+    protected boolean isHidden() {
+        return CommonCssConstants.NONE.equals(this.attributesAndStyles.get(CommonCssConstants.DISPLAY))
+                && !CommonCssConstants.HIDDEN.equals(this.attributesAndStyles.get(CommonCssConstants.VISIBILITY));
+    }
 }

svg/src/main/java/com/itextpdf/svg/renderers/impl/LinearGradientSvgNodeRenderer.java

@@ -29,6 +29,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.geom.AffineTransform;
 import com.itextpdf.kernel.geom.Point;
 import com.itextpdf.kernel.geom.Rectangle;
+import com.itextpdf.styledxmlparser.css.CommonCssConstants;
 import com.itextpdf.svg.SvgConstants.Attributes;
 import com.itextpdf.svg.renderers.ISvgNodeRenderer;
 import com.itextpdf.svg.renderers.SvgDrawContext;
@@ -94,6 +95,11 @@ public Rectangle getObjectBoundingBox(SvgDrawContext context) {
         return null;
     }
 
+    @Override
+    protected boolean isHidden() {
+        return CommonCssConstants.NONE.equals(this.attributesAndStyles.get(CommonCssConstants.DISPLAY));
+    }
+
     // TODO: DEVSIX-4136 opacity is not supported now.
     //  The opacity should be equal to 'parentOpacity * stopRenderer.getStopOpacity() * stopColor[3]'
     private List<GradientColorStop> parseStops(float parentOpacity) {

svg/src/main/java/com/itextpdf/svg/renderers/impl/MarkerSvgNodeRenderer.java

@@ -25,6 +25,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.geom.AffineTransform;
 import com.itextpdf.kernel.geom.Point;
 import com.itextpdf.kernel.geom.Rectangle;
+import com.itextpdf.styledxmlparser.css.CommonCssConstants;
 import com.itextpdf.styledxmlparser.css.util.CssDimensionParsingUtils;
 import com.itextpdf.styledxmlparser.css.util.CssTypesValidationUtils;
 import com.itextpdf.styledxmlparser.css.util.CssUtils;
@@ -77,6 +78,11 @@ public Rectangle getObjectBoundingBox(SvgDrawContext context) {
         return null;
     }
 
+    @Override
+    protected boolean isHidden() {
+        return CommonCssConstants.HIDDEN.equals(this.attributesAndStyles.get(CommonCssConstants.VISIBILITY));
+    }
+
     @Override
     void preDraw(SvgDrawContext context) {
         super.preDraw(context);

svg/src/test/java/com/itextpdf/svg/css/VisibilityTest.java

@@ -41,8 +41,107 @@ public static void beforeClass() {
     }
 
     @Test
-    //TODO DEVSIX-8753: update cmp file after supporting
     public void visibilityDiffValuesTest() throws IOException, InterruptedException {
         convertAndCompareSinglePage(SOURCE_FOLDER, DESTINATION_FOLDER,"visibility");
     }
+
+    @Test
+    public void visibilityDiffValuesTest2() throws IOException, InterruptedException {
+        convertAndCompareSinglePage(SOURCE_FOLDER, DESTINATION_FOLDER,"visibility2");
+    }
+
+    @Test
+    public void visibilityHiddenInLinearGradientTest() throws IOException, InterruptedException {
+        convertAndCompareSinglePage(SOURCE_FOLDER, DESTINATION_FOLDER,"visibilityHiddenInLinearGradient");
+    }
+
+    @Test
+    public void visibilityHiddenInMarkerTest() throws IOException, InterruptedException {
+        convertAndCompareSinglePage(SOURCE_FOLDER, DESTINATION_FOLDER,"visibilityHiddenInMarker");
+    }
+
+    @Test
+    public void visibilityHiddenInGTest() throws IOException, InterruptedException {
+        convertAndCompareSinglePage(SOURCE_FOLDER, DESTINATION_FOLDER,"visibilityHiddenInG");
+    }
+
+    @Test
+    public void visibilityHiddenInUseTest() throws IOException, InterruptedException {
+        convertAndCompareSinglePage(SOURCE_FOLDER, DESTINATION_FOLDER,"visibilityHiddenInUse");
+    }
+
+    @Test
+    public void visibilityHiddenInDefsTest() throws IOException, InterruptedException {
+        convertAndCompareSinglePage(SOURCE_FOLDER, DESTINATION_FOLDER,"visibilityHiddenInDefs");
+    }
+
+    @Test
+    public void visibilityHiddenInPatternTest() throws IOException, InterruptedException {
+        convertAndCompareSinglePage(SOURCE_FOLDER, DESTINATION_FOLDER,"visibilityHiddenInPattern");
+    }
+
+    @Test
+    public void visibilityHiddenInClipPathTest() throws IOException, InterruptedException {
+        convertAndCompareSinglePage(SOURCE_FOLDER, DESTINATION_FOLDER,"visibilityHiddenInClipPath");
+    }
+
+    @Test
+    public void visibilityHiddenInClipPathWithUseTest() throws IOException, InterruptedException {
+        convertAndCompareSinglePage(SOURCE_FOLDER, DESTINATION_FOLDER,"visibilityHiddenInClipPathWithUse");
+    }
+
+    @Test
+    public void visibilityHiddenInSymbolTest() throws IOException, InterruptedException {
+        convertAndCompareSinglePage(SOURCE_FOLDER, DESTINATION_FOLDER,"visibilityHiddenInSymbol");
+    }
+
+    @Test
+    public void displayNoneInLinearGradientTest() throws IOException, InterruptedException {
+        convertAndCompareSinglePage(SOURCE_FOLDER, DESTINATION_FOLDER,"displayNoneInLinearGradient");
+    }
+
+    @Test
+    public void displayNoneInMarkerTest() throws IOException, InterruptedException {
+        convertAndCompareSinglePage(SOURCE_FOLDER, DESTINATION_FOLDER,"displayNoneInMarker");
+    }
+
+    @Test
+    public void displayNoneInGTest() throws IOException, InterruptedException {
+        convertAndCompareSinglePage(SOURCE_FOLDER, DESTINATION_FOLDER,"displayNoneInG");
+    }
+
+    @Test
+    public void displayNoneInG2Test() throws IOException, InterruptedException {
+        convertAndCompareSinglePage(SOURCE_FOLDER, DESTINATION_FOLDER,"displayNoneInG2");
+    }
+
+    @Test
+    public void displayNoneInUseTest() throws IOException, InterruptedException {
+        convertAndCompareSinglePage(SOURCE_FOLDER, DESTINATION_FOLDER,"displayNoneInUse");
+    }
+
+    @Test
+    public void displayNoneInDefsTest() throws IOException, InterruptedException {
+        convertAndCompareSinglePage(SOURCE_FOLDER, DESTINATION_FOLDER,"displayNoneInDefs");
+    }
+
+    @Test
+    public void displayNoneInPatternTest() throws IOException, InterruptedException {
+        convertAndCompareSinglePage(SOURCE_FOLDER, DESTINATION_FOLDER,"displayNoneInPattern");
+    }
+
+    @Test
+    public void displayNoneInSymbolTest() throws IOException, InterruptedException {
+        convertAndCompareSinglePage(SOURCE_FOLDER, DESTINATION_FOLDER,"displayNoneInSymbol");
+    }
+
+    @Test
+    public void displayNoneInClipPathTest() throws IOException, InterruptedException {
+        convertAndCompareSinglePage(SOURCE_FOLDER, DESTINATION_FOLDER,"displayNoneInClipPath");
+    }
+
+    @Test
+    public void displayNoneInClipPathWithUseTest() throws IOException, InterruptedException {
+        convertAndCompareSinglePage(SOURCE_FOLDER, DESTINATION_FOLDER,"displayNoneInClipPathWithUse");
+    }
 }