+ * In Excel this state is only available programmatically in VBA:
+ * ThisWorkbook.Sheets("MySheetName").Visible = xlSheetVeryHidden
+ *
true if sheet is hidden
+ * @see #getSheetVisibility(int)
*/
boolean isSheetHidden(int sheetIx);
@@ -561,6 +572,7 @@ public interface Workbook extends Closeable, Iterabletrue if sheet is very hidden
+ * @see #getSheetVisibility(int)
*/
boolean isSheetVeryHidden(int sheetIx);
@@ -572,6 +584,7 @@ public interface Workbook extends Closeable, IterableWorkbook.SHEET_STATE_HIDDEN, or
* Workbook.SHEET_STATE_VERY_HIDDEN.
* @throws IllegalArgumentException if the supplied sheet index or state is invalid
+ * @deprecated POI 3.16 beta 2. Use {@link #setSheetVisibility(int, SheetVisibility)} instead.
*/
+ @Removal(version="3.18")
void setSheetHidden(int sheetIx, int hidden);
+
+ /**
+ * Get the visibility (visible, hidden, very hidden) of a sheet in this workbook
+ *
+ * @param sheetIx the index of the sheet
+ * @return the sheet visibility
+ * @since POI 3.16 beta 2
+ */
+ SheetVisibility getSheetVisibility(int sheetIx);
+
+ /**
+ * 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 visibility the sheet visibility to set
+ * @since POI 3.16 beta 2
+ */
+ void setSheetVisibility(int sheetIx, SheetVisibility visibility);
/**
* Register a new toolpack in this workbook.
diff --git a/src/java/org/apache/poi/ss/util/WorkbookUtil.java b/src/java/org/apache/poi/ss/util/WorkbookUtil.java
index 684434823c..e14b8e0c58 100644
--- a/src/java/org/apache/poi/ss/util/WorkbookUtil.java
+++ b/src/java/org/apache/poi/ss/util/WorkbookUtil.java
@@ -17,7 +17,10 @@
package org.apache.poi.ss.util;
+import org.apache.poi.ss.usermodel.SheetVisibility;
import org.apache.poi.ss.usermodel.Workbook;
+import org.apache.poi.util.Internal;
+import org.apache.poi.util.Removal;
/**
@@ -169,14 +172,46 @@ public class WorkbookUtil {
* {@link Workbook#SHEET_STATE_VISIBLE},
* {@link Workbook#SHEET_STATE_HIDDEN} or
* {@link Workbook#SHEET_STATE_VERY_HIDDEN}
+ * @deprecated POI 3.16 beta 2. Use {@link org.apache.poi.ss.usermodel.SheetVisibility} instead.
*/
+ @Removal(version="3.18")
+ @Deprecated
public static void validateSheetState(int state) {
switch(state){
case Workbook.SHEET_STATE_VISIBLE: break;
case Workbook.SHEET_STATE_HIDDEN: break;
case Workbook.SHEET_STATE_VERY_HIDDEN: break;
- default: throw new IllegalArgumentException("Ivalid sheet state : " + state + "\n" +
+ default: throw new IllegalArgumentException("Invalid sheet state : " + state + "\n" +
"Sheet state must beone of the Workbook.SHEET_STATE_* constants");
}
- }
+ }
+
+ @Internal(since="3.16 beta 2")
+ public static int getNextActiveSheetDueToSheetHiding(Workbook wb, int sheetIx) {
+ if (sheetIx == wb.getActiveSheetIndex()) {
+ // activate next sheet
+ // if last sheet in workbook, the previous visible sheet should be activated
+ final int count = wb.getNumberOfSheets();
+ for (int i=sheetIx+1; i < count; i++) {
+ // get the next visible sheet in this workbook
+ if (SheetVisibility.VISIBLE == wb.getSheetVisibility(i)) {
+ return i;
+ }
+ }
+
+ // if there are no sheets to the right or all sheets to the right are hidden, activate a sheet to the left
+ for (int i=sheetIx-1; i < count; i--) {
+ if (SheetVisibility.VISIBLE == wb.getSheetVisibility(i)) {
+ return i;
+ }
+ }
+
+ // there are no other visible sheets in this workbook
+ return -1;
+ //throw new IllegalStateException("Cannot hide sheet " + sheetIx + ". Workbook must contain at least 1 other visible sheet.");
+ }
+ else {
+ return sheetIx;
+ }
+ }
}
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 611f16bc0c..026a45be7a 100644
--- a/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java
+++ b/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java
@@ -47,6 +47,7 @@ import org.apache.poi.ss.usermodel.Name;
import org.apache.poi.ss.usermodel.PictureData;
import org.apache.poi.ss.usermodel.Row.MissingCellPolicy;
import org.apache.poi.ss.usermodel.Sheet;
+import org.apache.poi.ss.usermodel.SheetVisibility;
import org.apache.poi.ss.usermodel.Workbook;
import org.apache.poi.util.IOUtils;
import org.apache.poi.util.Internal;
@@ -1239,94 +1240,56 @@ public class SXSSFWorkbook implements Workbook {
return _wb.isDate1904();
}
- /**
- * @return false if this workbook is not visible in the GUI
- */
@Override
+ @NotImplemented("XSSFWorkbook#isHidden is not implemented")
public boolean isHidden()
{
return _wb.isHidden();
}
- /**
- * @param hiddenFlag pass false to make the workbook visible in the GUI
- */
@Override
+ @NotImplemented("XSSFWorkbook#setHidden is not implemented")
public void setHidden(boolean hiddenFlag)
{
_wb.setHidden(hiddenFlag);
}
- /**
- * Check whether a sheet is hidden.
- * - * Note that a sheet could instead be set to be very hidden, which is different - * ({@link #isSheetVeryHidden(int)}) - *
- * @param sheetIx Number - * @returntrue if sheet is hidden
- */
@Override
public boolean isSheetHidden(int sheetIx)
{
return _wb.isSheetHidden(sheetIx);
}
- /**
- * Check whether a sheet is very hidden.
- * - * This is different from the normal hidden status - * ({@link #isSheetHidden(int)}) - *
- * @param sheetIx sheet index to check - * @returntrue if sheet is very hidden
- */
@Override
public boolean isSheetVeryHidden(int sheetIx)
{
return _wb.isSheetVeryHidden(sheetIx);
}
+
+ @Override
+ public SheetVisibility getSheetVisibility(int sheetIx) {
+ return _wb.getSheetVisibility(sheetIx);
+ }
- /**
- * 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
- */
@Override
public void setSheetHidden(int sheetIx, boolean hidden)
{
_wb.setSheetHidden(sheetIx,hidden);
}
- /**
- * Hide or unhide a sheet.
- *
- * Workbook constants:
- * Workbook.SHEET_STATE_VISIBLE,
- * Workbook.SHEET_STATE_HIDDEN, or
- * Workbook.SHEET_STATE_VERY_HIDDEN.
- * @throws IllegalArgumentException if the supplied sheet index or state is invalid
- */
+ @Removal(version="3.18")
+ @Deprecated
@Override
public void setSheetHidden(int sheetIx, int hidden)
{
_wb.setSheetHidden(sheetIx,hidden);
}
+ @Override
+ public void setSheetVisibility(int sheetIx, SheetVisibility visibility) {
+ _wb.setSheetVisibility(sheetIx, visibility);
+ }
+
/**
* Not implemented for SXSSFWorkbook
*
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 6aa2064c38..a64681222f 100644
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
@@ -37,12 +37,14 @@ import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.NoSuchElementException;
+import java.util.logging.Logger;
import java.util.regex.Pattern;
import javax.xml.namespace.QName;
import org.apache.commons.collections4.ListValuedMap;
import org.apache.commons.collections4.multimap.ArrayListValuedHashMap;
+import org.apache.commons.logging.Log;
import org.apache.poi.POIXMLDocument;
import org.apache.poi.POIXMLDocumentPart;
import org.apache.poi.POIXMLException;
@@ -71,6 +73,7 @@ import org.apache.poi.ss.usermodel.Name;
import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.usermodel.Row.MissingCellPolicy;
import org.apache.poi.ss.usermodel.Sheet;
+import org.apache.poi.ss.usermodel.SheetVisibility;
import org.apache.poi.ss.usermodel.Workbook;
import org.apache.poi.ss.util.CellReference;
import org.apache.poi.ss.util.WorkbookUtil;
@@ -81,6 +84,7 @@ import org.apache.poi.util.NotImplemented;
import org.apache.poi.util.POILogFactory;
import org.apache.poi.util.POILogger;
import org.apache.poi.util.PackageHelper;
+import org.apache.poi.util.Removal;
import org.apache.poi.xssf.XLSBUnsupportedException;
import org.apache.poi.xssf.model.CalculationChain;
import org.apache.poi.xssf.model.ExternalLinksTable;
@@ -1940,15 +1944,6 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook {
throw new RuntimeException("Not implemented yet");
}
- /**
- * Check whether a sheet is hidden.
- * - * Note that a sheet could instead be set to be very hidden, which is different - * ({@link #isSheetVeryHidden(int)}) - *
- * @param sheetIx Number - * @returntrue if sheet is hidden
- */
@Override
public boolean isSheetHidden(int sheetIx) {
validateSheetIndex(sheetIx);
@@ -1956,70 +1951,69 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook {
return ctSheet.getState() == STSheetState.HIDDEN;
}
- /**
- * Check whether a sheet is very hidden.
- * - * This is different from the normal hidden status - * ({@link #isSheetHidden(int)}) - *
- * @param sheetIx sheet index to check - * @returntrue if sheet is very hidden
- */
@Override
public boolean isSheetVeryHidden(int sheetIx) {
validateSheetIndex(sheetIx);
CTSheet ctSheet = sheets.get(sheetIx).sheet;
return ctSheet.getState() == STSheetState.VERY_HIDDEN;
}
+
+ @Override
+ public SheetVisibility getSheetVisibility(int sheetIx) {
+ validateSheetIndex(sheetIx);
+ final CTSheet ctSheet = sheets.get(sheetIx).sheet;
+ final STSheetState.Enum state = ctSheet.getState();
+ if (state == STSheetState.VISIBLE) {
+ return SheetVisibility.VISIBLE;
+ }
+ if (state == STSheetState.HIDDEN) {
+ return SheetVisibility.HIDDEN;
+ }
+ if (state == STSheetState.VERY_HIDDEN) {
+ return SheetVisibility.VERY_HIDDEN;
+ }
+ throw new IllegalArgumentException("This should never happen");
+ }
- /**
- * Sets the visible state of this sheet.
- *
- * Calling setSheetHidden(sheetIndex, true) is equivalent to
- * setSheetHidden(sheetIndex, Workbook.SHEET_STATE_HIDDEN).
- *
- * Calling setSheetHidden(sheetIndex, false) is equivalent to
- * setSheetHidden(sheetIndex, Workbook.SHEET_STATE_VISIBLE).
- *
Workbook constants:
- * Workbook.SHEET_STATE_VISIBLE,
- * Workbook.SHEET_STATE_HIDDEN, or
- * Workbook.SHEET_STATE_VERY_HIDDEN.
- * @throws IllegalArgumentException if the supplied sheet index or state is invalid
- */
+ @Deprecated
+ @Removal(version="3.18")
@Override
public void setSheetHidden(int sheetIx, int state) {
- validateSheetIndex(sheetIx);
WorkbookUtil.validateSheetState(state);
- CTSheet ctSheet = sheets.get(sheetIx).sheet;
- ctSheet.setState(STSheetState.Enum.forInt(state + 1));
+ setSheetVisibility(sheetIx, SheetVisibility.values()[state]);
}
+
+ @Override
+ public void setSheetVisibility(int sheetIx, SheetVisibility visibility) {
+ validateSheetIndex(sheetIx);
+
+ /*if (visibility != SheetVisibility.VISIBLE && sheetIx == getActiveSheetIndex()) {
+ throw new IllegalStateException("Cannot hide the active sheet. Change active sheet before hiding.");
+ }*/
+
+ final CTSheet ctSheet = sheets.get(sheetIx).sheet;
+ switch (visibility) {
+ case VISIBLE:
+ ctSheet.setState(STSheetState.VISIBLE);
+ break;
+ case HIDDEN:
+ ctSheet.setState(STSheetState.HIDDEN);
+ break;
+ case VERY_HIDDEN:
+ ctSheet.setState(STSheetState.VERY_HIDDEN);
+ break;
+ default:
+ throw new IllegalArgumentException("This should never happen");
+ }
+ }
+
+
+
/**
* Fired when a formula is deleted from this workbook,
diff --git a/src/testcases/org/apache/poi/ss/usermodel/BaseTestSheetHiding.java b/src/testcases/org/apache/poi/ss/usermodel/BaseTestSheetHiding.java
index 6ce1e13d42..5a35b3b4b5 100644
--- a/src/testcases/org/apache/poi/ss/usermodel/BaseTestSheetHiding.java
+++ b/src/testcases/org/apache/poi/ss/usermodel/BaseTestSheetHiding.java
@@ -25,8 +25,10 @@ import static org.junit.Assert.fail;
import java.io.IOException;
import org.apache.poi.ss.ITestDataProvider;
+import org.apache.poi.util.Removal;
import org.junit.After;
import org.junit.Before;
+import org.junit.Ignore;
import org.junit.Test;
public abstract class BaseTestSheetHiding {
@@ -59,8 +61,15 @@ public abstract class BaseTestSheetHiding {
wbU.close();
}
+ /**
+ * @deprecated 3.16 beta 2. Use {@link #testSheetVisibility()} instead.
+ *
+ * @throws IOException
+ */
+ @Removal(version="3.18")
+ @Deprecated
@Test
- public final void testSheetHidden() throws IOException {
+ public final void testSheetHiddenOld() throws IOException {
Workbook wb = _testDataProvider.createWorkbook();
wb.createSheet("MySheet");
@@ -94,6 +103,59 @@ public abstract class BaseTestSheetHiding {
wb.close();
}
+
+ @Test
+ public final void testSheetVisibility() throws IOException {
+ Workbook wb = _testDataProvider.createWorkbook();
+ wb.createSheet("MySheet");
+
+ assertFalse(wb.isSheetHidden(0));
+ assertFalse(wb.isSheetVeryHidden(0));
+ assertEquals(SheetVisibility.VISIBLE, wb.getSheetVisibility(0));
+
+ wb.setSheetVisibility(0, SheetVisibility.HIDDEN);
+ assertTrue(wb.isSheetHidden(0));
+ assertFalse(wb.isSheetVeryHidden(0));
+ assertEquals(SheetVisibility.HIDDEN, wb.getSheetVisibility(0));
+
+ wb.setSheetVisibility(0, SheetVisibility.VERY_HIDDEN);
+ assertFalse(wb.isSheetHidden(0));
+ assertTrue(wb.isSheetVeryHidden(0));
+ assertEquals(SheetVisibility.VERY_HIDDEN, wb.getSheetVisibility(0));
+
+ wb.setSheetVisibility(0, SheetVisibility.VISIBLE);
+ assertFalse(wb.isSheetHidden(0));
+ assertFalse(wb.isSheetVeryHidden(0));
+ assertEquals(SheetVisibility.VISIBLE, wb.getSheetVisibility(0));
+
+ wb.close();
+ }
+
+ @Ignore
+ @Test
+ public void testCannotHideActiveSheet() throws IOException {
+ Workbook wb = _testDataProvider.createWorkbook();
+ wb.createSheet("Active Sheet");
+ wb.createSheet("Inactive Sheet");
+ wb.setActiveSheet(0);
+ assertEquals(0, wb.getActiveSheetIndex());
+
+ try {
+ wb.setSheetVisibility(0, SheetVisibility.VERY_HIDDEN);
+ fail("Should not be able to hide an active sheet");
+ } catch (final IllegalStateException e) {
+ // expected
+ }
+
+ try {
+ wb.setSheetVisibility(0, SheetVisibility.HIDDEN);
+ fail("Should not be able to hide an active sheet");
+ } catch (final IllegalStateException e) {
+ // expected
+ }
+
+ wb.close();
+ }
/**
* Test that we get the right number of sheets,