You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by ce...@apache.org on 2015/09/13 21:32:51 UTC

svn commit: r1702805 - in /poi/trunk/src: java/org/apache/poi/ss/usermodel/Workbook.java ooxml/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java

Author: centic
Date: Sun Sep 13 19:32:50 2015
New Revision: 1702805

URL: http://svn.apache.org/r1702805
Log:
Update javadoc for bug 56129

Modified:
    poi/trunk/src/java/org/apache/poi/ss/usermodel/Workbook.java
    poi/trunk/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java
    poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java

Modified: poi/trunk/src/java/org/apache/poi/ss/usermodel/Workbook.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/ss/usermodel/Workbook.java?rev=1702805&r1=1702804&r2=1702805&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/ss/usermodel/Workbook.java (original)
+++ poi/trunk/src/java/org/apache/poi/ss/usermodel/Workbook.java Sun Sep 13 19:32:50 2015
@@ -551,7 +551,10 @@ public interface Workbook extends Closea
     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 Closea
      *  <li>1 - hidden. </li>
      *  <li>2 - very hidden.</li>
      * </ul>
+     * 
+     * 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 one of the following <code>Workbook</code> constants:
      *        <code>Workbook.SHEET_STATE_VISIBLE</code>,

Modified: poi/trunk/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java?rev=1702805&r1=1702804&r2=1702805&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java Sun Sep 13 19:32:50 2015
@@ -1187,6 +1187,9 @@ public class SXSSFWorkbook implements Wo
 
     /**
      * 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 Wo
      *  <li>1 - hidden. </li>
      *  <li>2 - very hidden.</li>
      * </ul>
+     * 
+     * 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 one of the following <code>Workbook</code> constants:
      *        <code>Workbook.SHEET_STATE_VISIBLE</code>,

Modified: poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java?rev=1702805&r1=1702804&r2=1702805&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java Sun Sep 13 19:32:50 2015
@@ -1714,6 +1714,9 @@ public class XSSFWorkbook extends POIXML
      *   Calling <code>setSheetHidden(sheetIndex, false)</code> is equivalent to
      *   <code>setSheetHidden(sheetIndex, Workbook.SHEET_STATE_VISIBLE)</code>.
      * </p>
+     * 
+     * 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 POIXML
      *  <li>1 - hidden. </li>
      *  <li>2 - very hidden.</li>
      * </ul>
+     * 
+     * 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 state one of the following <code>Workbook</code> constants:
      *        <code>Workbook.SHEET_STATE_VISIBLE</code>,



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org