<changes>
<release version="3.7-beta3" date="2010-??-??">
+ <action dev="poi-developers" type="fix">49878 - improved API for hiding sheets</action>
<action dev="poi-developers" type="fix">49875 - fixed XSSFWorkbook.createSheet to throw exception if sheet name begins or ends with a single quote (')</action>
<action dev="poi-developers" type="fix">49873 - fixed XSSFFormulaEvaluator to support blank cells</action>
<action dev="poi-developers" type="fix">49850 - added a getter for _iStartAt in ListFormatOverrideLevel</action>
import org.apache.poi.ss.usermodel.CreationHelper;
import org.apache.poi.ss.usermodel.Row.MissingCellPolicy;
import org.apache.poi.ss.formula.FormulaType;
+import org.apache.poi.ss.util.WorkbookUtil;
import org.apache.poi.util.POILogFactory;
import org.apache.poi.util.POILogger;
public void setSheetHidden(int sheetIx, int hidden) {
validateSheetIndex(sheetIx);
+ WorkbookUtil.validateSheetState(hidden);
workbook.setSheetHidden(sheetIx, hidden);
}
/** Device independent bitmap */
public static final int PICTURE_TYPE_DIB = 7;
+
+ /**
+ * Indicates the sheet is visible.
+ *
+ * @see #setSheetHidden(int, int)
+ */
+ public static final int SHEET_STATE_VISIBLE = 0;
+
+ /**
+ * Indicates the book window is hidden, but can be shown by the user via the user interface.
+ *
+ * @see #setSheetHidden(int, int)
+ */
+ public static final int SHEET_STATE_HIDDEN = 1;
+
+ /**
+ * Indicates the sheet is hidden and cannot be shown in the user interface (UI).
+ *
+ * <p>
+ * In Excel this state is only available programmatically in VBA:
+ * <code>ThisWorkbook.Sheets("MySheetName").Visible = xlSheetVeryHidden </code>
+ * </p>
+ *
+ * @see #setSheetHidden(int, int)
+ */
+ public static final int SHEET_STATE_VERY_HIDDEN = 2;
+
/**
* Convenience method to get the active sheet. The active sheet is is the sheet
* which is currently displayed when the workbook is viewed in Excel.
/**
* Hide or unhide a sheet.
- * <pre>
- * 0 = not hidden
- * 1 = hidden
- * 2 = very hidden.
- * </pre>
- * @param sheetIx The sheet number
- * @param hidden 0 for not hidden, 1 for hidden, 2 for very hidden
+ *
+ * <ul>
+ * <li>0 - visible. </li>
+ * <li>1 - hidden. </li>
+ * <li>2 - very hidden.</li>
+ * </ul>
+ * @param sheetIx the sheet index (0-based)
+ * @param hidden one of the following <code>Workbook</code> constants:
+ * <code>Workbook.SHEET_STATE_VISIBLE</code>,
+ * <code>Workbook.SHEET_STATE_HIDDEN</code>, or
+ * <code>Workbook.SHEET_STATE_VERY_HIDDEN</code>.
+ * @throws IllegalArgumentException if the supplied sheet index or state is invalid
*/
void setSheetHidden(int sheetIx, int hidden);
}
package org.apache.poi.ss.util;
+import org.apache.poi.ss.usermodel.Workbook;
+
/**
* Helper methods for when working with Usermodel Workbooks
}
}
+
+ 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" +
+ "Sheet state must beone of the Workbook.SHEET_STATE_* constants");
+ }
+ }
}
throw new RuntimeException("Not implemented yet");
}
+ /**
+ * Check whether a sheet is hidden.
+ * <p>
+ * Note that a sheet could instead be set to be very hidden, which is different
+ * ({@link #isSheetVeryHidden(int)})
+ * </p>
+ * @param sheetIx Number
+ * @return <code>true</code> if sheet is hidden
+ */
public boolean isSheetHidden(int sheetIx) {
validateSheetIndex(sheetIx);
CTSheet ctSheet = sheets.get(sheetIx).sheet;
return ctSheet.getState() == STSheetState.HIDDEN;
}
+ /**
+ * Check whether a sheet is very hidden.
+ * <p>
+ * This is different from the normal hidden status
+ * ({@link #isSheetHidden(int)})
+ * </p>
+ * @param sheetIx sheet index to check
+ * @return <code>true</code> if sheet is very hidden
+ */
public boolean isSheetVeryHidden(int sheetIx) {
validateSheetIndex(sheetIx);
CTSheet ctSheet = sheets.get(sheetIx).sheet;
return ctSheet.getState() == STSheetState.VERY_HIDDEN;
}
+ /**
+ * Sets the visible state of this sheet.
+ * <p>
+ * Calling <code>setSheetHidden(sheetIndex, true)</code> is equivalent to
+ * <code>setSheetHidden(sheetIndex, Workbook.SHEET_STATE_HIDDEN)</code>.
+ * <br/>
+ * Calling <code>setSheetHidden(sheetIndex, false)</code> is equivalent to
+ * <code>setSheetHidden(sheetIndex, Workbook.SHEET_STATE_VISIBLE)</code>.
+ * </p>
+ *
+ * @param sheetIx the 0-based index of the sheet
+ * @param hidden whether this sheet is hidden
+ * @see #setSheetHidden(int, int)
+ */
public void setSheetHidden(int sheetIx, boolean hidden) {
- validateSheetIndex(sheetIx);
- CTSheet ctSheet = sheets.get(sheetIx).sheet;
- ctSheet.setState(hidden ? STSheetState.HIDDEN : STSheetState.VISIBLE);
+ setSheetHidden(sheetIx, hidden ? SHEET_STATE_HIDDEN : SHEET_STATE_VISIBLE);
}
- public void setSheetHidden(int sheetIx, int hidden) {
+ /**
+ * Hide or unhide a sheet.
+ *
+ * <ul>
+ * <li>0 - visible. </li>
+ * <li>1 - hidden. </li>
+ * <li>2 - very hidden.</li>
+ * </ul>
+ * @param sheetIx the sheet index (0-based)
+ * @param state one of the following <code>Workbook</code> constants:
+ * <code>Workbook.SHEET_STATE_VISIBLE</code>,
+ * <code>Workbook.SHEET_STATE_HIDDEN</code>, or
+ * <code>Workbook.SHEET_STATE_VERY_HIDDEN</code>.
+ * @throws IllegalArgumentException if the supplied sheet index or state is invalid
+ */
+ public void setSheetHidden(int sheetIx, int state) {
validateSheetIndex(sheetIx);
+ WorkbookUtil.validateSheetState(state);
CTSheet ctSheet = sheets.get(sheetIx).sheet;
- ctSheet.setState(STSheetState.Enum.forInt(hidden));
+ ctSheet.setState(STSheetState.Enum.forInt(state + 1));
}
/**
import junit.framework.TestCase;
import org.apache.poi.xssf.XSSFTestDataSamples;
+import org.apache.poi.xssf.XSSFITestDataProvider;
+import org.apache.poi.ss.usermodel.BaseTestSheetHiding;
/**
* @author Yegor Kozlov
*/
-public final class TestSheetHiding extends TestCase {
- private XSSFWorkbook wbH;
- private XSSFWorkbook wbU;
-
- protected void setUp() {
- wbH = XSSFTestDataSamples.openSampleWorkbook("TwoSheetsOneHidden.xlsx");
- wbU = XSSFTestDataSamples.openSampleWorkbook("TwoSheetsNoneHidden.xlsx");
- }
-
- /**
- * Test that we get the right number of sheets,
- * with the right text on them, no matter what
- * the hidden flags are
- */
- public void testTextSheets() {
- // Both should have two sheets
- assertEquals(2, wbH.getNumberOfSheets());
- assertEquals(2, wbU.getNumberOfSheets());
-
- // All sheets should have one row
- assertEquals(0, wbH.getSheetAt(0).getLastRowNum());
- assertEquals(0, wbH.getSheetAt(1).getLastRowNum());
- assertEquals(0, wbU.getSheetAt(0).getLastRowNum());
- assertEquals(0, wbU.getSheetAt(1).getLastRowNum());
-
- // All rows should have one column
- assertEquals(1, wbH.getSheetAt(0).getRow(0).getLastCellNum());
- assertEquals(1, wbH.getSheetAt(1).getRow(0).getLastCellNum());
- assertEquals(1, wbU.getSheetAt(0).getRow(0).getLastCellNum());
- assertEquals(1, wbU.getSheetAt(1).getRow(0).getLastCellNum());
-
- // Text should be sheet based
- assertEquals("Sheet1A1", wbH.getSheetAt(0).getRow(0).getCell(0).getRichStringCellValue().getString());
- assertEquals("Sheet2A1", wbH.getSheetAt(1).getRow(0).getCell(0).getRichStringCellValue().getString());
- assertEquals("Sheet1A1", wbU.getSheetAt(0).getRow(0).getCell(0).getRichStringCellValue().getString());
- assertEquals("Sheet2A1", wbU.getSheetAt(1).getRow(0).getCell(0).getRichStringCellValue().getString());
- }
-
- /**
- * Check that we can get and set the hidden flags
- * as expected
- */
- public void testHideUnHideFlags() {
- assertTrue(wbH.isSheetHidden(0));
- assertFalse(wbH.isSheetHidden(1));
- assertFalse(wbU.isSheetHidden(0));
- assertFalse(wbU.isSheetHidden(1));
- }
-
- /**
- * Turn the sheet with none hidden into the one with
- * one hidden
- */
- public void testHide() {
- wbU.setSheetHidden(0, true);
- assertTrue(wbU.isSheetHidden(0));
- assertFalse(wbU.isSheetHidden(1));
- XSSFWorkbook wb2 = XSSFTestDataSamples.writeOutAndReadBack(wbU);
- assertTrue(wb2.isSheetHidden(0));
- assertFalse(wb2.isSheetHidden(1));
- }
-
- /**
- * Turn the sheet with one hidden into the one with
- * none hidden
- */
- public void testUnHide() {
- wbH.setSheetHidden(0, false);
- assertFalse(wbH.isSheetHidden(0));
- assertFalse(wbH.isSheetHidden(1));
- XSSFWorkbook wb2 = XSSFTestDataSamples.writeOutAndReadBack(wbH);
- assertFalse(wb2.isSheetHidden(0));
- assertFalse(wb2.isSheetHidden(1));
+public final class TestSheetHiding extends BaseTestSheetHiding {
+ public TestSheetHiding() {
+ super(XSSFITestDataProvider.instance,
+ "TwoSheetsOneHidden.xlsx", "TwoSheetsNoneHidden.xlsx");
}
}
assertTrue(wb.isSheetVeryHidden(2));
// Change 0 to be very hidden, and re-load
- wb.setSheetHidden(0, 2);
+ wb.setSheetHidden(0, HSSFWorkbook.SHEET_STATE_VERY_HIDDEN);
HSSFWorkbook nwb = writeOutAndReadBack(wb);
import junit.framework.TestCase;
import org.apache.poi.hssf.HSSFTestDataSamples;
+import org.apache.poi.hssf.HSSFITestDataProvider;
+import org.apache.poi.ss.usermodel.BaseTestSheetHiding;
/**
- * Tests for how HSSFWorkbook behaves with XLS files
- * with a WORKBOOK directory entry (instead of the more
- * usual, Workbook)
+ * @author Yegor Kozlov
*/
-public final class TestSheetHiding extends TestCase {
- private HSSFWorkbook wbH;
- private HSSFWorkbook wbU;
-
- protected void setUp() {
- wbH = HSSFTestDataSamples.openSampleWorkbook("TwoSheetsOneHidden.xls");
- wbU = HSSFTestDataSamples.openSampleWorkbook("TwoSheetsNoneHidden.xls");
- }
-
- /**
- * Test that we get the right number of sheets,
- * with the right text on them, no matter what
- * the hidden flags are
- */
- public void testTextSheets() {
- // Both should have two sheets
- assertEquals(2, wbH.getNumberOfSheets());
- assertEquals(2, wbU.getNumberOfSheets());
-
- // All sheets should have one row
- assertEquals(0, wbH.getSheetAt(0).getLastRowNum());
- assertEquals(0, wbH.getSheetAt(1).getLastRowNum());
- assertEquals(0, wbU.getSheetAt(0).getLastRowNum());
- assertEquals(0, wbU.getSheetAt(1).getLastRowNum());
-
- // All rows should have one column
- assertEquals(1, wbH.getSheetAt(0).getRow(0).getLastCellNum());
- assertEquals(1, wbH.getSheetAt(1).getRow(0).getLastCellNum());
- assertEquals(1, wbU.getSheetAt(0).getRow(0).getLastCellNum());
- assertEquals(1, wbU.getSheetAt(1).getRow(0).getLastCellNum());
-
- // Text should be sheet based
- assertEquals("Sheet1A1", wbH.getSheetAt(0).getRow(0).getCell(0).getRichStringCellValue().getString());
- assertEquals("Sheet2A1", wbH.getSheetAt(1).getRow(0).getCell(0).getRichStringCellValue().getString());
- assertEquals("Sheet1A1", wbU.getSheetAt(0).getRow(0).getCell(0).getRichStringCellValue().getString());
- assertEquals("Sheet2A1", wbU.getSheetAt(1).getRow(0).getCell(0).getRichStringCellValue().getString());
- }
-
- /**
- * Check that we can get and set the hidden flags
- * as expected
- */
- public void testHideUnHideFlags() {
- assertTrue(wbH.isSheetHidden(0));
- assertFalse(wbH.isSheetHidden(1));
- assertFalse(wbU.isSheetHidden(0));
- assertFalse(wbU.isSheetHidden(1));
- }
-
- /**
- * Turn the sheet with none hidden into the one with
- * one hidden
- */
- public void testHide() throws Exception {
- wbU.setSheetHidden(0, true);
- assertTrue(wbU.isSheetHidden(0));
- assertFalse(wbU.isSheetHidden(1));
- ByteArrayOutputStream out = new ByteArrayOutputStream();
- wbU.write(out);
- out.close();
- HSSFWorkbook wb2 = new HSSFWorkbook(new ByteArrayInputStream(out.toByteArray()));
- assertTrue(wb2.isSheetHidden(0));
- assertFalse(wb2.isSheetHidden(1));
- }
-
- /**
- * Turn the sheet with one hidden into the one with
- * none hidden
- */
- public void testUnHide() throws Exception {
- wbH.setSheetHidden(0, false);
- assertFalse(wbH.isSheetHidden(0));
- assertFalse(wbH.isSheetHidden(1));
- ByteArrayOutputStream out = new ByteArrayOutputStream();
- wbH.write(out);
- out.close();
- HSSFWorkbook wb2 = new HSSFWorkbook(new ByteArrayInputStream(out.toByteArray()));
- assertFalse(wb2.isSheetHidden(0));
- assertFalse(wb2.isSheetHidden(1));
- }
+public final class TestSheetHiding extends BaseTestSheetHiding {
+ public TestSheetHiding() {
+ super(HSSFITestDataProvider.instance,
+ "TwoSheetsOneHidden.xls", "TwoSheetsNoneHidden.xls");
+ }
}
--- /dev/null
+/* ====================================================================
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.apache.poi.ss.usermodel;
+
+import junit.framework.TestCase;
+
+import org.apache.poi.ss.ITestDataProvider;
+
+/**
+ */
+public abstract class BaseTestSheetHiding extends TestCase {
+
+ protected final ITestDataProvider _testDataProvider;
+ protected Workbook wbH;
+ protected Workbook wbU;
+
+ private String _file1, _file2;
+
+ /**
+ * @param testDataProvider an object that provides test data in HSSF / specific way
+ */
+ protected BaseTestSheetHiding(ITestDataProvider testDataProvider,
+ String file1, String file2) {
+ _testDataProvider = testDataProvider;
+ _file1 = file1;
+ _file2 = file2;
+ }
+
+ protected void setUp() {
+ wbH = _testDataProvider.openSampleWorkbook(_file1);
+ wbU = _testDataProvider.openSampleWorkbook(_file2);
+ }
+
+
+ public final void testSheetHidden() {
+ Workbook wb = _testDataProvider.createWorkbook();
+ Sheet sh = wb.createSheet("MySheet");
+
+ assertFalse(wb.isSheetHidden(0));
+ assertFalse(wb.isSheetVeryHidden(0));
+
+ wb.setSheetHidden(0, Workbook.SHEET_STATE_HIDDEN);
+ assertTrue(wb.isSheetHidden(0));
+ assertFalse(wb.isSheetVeryHidden(0));
+
+ wb.setSheetHidden(0, Workbook.SHEET_STATE_VERY_HIDDEN);
+ assertFalse(wb.isSheetHidden(0));
+ assertTrue(wb.isSheetVeryHidden(0));
+
+ wb.setSheetHidden(0, Workbook.SHEET_STATE_VISIBLE);
+ assertFalse(wb.isSheetHidden(0));
+ assertFalse(wb.isSheetVeryHidden(0));
+
+ try {
+ wb.setSheetHidden(0, -1);
+ fail("expectd exception");
+ } catch (IllegalArgumentException e){
+ // ok
+ }
+ try {
+ wb.setSheetHidden(0, 3);
+ fail("expectd exception");
+ } catch (IllegalArgumentException e){
+ // ok
+ }
+ }
+
+ /**
+ * Test that we get the right number of sheets,
+ * with the right text on them, no matter what
+ * the hidden flags are
+ */
+ public void testTextSheets() {
+ // Both should have two sheets
+ assertEquals(2, wbH.getNumberOfSheets());
+ assertEquals(2, wbU.getNumberOfSheets());
+
+ // All sheets should have one row
+ assertEquals(0, wbH.getSheetAt(0).getLastRowNum());
+ assertEquals(0, wbH.getSheetAt(1).getLastRowNum());
+ assertEquals(0, wbU.getSheetAt(0).getLastRowNum());
+ assertEquals(0, wbU.getSheetAt(1).getLastRowNum());
+
+ // All rows should have one column
+ assertEquals(1, wbH.getSheetAt(0).getRow(0).getLastCellNum());
+ assertEquals(1, wbH.getSheetAt(1).getRow(0).getLastCellNum());
+ assertEquals(1, wbU.getSheetAt(0).getRow(0).getLastCellNum());
+ assertEquals(1, wbU.getSheetAt(1).getRow(0).getLastCellNum());
+
+ // Text should be sheet based
+ assertEquals("Sheet1A1", wbH.getSheetAt(0).getRow(0).getCell(0).getRichStringCellValue().getString());
+ assertEquals("Sheet2A1", wbH.getSheetAt(1).getRow(0).getCell(0).getRichStringCellValue().getString());
+ assertEquals("Sheet1A1", wbU.getSheetAt(0).getRow(0).getCell(0).getRichStringCellValue().getString());
+ assertEquals("Sheet2A1", wbU.getSheetAt(1).getRow(0).getCell(0).getRichStringCellValue().getString());
+ }
+
+ /**
+ * Check that we can get and set the hidden flags
+ * as expected
+ */
+ public void testHideUnHideFlags() {
+ assertTrue(wbH.isSheetHidden(0));
+ assertFalse(wbH.isSheetHidden(1));
+ assertFalse(wbU.isSheetHidden(0));
+ assertFalse(wbU.isSheetHidden(1));
+ }
+
+ /**
+ * Turn the sheet with none hidden into the one with
+ * one hidden
+ */
+ public void testHide() {
+ wbU.setSheetHidden(0, true);
+ assertTrue(wbU.isSheetHidden(0));
+ assertFalse(wbU.isSheetHidden(1));
+ Workbook wb2 = _testDataProvider.writeOutAndReadBack(wbU);
+ assertTrue(wb2.isSheetHidden(0));
+ assertFalse(wb2.isSheetHidden(1));
+ }
+
+ /**
+ * Turn the sheet with one hidden into the one with
+ * none hidden
+ */
+ public void testUnHide() {
+ wbH.setSheetHidden(0, false);
+ assertFalse(wbH.isSheetHidden(0));
+ assertFalse(wbH.isSheetHidden(1));
+ Workbook wb2 = _testDataProvider.writeOutAndReadBack(wbH);
+ assertFalse(wb2.isSheetHidden(0));
+ assertFalse(wb2.isSheetHidden(1));
+ }
+}
\ No newline at end of file
projects / poi.git / commitdiff