Merge pull request #124 from dorssar/master

New features for repeating rows and columns in the print setup

Author: Olivier Chédru

README.md

@@ -121,6 +121,14 @@ To freeze the first column on the left and the top three rows:
 ```java
 ws.freezePane(1, 3)
 ```
+Define repeating rows or columns for the print setup.
+```java
+ws.repeatRows(0, 4) // keep first top 5 rows on each page when printing.
+ws.repeatRows(2) // keep the third row on each page when printing.
+
+ws.repeatCols(0, 2) // repeat first three columns (A to C) on each page when printing.
+ws.repeatCols(0) // repeat only first column (A) on each page for the print setup.
+```
 Set header and footer content.\
 To set page enumeration in the top right:
 ```java

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

@@ -58,12 +58,15 @@ public final class Color {
     public static final String INDIAN_RED = "CD5C5C";
     public static final String ORCHID = "DA70D6";
     public static final String RICH_LILAC = "B666D2";
+    public static final String OPERA_MAUVE = "B98DA8";
+    public static final String THISTLE = "D0B3C6";
     public static final String VIOLET = "EE82EE";
     public static final String DARK_VIOLET = "9400D3";
     public static final String MEDIUM_VIOLET_RED = "C71585";
     public static final String PLUM = "DDA0DD";
     public static final String ROSE = "FF0066";
     public static final String BRIGHT_LAVENDER = "BF94E4";
+    public static final String PINK_LAVENDER = "C9A6BC";
     public static final String LAVENDER = "967BB6";
     public static final String RED = "FF0000";
     public static final String CORAL = "FF4040";
@@ -76,6 +79,7 @@ public final class Color {
     /*
      * All kinds of blue.
      */
+    public static final String LIGHT_PASTEL_BLUE = "BAD7F2";
     public static final String ALICE_BLUE = "F0F8FF";
     public static final String AZURE = "007FFF";
     public static final String CADET_BLUE = "5F9EA0";
@@ -84,13 +88,15 @@ public final class Color {
     public static final String AQUA = "00FFFF";
     public static final String AQUAMARINE = "7FFFD4";
     public static final String LIGHT_CORNFLOWER_BLUE = "93CCEA";
+    public static final String PEWTER_BLUE = "99B6C2";
     public static final String CORNFLOWER_BLUE = "6495ED";
     public static final String LIGHT_TURQUOISE = "AFEEEE";
     public static final String TURQUOISE = "40E0dE";
     public static final String ROYAL_BLUE = "4169E1";
     public static final String DARK_ROYAL_BLUE = "002366";
     public static final String NAVY_BLUE = "000080";
     public static final String SKY_BLUE = "89CEBB";
+    public static final String DARK_SKY_BLUE = "A6BFC9";
     public static final String SEA_BLUE = "006994";
     public static final String PALE_BLUE = "AFEEEE";
     public static final String TEAL = "008080";
@@ -106,6 +112,8 @@ public final class Color {
     public static final String APPLE_GREEN = "8DB600";
     public static final String ANDROID_GREEN = "A4C639";
     public static final String SEA_GREEN = "2E8B57";
+    public static final String LIGHT_LAUREL_GREEN = "C9D8C0";
+    public static final String LAUREL_GREEN = "A8C19A";
     public static final String DARK_GREEN = "006400";
     public static final String OLIVE = "808000";
     public static final String OLIVE_GREEN = "BAB86C";

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

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2016 Dhatim.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.dhatim.fastexcel;
+
+/** This class represents a range of columns for the 
+ *      repeating columns feature in the print setup. */
+class RepeatColRange { 
+    
+    final int from;
+    final int to;
+
+    public RepeatColRange(int from, int to) {
+        this.from = from;
+        this.to = to;
+    }
+
+    /**
+     * Column indexes need to be transformed to the letter form.
+     */
+    public String toString() {
+        return "$" + Range.colToString(from) + ":$" + Range.colToString(to);
+    }
+}

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

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2016 Dhatim.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.dhatim.fastexcel;
+
+/** This class represents a range of rows for the 
+ *      repeating rows feature in the print setup. */
+class RepeatRowRange { 
+    
+    final int from;
+    final int to;
+
+    public RepeatRowRange(int from, int to) {
+        this.from = from;
+        this.to = to;
+    }
+
+    /**
+     * Row indexes need to be increased by 1 
+     *  (sheet row indexes start from 1 and not from 0)
+     */
+    public String toString() {
+        return "$" + (1 + from) + ":$" + (1 + to);
+    }
+}

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

@@ -22,14 +22,17 @@
 import java.time.LocalDateTime;
 import java.time.format.DateTimeFormatter;
 import java.util.*;
+import java.util.stream.Stream;
 import java.util.stream.Collectors;
 import java.util.zip.ZipEntry;
 
+
 /**
  * A {@link Workbook} contains one or more {@link Worksheet} objects.
  */
 public class Workbook {
 
+    private int activeTab = 0;
     private final String applicationName;
     private final String applicationVersion;
     private final List<Worksheet> worksheets = new ArrayList<>();
@@ -79,6 +82,10 @@ public void setCompressionLevel(int level) {
         this.os.setLevel(level);
     }
 
+    public void setActiveTab(int tabIndex) {
+        this.activeTab = tabIndex;
+    }
+
     /**
      * Sort the current worksheets with the given Comparator
      *
@@ -184,14 +191,36 @@ private void writeWorkbookFile() throws IOException {
                             "xmlns:r=\"http://schemas.openxmlformats.org/officeDocument/2006/relationships\">" +
                     "<workbookPr date1904=\"false\"/>" +
                         "<bookViews>" +
-                            "<workbookView activeTab=\"0\"/>" +
+                            "<workbookView activeTab=\"" + activeTab + "\"/>" +
                         "</bookViews>" +
                         "<sheets>");
 
             for (Worksheet ws : worksheets) {
                 writeWorkbookSheet(w, ws);
             }
-            w.append("</sheets></workbook>");
+            w.append("</sheets>");
+            /** Defining repeating rows and columns for the print setup...
+             *  This is defined for each sheet separately 
+             * (if there are any repeating rows or cols in the sheet at all) **/
+    
+            for (Worksheet ws : worksheets) {
+                String defineName = Stream.of(ws.getRepeatingCols(),ws.getRepeatingRows())
+                                .filter(Objects::nonNull)
+                                .map(r -> ws.getName() + "!" + r.toString())
+                                .collect(Collectors.joining(","));
+                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>");
+                }
+            }
+            w.append("</workbook>");
         });
     }