Patch from Ugo to get and set the sheet hidden flag (bug #43937)

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@609942 13f79535-47bb-0310-9956-ffa450edef68

3 files changed, 62 insertions, 0 deletions

diff --git a/src/java/org/apache/poi/hssf/model/Workbook.java b/src/java/org/apache/poi/hssf/model/Workbook.java
index 972aa09015..2af77a7814 100644
--- a/src/java/org/apache/poi/hssf/model/Workbook.java
+++ b/src/java/org/apache/poi/hssf/model/Workbook.java
@@ -543,6 +543,29 @@ public class Workbook implements Model
     }
 
     /**
+     * gets the hidden flag for a given sheet.
+     *
+     * @param sheetnum the sheet number (0 based)
+     * @return True if sheet is hidden
+     */
+
+    public boolean isSheetHidden(int sheetnum) {
+        BoundSheetRecord bsr = ( BoundSheetRecord ) boundsheets.get(sheetnum);
+        return bsr.isHidden();
+    }
+
+    /**
+     * Hide or unhide a sheet
+     * 
+     * @param sheetnum The sheet number
+     * @param hidden True to mark the sheet as hidden, false otherwise
+     */
+    
+    public void setSheetHidden(int sheetnum, boolean hidden) {
+        BoundSheetRecord bsr = ( BoundSheetRecord ) boundsheets.get(sheetnum);
+        bsr.setHidden(hidden);
+    }
+    /**
      * get the sheet's index
      * @param name  sheet name
      * @return sheet index or -1 if it was not found.
diff --git a/src/java/org/apache/poi/hssf/record/BoundSheetRecord.java b/src/java/org/apache/poi/hssf/record/BoundSheetRecord.java
index bf264bf02a..78daff2ebb 100644
--- a/src/java/org/apache/poi/hssf/record/BoundSheetRecord.java
+++ b/src/java/org/apache/poi/hssf/record/BoundSheetRecord.java
@@ -19,6 +19,7 @@
 
 package org.apache.poi.hssf.record;
 
+import org.apache.poi.util.BitFieldFactory;
 import org.apache.poi.util.LittleEndian;
 import org.apache.poi.util.StringUtil;
 
@@ -36,6 +37,7 @@ import org.apache.poi.util.StringUtil;
 public class BoundSheetRecord
         extends Record
 {
+    private static final short HIDDEN_FLAG_MASK = 0x01;
     public final static short sid = 0x85;
     private int field_1_position_of_BOF;
     private short field_2_option_flags;
@@ -301,4 +303,12 @@ public class BoundSheetRecord
     {
         return sid;
     }
+
+    public boolean isHidden() {
+	    return BitFieldFactory.getInstance(HIDDEN_FLAG_MASK).isSet(field_2_option_flags);
+    }
+
+    public void setHidden(boolean hidden) {
+	    field_2_option_flags = BitFieldFactory.getInstance(HIDDEN_FLAG_MASK).setShortBoolean(field_2_option_flags, hidden);
+    }
 }
diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java b/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
index 487f9c6b22..e237ed75db 100644
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
@@ -445,6 +445,35 @@ public class HSSFWorkbook extends POIDocument
         return workbook.getSheetName(sheet);
     }
 
+    /**
+     * check whether a sheet is hidden
+     * @param sheet Number
+     * @return True if sheet is hidden
+     */
+
+    public boolean isSheetHidden(int sheet) {
+        if (sheet > (sheets.size() - 1))
+        {
+            throw new RuntimeException("Sheet out of bounds");
+        }
+        return workbook.isSheetHidden(sheet);
+    }
+
+    /**
+     * Hide or unhide a sheet
+     * 
+     * @param sheetnum The sheet number
+     * @param hidden True to mark the sheet as hidden, false otherwise
+     */
+
+    public void setSheetHidden(int sheet, boolean hidden) {
+        if (sheet > (sheets.size() - 1))
+        {
+            throw new RuntimeException("Sheet out of bounds");
+        }
+        workbook.setSheetHidden(sheet,hidden);
+    }
+    
     /*
      * get the sheet's index
      * @param name  sheet name