Merge pull request #150 from dorssar/master

new feature: name a cell range and few minor fixes

README.md

@@ -96,6 +96,10 @@ or shade every Nth row (e.g. every 5th):
 ```java
 ws.range(0, 0, 10, 10).style().shadeRows(Color.GRAY2, 5).set();
 ```
+Name a cell range (name of a cell range can only include letters, numbers and underscore):
+```java
+ws.range(0, 0, 0, 10).setName("header");
+```
 
 ### Formulas
 

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

@@ -215,6 +215,16 @@ public ListDataValidation validateWithList(Range listRange) {
         return listDataValidation;
     }
 
+    /**
+     * Specifically define this range by assigning it a name.
+     * It will be visible in the cell range dropdown menu.
+     * 
+     * @param name string representing the name of this cell range
+     */
+    public void setName(String name) {
+        worksheet.addNamedRange(this, name);
+    }
+
     /**
      * Return the set of styles used by the cells in this range.
      *

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

@@ -22,6 +22,7 @@
 import java.time.LocalDateTime;
 import java.time.format.DateTimeFormatter;
 import java.util.*;
+import java.util.Map;
 import java.util.stream.Stream;
 import java.util.stream.Collectors;
 import java.util.zip.ZipEntry;
@@ -204,21 +205,53 @@ private void writeWorkbookFile() throws IOException {
              * (if there are any repeating rows or cols in the sheet at all) **/
 
             for (Worksheet ws : worksheets) {
+                int worksheetIndex = getIndex(ws) - 1;                
                 String defineName = Stream.of(ws.getRepeatingCols(),ws.getRepeatingRows())
                                 .filter(Objects::nonNull)
-                                .map(r -> ws.getName() + "!" + r.toString())
+                                .map(r -> "'" + ws.getName() + "'!" + r.toString())
                                 .collect(Collectors.joining(","));
+
+                w.append("<definedNames>");
                 if (!defineName.isEmpty()) {
-                    w.append("<definedNames>");
                     w.append("<definedName function=\"false\" " + 
-                                "hidden=\"false\" " +
-                                "localSheetId=\"0\" " + 
-                                "name=\"_xlnm.Print_Titles\" " + 
-                                "vbProcedure=\"false\">");
-                    w.append(defineName);
-                    w.append("</definedName>");
-                    w.append("</definedNames>");
+                                "hidden=\"false\" localSheetId=\"" + 
+                                worksheetIndex + "\" name=\"_xlnm.Print_Titles\" " + 
+                                "vbProcedure=\"false\">")
+                     .append(defineName)
+                     .append("</definedName>");
                 }
+                /** define specifically named ranges **/
+                for (Map.Entry<String, Range> nr : ws.getNamedRanges().entrySet()) {
+                    String rangeName = nr.getKey();
+                    Range range = nr.getValue();
+                    w.append("<definedName function=\"false\" " + 
+                                "hidden=\"false\" localSheetId=\"" + 
+                                worksheetIndex + "\" name=\"")
+                        .append(rangeName)
+                        .append("\" vbProcedure=\"false\">&apos;")
+                        .append(ws.getName())
+                        .append("&apos;")
+                        .append("!")
+                        .append("$" + Range.colToString(range.getLeft()) + "$" + (1 + range.getTop()))
+                        .append(":")
+                        .append("$" + Range.colToString(range.getRight()) + "$" + (1 + range.getBottom()))
+                        .append("</definedName>");
+                }
+                Range af = ws.getAutoFilterRange();
+                if (af != null) {
+                    w.append("<definedName function=\"false\" hidden=\"true\" localSheetId=\"")
+                    .append(worksheetIndex)
+                    .append("\" name=\"_xlnm._FilterDatabase\" vbProcedure=\"false\">")
+                    .append("&apos;")
+                    .append(ws.getName())
+                    .append("&apos;")
+                    .append("!")
+                    .append("$" + Range.colToString(af.getLeft()) + "$" + (1 + af.getTop()))
+                    .append(":")
+                    .append("$" + Range.colToString(af.getRight()) + "$" + (1 + af.getBottom()))
+                    .append("</definedName>");
+                }
+                w.append("</definedNames>");
             }
             w.append("</workbook>");
         });

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

@@ -204,6 +204,10 @@ public class Worksheet {
      * Range of row where will be inserted auto filter
      */
     private Range autoFilterRange = null;
+    /**
+     * List of named ranges.
+     */
+    private Map<String, Range> namedRanges = new LinkedHashMap();
 
     /**
      * The set of protection options that are applied on the sheet.
@@ -248,6 +252,16 @@ public RepeatRowRange getRepeatingRows(){
         return repeatingRows;
     }
 
+    /**
+     * Get cell range that autofilter is applied to.
+     * 
+     * @return Range of cells that autofilter is set to
+     *             (null if autofilter is not set).
+     */
+    public Range getAutoFilterRange(){
+        return autoFilterRange;
+    }
+
     /**
      * Get repeating cols defined for the print setup.
      *
@@ -258,6 +272,16 @@ public RepeatColRange getRepeatingCols(){
         return repeatingCols;
     }
 
+    /**
+     * Get a list of named ranges.
+     * 
+     * @return Map containing named range entries 
+     *              where keys are the names and values are cell ranges.
+     */
+    public Map<String, Range> getNamedRanges() {
+        return namedRanges;
+    }
+
     /**
      * Get parent workbook.
      *
@@ -1209,4 +1233,18 @@ public void header(String text, Position position) {
         this.header.put(position, "&amp;" + position.getPos() +
                                   prepareForXml(text));
     }
+
+    /**
+     * Add the given range to this sheet's
+     * list of named ranges under the provided name.
+     * It will be visible when this sheet is open in the
+     * cell range dropdown menu under the specified name.
+     * 
+     * @param range Range of cells that needs to be named.
+     * @param name String representing the given cell range's name.
+     * 
+     */
+    public void addNamedRange(Range range, String name) {
+        this.namedRanges.put(name, range);
+    }
 }

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

@@ -630,4 +630,31 @@ private static boolean isWorkSheetDisplayingGridLines(byte[] data) throws IOExce
         return xws.isDisplayGridlines();
     }
 
+    @Test
+    void hasValidNamedRange() throws Exception {
+
+        byte[] data = writeWorkbook(wb -> {
+            Worksheet ws = wb.newWorksheet("Worksheet 1");
+            ws.value(0, 1, "column 1");
+            ws.value(0, 2, "column 2");
+            ws.value(0, 3, "column 3");
+            ws.value(1, 1, "value 1");
+            ws.value(1, 2, "value 2");
+            ws.value(1, 3, "value 3");
+            ws.range(0, 0, 1, 3).setName("col names");
+        });
+
+        // Check generated workbook with Apache POI
+        XSSFWorkbook xwb = new XSSFWorkbook(new ByteArrayInputStream(data));
+        XSSFSheet xws = xwb.getSheetAt(0);
+        // Fetch the XSSF Name object
+        XSSFName name = xwb.getName("col names");
+        String formula = name.getRefersToFormula();
+
+        assertTrue(name != null);
+        assertTrue(name.getNameName().equals("col names"));
+        assertTrue(formula.equals("'Worksheet 1'!$A$1:$D$2"));
+    }
+
+
 }