feature unlock hide cells (#54)

Author: gmulders

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

@@ -0,0 +1,48 @@
+package org.dhatim.fastexcel;
+
+import java.io.IOException;
+import java.util.Map;
+import java.util.Objects;
+
+/**
+ * Represents the <protection> xml-tag.
+ */
+public class Protection {
+
+    private final Map<ProtectionOption, Boolean> options;
+
+    public Protection(Map<ProtectionOption, Boolean> options) {
+        if (options == null) {
+            throw new NullPointerException("Options should not be null");
+        }
+        this.options = options;
+    }
+
+    @Override
+    public int hashCode() {
+        return options.hashCode();
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        Protection that = (Protection) o;
+        return Objects.equals(options, that.options);
+    }
+
+    /**
+     * Write this protection as an XML element.
+     *
+     * @param w Output writer.
+     * @throws IOException If an I/O error occurs.
+     */
+    void write(Writer w) throws IOException {
+        w.append("<protection ");
+        for (Map.Entry<ProtectionOption, Boolean> option : options.entrySet()) {
+            w.append(option.getKey().getName()).append("=\"").append(option.getValue().toString()).append("\" ");
+        }
+        w.append("/>");
+    }
+
+}

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

@@ -0,0 +1,41 @@
+package org.dhatim.fastexcel;
+
+/**
+ * Represents an attribute on the <protection> xml-tag.
+ */
+public enum ProtectionOption {
+
+    /**
+     * A boolean value indicating if the cell is hidden. When the cell is hidden and the sheet on which the cell resides
+     * is protected, then the cell value will be displayed in the cell grid location, but the contents of the cell will
+     * not be displayed in the formula bar. This is true for all types of cell content, including formula, text, or
+     * numbers.
+     *
+     * Therefore the cell A4 may contain a formula "=SUM(A1:A3)", but if the cell protection property of A4 is marked as
+     * hidden, and the sheet is protected, then the cell should display the calculated result (for example, "6"), but
+     * will not display the formula used to calculate the result.
+     */
+    HIDDEN("hidden"),
+
+    /**
+     * A boolean value indicating if the cell is locked. When cells are marked as "locked" and the sheet is protected,
+     * then the options specified in the Sheet Part's <sheetProtection> element (§3.3.1.81) are prohibited for
+     * these cells.
+     */
+    LOCKED("locked");
+
+    private final String name;
+
+    /**
+     * Constructor that sets the name.
+     *
+     * @param name The name of the protection option.
+     */
+    ProtectionOption(String name) {
+        this.name = name;
+    }
+
+    public String getName() {
+        return name;
+    }
+}

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

@@ -45,6 +45,11 @@ class Style {
      */
     private final Alignment alignment;
 
+    /**
+     * The protection settings.
+     */
+    private final Protection protection;
+
     /**
      * Constructor.
      *
@@ -56,25 +61,31 @@ class Style {
      * @param border Index of cached border. Zero if not set.
      * @param alignment Alignment. {@code null} if not set.
      */
-    Style(Style original, int valueFormatting, int font, int fill, int border, Alignment alignment) {
+    Style(Style original, int valueFormatting, int font, int fill, int border, Alignment alignment, Protection protection) {
         this.valueFormatting = (valueFormatting == 0 && original != null) ? original.valueFormatting : valueFormatting;
         this.font = (font == 0 && original != null) ? original.font : font;
         this.fill = (fill == 0 && original != null) ? original.fill : fill;
         this.border = (border == 0 && original != null) ? original.border : border;
         this.alignment = (alignment == null && original != null) ? original.alignment : alignment;
+        this.protection = (protection == null && original != null) ? original.protection : protection;
     }
 
     @Override
     public int hashCode() {
-        return Objects.hash(valueFormatting, font, fill, border, alignment);
+        return Objects.hash(valueFormatting, font, fill, border, alignment, protection);
     }
 
     @Override
     public boolean equals(Object obj) {
         boolean result;
         if (obj != null && obj.getClass() == this.getClass()) {
             Style other = (Style) obj;
-            result = Objects.equals(valueFormatting, other.valueFormatting) && Objects.equals(font, other.font) && Objects.equals(fill, other.fill) && Objects.equals(border, other.border) && Objects.equals(alignment, other.alignment);
+            result = Objects.equals(valueFormatting, other.valueFormatting)
+                    && Objects.equals(font, other.font)
+                    && Objects.equals(fill, other.fill)
+                    && Objects.equals(border, other.border)
+                    && Objects.equals(alignment, other.alignment)
+                    && Objects.equals(protection, other.protection);
         } else {
             result = false;
         }
@@ -92,12 +103,19 @@ void write(Writer w) throws IOException {
         if (border != 0) {
             w.append(" applyBorder=\"1\"");
         }
-        if (alignment == null) {
+
+        if (alignment == null && protection == null) {
             w.append("/>");
-        } else {
-            w.append('>');
+            return;
+        }
+
+        w.append('>');
+        if (alignment != null) {
             alignment.write(w);
-            w.append("</xf>");
         }
+        if (protection != null) {
+            protection.write(w);
+        }
+        w.append("</xf>");
     }
 }

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

@@ -17,6 +17,7 @@
 
 import java.io.IOException;
 import java.util.ArrayList;
+import java.util.Comparator;
 import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
@@ -41,7 +42,7 @@ final class StyleCache {
      * Default constructor. Pre-cache Excel-reserved stuff.
      */
     StyleCache() {
-        mergeAndCacheStyle(0, null, Font.DEFAULT, Fill.NONE, Border.NONE, null);
+        mergeAndCacheStyle(0, null, Font.DEFAULT, Fill.NONE, Border.NONE, null, null);
         cacheFill(Fill.GRAY125);
     }
 
@@ -131,9 +132,9 @@ int cacheDxf(Fill f) {
         return cacheStuff(dxfs, f);
     }
 
-    int mergeAndCacheStyle(int currentStyle, String numberingFormat, Font font, Fill fill, Border border, Alignment alignment) {
+    int mergeAndCacheStyle(int currentStyle, String numberingFormat, Font font, Fill fill, Border border, Alignment alignment, Protection protection) {
         Style original = styles.entrySet().stream().filter(e -> e.getValue().equals(currentStyle)).map(Entry::getKey).findFirst().orElse(null);
-        Style s = new Style(original, cacheValueFormatting(numberingFormat), cacheFont(font), cacheFill(fill), cacheBorder(border), alignment);
+        Style s = new Style(original, cacheValueFormatting(numberingFormat), cacheFont(font), cacheFill(fill), cacheBorder(border), alignment, protection);
         return cacheStuff(styles, s);
     }
 
@@ -150,7 +151,7 @@ int mergeAndCacheStyle(int currentStyle, String numberingFormat, Font font, Fill
     private static <T> void writeCache(Writer w, Map<T, Integer> cache, String name, ThrowingConsumer<Entry<T, Integer>> consumer) throws IOException {
         w.append('<').append(name).append(" count=\"").append(cache.size()).append("\">");
         List<Entry<T, Integer>> entries = new ArrayList<>(cache.entrySet());
-        entries.sort((e1, e2) -> Integer.compare(e1.getValue(), e2.getValue()));
+        entries.sort(Comparator.comparingInt(Entry::getValue));
         for (Entry<T, Integer> e : entries) {
             consumer.accept(e);
         }

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

@@ -16,6 +16,7 @@
 package org.dhatim.fastexcel;
 
 import java.math.BigDecimal;
+import java.util.EnumMap;
 import java.util.EnumSet;
 import java.util.Map;
 import java.util.Set;
@@ -86,6 +87,11 @@ public class StyleSetter {
      */
     private Border border;
 
+    /**
+     * Protection options.
+     */
+    private Map<ProtectionOption, Boolean> protectionOptions;
+
     /**
      * Constructor.
      *
@@ -307,6 +313,21 @@ public StyleSetter borderColor(BorderSide side, String borderColor) {
         return borderElement(side, border.elements.get(side).updateColor(borderColor));
     }
 
+    /**
+     * Sets the value for a protection option.
+     *
+     * @param option The option to set
+     * @param value The value to set for the given option.
+     * @return This style setter.
+     */
+    public StyleSetter protectionOption(ProtectionOption option, Boolean value) {
+        if (protectionOptions == null) {
+            protectionOptions = new EnumMap<>(ProtectionOption.class);
+        }
+        protectionOptions.put(option, value);
+        return this;
+    }
+
     /**
      * Merge cells in this style setter's range.
      *
@@ -344,9 +365,16 @@ public void set() {
             border = Border.NONE;
         }
 
+        Protection protection;
+        if (protectionOptions != null) {
+            protection = new Protection(protectionOptions);
+        } else {
+            protection = null;
+        }
+
         // Compute a map giving new styles for current styles
         Set<Integer> currentStyles = range.getStyles();
-        Map<Integer, Integer> newStyles = currentStyles.stream().collect(Collectors.toMap(Function.identity(), s -> range.getWorksheet().getWorkbook().mergeAndCacheStyle(s, valueFormatting, font, fill, border, alignment)));
+        Map<Integer, Integer> newStyles = currentStyles.stream().collect(Collectors.toMap(Function.identity(), s -> range.getWorksheet().getWorkbook().mergeAndCacheStyle(s, valueFormatting, font, fill, border, alignment, protection)));
 
         // Apply styles to range
         range.applyStyle(newStyles);

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

@@ -185,8 +185,8 @@ CachedString cacheString(String s) {
      * @param alignment Alignment attributes.
      * @return Cached style index.
      */
-    int mergeAndCacheStyle(int currentStyle, String numberingFormat, Font font, Fill fill, Border border, Alignment alignment) {
-        return styleCache.mergeAndCacheStyle(currentStyle, numberingFormat, font, fill, border, alignment);
+    int mergeAndCacheStyle(int currentStyle, String numberingFormat, Font font, Fill fill, Border border, Alignment alignment, Protection protection) {
+        return styleCache.mergeAndCacheStyle(currentStyle, numberingFormat, font, fill, border, alignment, protection);
     }
 
     /**

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

@@ -500,6 +500,7 @@ public void canHideSheet() throws IOException {
         assertThat(xwb.getSheetVisibility(3)).isEqualTo(SheetVisibility.VISIBLE);
     }
 
+    @Test
     public void canHideColumns() throws Exception {
 
         byte[] data = writeWorkbook(wb -> {
@@ -610,4 +611,48 @@ public void shouldSetSpecificSheetProtectionOptions() throws IOException {
         assertThat(xws.isSelectLockedCellsLocked()).isFalse();
         assertThat(xws.isSelectUnlockedCellsLocked()).isFalse();
     }
+
+    @Test
+    public void canProtectCells() throws Exception {
+
+        byte[] data = writeWorkbook(wb -> {
+            Worksheet ws = wb.newWorksheet("Worksheet 1");
+
+            // Protect the sheet
+            ws.protect("HorriblePassword");
+
+            ws.value(0, 1, "val1");
+            ws.style(0, 1)
+                    .protectionOption(ProtectionOption.LOCKED, true).set();
+
+            ws.value(0, 2, "val2");
+            ws.style(0, 2)
+                    .protectionOption(ProtectionOption.HIDDEN, true).set();
+
+            ws.value(0, 3, "val3");
+            ws.style(0, 3)
+                    .protectionOption(ProtectionOption.LOCKED, false).set();
+
+            ws.value(0, 4, "val4");
+            ws.style(0, 4)
+                    .protectionOption(ProtectionOption.LOCKED, false)
+                    .protectionOption(ProtectionOption.HIDDEN, false).set();
+        });
+
+        // Check generated workbook with Apache POI
+        XSSFWorkbook xwb = new XSSFWorkbook(new ByteArrayInputStream(data));
+        XSSFSheet xws = xwb.getSheetAt(0);
+
+        assertFalse("Cell (0, 1) should NOT be hidden", xws.getRow(0).getCell(1).getCellStyle().getHidden());
+        assertTrue("Cell (0, 1) should be locked", xws.getRow(0).getCell(1).getCellStyle().getLocked());
+
+        assertTrue("Cell (0, 2) should be locked (by default)", xws.getRow(0).getCell(2).getCellStyle().getLocked());
+        assertTrue("Cell (0, 2) should be hidden", xws.getRow(0).getCell(2).getCellStyle().getHidden());
+
+        assertFalse("Cell (0, 3) should NOT be hidden", xws.getRow(0).getCell(3).getCellStyle().getHidden());
+        assertFalse("Cell (0, 3) should NOT be locked", xws.getRow(0).getCell(3).getCellStyle().getLocked());
+
+        assertFalse("Cell (0, 4) should NOT be locked", xws.getRow(0).getCell(4).getCellStyle().getLocked());
+        assertFalse("Cell (0, 4) should NOT be hidden", xws.getRow(0).getCell(4).getCellStyle().getHidden());
+    }
 }