diff --git a/src/java/org/apache/poi/ss/usermodel/Workbook.java b/src/java/org/apache/poi/ss/usermodel/Workbook.java index 7de84fa88f..e5fc3c9de7 100644 --- a/src/java/org/apache/poi/ss/usermodel/Workbook.java +++ b/src/java/org/apache/poi/ss/usermodel/Workbook.java @@ -551,7 +551,10 @@ public interface Workbook extends Closeable { boolean isSheetVeryHidden(int sheetIx); /** - * Hide or unhide a sheet + * Hide or unhide a sheet. + * + * Please note that the sheet currently set as active sheet (sheet 0 in a newly + * created workbook or the one set via setActiveSheet()) cannot be hidden. * * @param sheetIx the sheet index (0-based) * @param hidden True to mark the sheet as hidden, false otherwise @@ -566,6 +569,10 @@ public interface Workbook extends Closeable { *
Workbook constants:
* Workbook.SHEET_STATE_VISIBLE,
diff --git a/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java b/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java
index f437b6a1a7..413b5adb51 100644
--- a/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java
+++ b/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java
@@ -1187,6 +1187,9 @@ public class SXSSFWorkbook implements Workbook {
/**
* Hide or unhide a sheet
+ *
+ * Please note that the sheet currently set as active sheet (sheet 0 in a newly
+ * created workbook or the one set via setActiveSheet()) cannot be hidden.
*
* @param sheetIx the sheet index (0-based)
* @param hidden True to mark the sheet as hidden, false otherwise
@@ -1205,6 +1208,10 @@ public class SXSSFWorkbook implements Workbook {
* Workbook constants:
* Workbook.SHEET_STATE_VISIBLE,
diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
index 4b4a30e0b6..c1cd1ff3f7 100644
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
@@ -1714,6 +1714,9 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, IterablesetSheetHidden(sheetIndex, Workbook.SHEET_STATE_VISIBLE).
*
+ *
+ * Please note that the sheet currently set as active sheet (sheet 0 in a newly
+ * created workbook or the one set via setActiveSheet()) cannot be hidden.
*
* @param sheetIx the 0-based index of the sheet
* @param hidden whether this sheet is hidden
@@ -1732,6 +1735,10 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, IterableWorkbook constants:
* Workbook.SHEET_STATE_VISIBLE,