Merge pull request #356 from JakKowalCzyk/add-diagonal-properties

Added possibility to define diagonal border properties (up and down)

Author: ochedru

fastexcel-writer/src/main/java/org/dhatim/fastexcel/Border.java

@@ -16,8 +16,7 @@
 package org.dhatim.fastexcel;
 
 import java.io.IOException;
-import java.util.EnumMap;
-import java.util.Map;
+import java.util.*;
 
 /**
  * Border attributes.
@@ -33,6 +32,10 @@ class Border {
      * Border elements.
      */
     final Map<BorderSide, BorderElement> elements = new EnumMap<>(BorderSide.class);
+    /**
+     * Diagonal properties
+     */
+    private final Set<DiagonalProperty> diagonalProperties = new HashSet<>();
 
     /**
      * Default constructor.
@@ -77,6 +80,15 @@ void setElement(BorderSide side, BorderElement element) {
         elements.put(side, element);
     }
 
+    /**
+     * Set a diagonal property.
+     *
+     * @param diagonalProperty Diagonal property.
+     */
+    void setDiagonalProperty(DiagonalProperty diagonalProperty) {
+        diagonalProperties.add(diagonalProperty);
+    }
+
     /**
      * Create a border where all sides have the same style and color.
      *
@@ -92,15 +104,15 @@ static Border fromStyleAndColor(String style, String color) {
 
     @Override
     public int hashCode() {
-        return elements.hashCode();
+        return Objects.hash(elements, diagonalProperties);
     }
 
     @Override
     public boolean equals(Object obj) {
         boolean result;
         if (obj != null && obj.getClass() == this.getClass()) {
             Border other = (Border) obj;
-            result = elements.equals(other.elements);
+            result = elements.equals(other.elements) && diagonalProperties.equals(other.diagonalProperties);
         } else {
             result = false;
         }
@@ -114,7 +126,14 @@ public boolean equals(Object obj) {
      * @throws IOException If an I/O error occurs.
      */
     void write(Writer w) throws IOException {
-        w.append("<border>");
+        w.append("<border");
+        if (diagonalProperties.contains(DiagonalProperty.DIAGONAL_UP)) {
+            w.append(" diagonalUp=\"1\"");
+        }
+        if (diagonalProperties.contains(DiagonalProperty.DIAGONAL_DOWN)) {
+            w.append(" diagonalDown=\"1\"");
+        }
+        w.append(">");
         elements.get(BorderSide.LEFT).write("left", w);
         elements.get(BorderSide.RIGHT).write("right", w);
         elements.get(BorderSide.TOP).write("top", w);

fastexcel-writer/src/main/java/org/dhatim/fastexcel/DiagonalProperty.java

@@ -0,0 +1,8 @@
+package org.dhatim.fastexcel;
+
+/**
+ * Identifies diagonal border of a cell.
+ */
+public enum DiagonalProperty {
+    DIAGONAL_UP, DIAGONAL_DOWN
+}

fastexcel-writer/src/main/java/org/dhatim/fastexcel/StyleSetter.java

@@ -404,6 +404,20 @@ public StyleSetter borderColor(BorderSide side, String borderColor) {
         return borderElement(side, border.elements.get(side).updateColor(borderColor));
     }
 
+    /**
+     * Set cell diagonal property.
+     *
+     * @param diagonalProperty Diagonal border property which should be aplied to a cell
+     * @return This style setter.
+     */
+    public StyleSetter diagonalProperty(DiagonalProperty diagonalProperty) {
+        if (border == null) {
+            border = new Border();
+        }
+        border.setDiagonalProperty(diagonalProperty);
+        return this;
+    }
+
     /**
      * Sets the value for a protection option.
      *

fastexcel-writer/src/test/java/org/dhatim/fastexcel/CorrectnessTest.java

@@ -596,6 +596,36 @@ void testForIssue285() throws Exception {
         // }
     }
 
+    @Test
+    public void testDiagonalProperties() throws Exception {
+        writeWorkbook(wb -> {
+            Worksheet worksheet = wb.newWorksheet("Worksheet 1");
+            worksheet.style(0, 0)
+                    .borderColor(BorderSide.RIGHT, Color.BLACK)
+                    .borderStyle(BorderSide.RIGHT, BorderStyle.THIN)
+                    .borderColor(BorderSide.DIAGONAL, Color.BLACK)
+                    .borderStyle(BorderSide.DIAGONAL, BorderStyle.THIN)
+                    .diagonalProperty(DiagonalProperty.DIAGONAL_UP)
+                    .set();
+            worksheet.style(1, 0)
+                    .borderColor(BorderSide.TOP, Color.BLACK)
+                    .borderStyle(BorderSide.TOP, BorderStyle.THIN)
+                    .borderColor(BorderSide.DIAGONAL, Color.BLACK)
+                    .borderStyle(BorderSide.DIAGONAL, BorderStyle.MEDIUM)
+                    .diagonalProperty(DiagonalProperty.DIAGONAL_DOWN)
+                    .set();
+            worksheet.style(2, 0)
+                    .borderColor(BorderSide.TOP, Color.BLACK)
+                    .borderStyle(BorderSide.TOP, BorderStyle.THIN)
+                    .borderColor(BorderSide.DIAGONAL, Color.BLACK)
+                    .borderStyle(BorderSide.DIAGONAL, BorderStyle.MEDIUM)
+                    .diagonalProperty(DiagonalProperty.DIAGONAL_DOWN)
+                    .diagonalProperty(DiagonalProperty.DIAGONAL_UP)
+                    .diagonalProperty(DiagonalProperty.DIAGONAL_UP)
+                    .set();
+        });
+    }
+
     @Test
     void testForIndent() throws Exception {
         writeWorkbook(wb -> {
@@ -646,7 +676,6 @@ void testCustomValidation() throws Exception {
                     .error("Wrong value")
                     .showErrorMessage(true)
                     .errorStyle(DataValidationErrorStyle.STOP);
-
         });
     }
 }