You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by ni...@apache.org on 2017/01/20 05:51:53 UTC
svn commit: r1779568 [4/4] - in /poi/site/publish/apidocs: ./
org/apache/poi/hemf/record/ org/apache/poi/hssf/model/
org/apache/poi/hssf/usermodel/ org/apache/poi/hwmf/draw/
org/apache/poi/hwmf/record/ org/apache/poi/hwmf/record/class-use/
org/apache/p...
Modified: poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFWorkbook.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFWorkbook.html?rev=1779568&r1=1779567&r2=1779568&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFWorkbook.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFWorkbook.html Fri Jan 20 05:51:52 2017
@@ -570,82 +570,88 @@ implements <a href="../../../../../org/a
</td>
</tr>
<tr class="rowColor">
+<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/SheetVisibility.html" title="enum in org.apache.poi.ss.usermodel">SheetVisibility</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getSheetVisibility(int)">getSheetVisibility</a></strong>(int sheetIx)</code>
+<div class="block">Get the visibility (visible, hidden, very hidden) of a sheet in this workbook</div>
+</td>
+</tr>
+<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/SpreadsheetVersion.html" title="enum in org.apache.poi.ss">SpreadsheetVersion</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getSpreadsheetVersion()">getSpreadsheetVersion</a></strong>()</code>
<div class="block">Returns the spreadsheet version (EXCLE2007) of this workbook</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/model/StylesTable.html" title="class in org.apache.poi.xssf.model">StylesTable</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getStylesSource()">getStylesSource</a></strong>()</code>
<div class="block">Return a object representing a collection of shared objects used for styling content,
e.g.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFTable.html" title="class in org.apache.poi.xssf.usermodel">XSSFTable</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getTable(java.lang.String)">getTable</a></strong>(java.lang.String name)</code>
<div class="block">Returns the data table with the given name (case insensitive).</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/model/ThemesTable.html" title="class in org.apache.poi.xssf.model">ThemesTable</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getTheme()">getTheme</a></strong>()</code>
<div class="block">Returns the Theme of current workbook.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbookType.html" title="enum in org.apache.poi.xssf.usermodel">XSSFWorkbookType</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getWorkbookType()">getWorkbookType</a></strong>()</code> </td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#isDate1904()">isDate1904</a></strong>()</code>
<div class="block">Gets a boolean value that indicates whether the date systems used in the workbook starts in 1904.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#isHidden()">isHidden</a></strong>()</code> </td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#isMacroEnabled()">isMacroEnabled</a></strong>()</code>
<div class="block">Are we a normal workbook (.xlsx), or a
macro enabled workbook (.xlsm)?</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#isRevisionLocked()">isRevisionLocked</a></strong>()</code>
<div class="block">Specifies a boolean value that indicates whether the workbook is locked for revisions.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#isSheetHidden(int)">isSheetHidden</a></strong>(int sheetIx)</code>
<div class="block">Check whether a sheet is hidden.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#isSheetVeryHidden(int)">isSheetVeryHidden</a></strong>(int sheetIx)</code>
<div class="block">Check whether a sheet is very hidden.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#isStructureLocked()">isStructureLocked</a></strong>()</code>
<div class="block">Specifies a boolean value that indicates whether structure of workbook is locked.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#isWindowsLocked()">isWindowsLocked</a></strong>()</code>
<div class="block">Specifies a boolean value that indicates whether the windows that comprise the workbook are locked.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>java.util.Iterator<<a href="../../../../../org/apache/poi/ss/usermodel/Sheet.html" title="interface in org.apache.poi.ss.usermodel">Sheet</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#iterator()">iterator</a></strong>()</code>
<div class="block">Alias for <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#sheetIterator()"><code>sheetIterator()</code></a> to allow
@@ -655,7 +661,7 @@ implements <a href="../../../../../org/a
to make iterating over a container (Workbook, Sheet, Row) consistent across POI spreadsheets.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#linkExternalWorkbook(java.lang.String,%20org.apache.poi.ss.usermodel.Workbook)">linkExternalWorkbook</a></strong>(java.lang.String name,
<a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a> workbook)</code>
@@ -663,44 +669,44 @@ implements <a href="../../../../../org/a
referencing the specified external workbook to be added to this one.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#lockRevision()">lockRevision</a></strong>()</code>
<div class="block">Locks the workbook for revisions.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#lockStructure()">lockStructure</a></strong>()</code>
<div class="block">Locks the structure of workbook.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#lockWindows()">lockWindows</a></strong>()</code>
<div class="block">Locks the windows that comprise the workbook.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>protected static <a href="../../../../../org/apache/poi/openxml4j/opc/OPCPackage.html" title="class in org.apache.poi.openxml4j.opc">OPCPackage</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#newPackage(org.apache.poi.xssf.usermodel.XSSFWorkbookType)">newPackage</a></strong>(<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbookType.html" title="enum in org.apache.poi.xssf.usermodel">XSSFWorkbookType</a> workbookType)</code>
<div class="block">Create a new SpreadsheetML package and setup the default minimal content</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#onDeleteFormula(org.apache.poi.xssf.usermodel.XSSFCell)">onDeleteFormula</a></strong>(<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFCell.html" title="class in org.apache.poi.xssf.usermodel">XSSFCell</a> cell)</code>
<div class="block">Fired when a formula is deleted from this workbook,
for example when calling cell.setCellFormula(null)</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#onDocumentRead()">onDocumentRead</a></strong>()</code>
<div class="block">Fired when a package part is read</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#parseSheet(java.util.Map,%20org.openxmlformats.schemas.spreadsheetml.x2006.main.CTSheet)">parseSheet</a></strong>(java.util.Map<java.lang.String,<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html" title="class in org.apache.poi.xssf.usermodel">XSSFSheet</a>> shIdMap,
org.openxmlformats.schemas.spreadsheetml.x2006.main.CTSheet ctSheet)</code>
@@ -708,7 +714,7 @@ implements <a href="../../../../../org/a
the DOM based parse of large sheets (see examples).</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#removeName(int)">removeName</a></strong>(int nameIndex)</code>
<div class="block"><strong>Deprecated.</strong>
@@ -716,14 +722,14 @@ implements <a href="../../../../../org/a
</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#removeName(org.apache.poi.ss.usermodel.Name)">removeName</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Name.html" title="interface in org.apache.poi.ss.usermodel">Name</a> name)</code>
<div class="block">As <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#removeName(java.lang.String)"><code>removeName(String)</code></a> is not necessarily unique
(name + sheet index is unique), this method is more accurate.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#removeName(java.lang.String)">removeName</a></strong>(java.lang.String name)</code>
<div class="block"><strong>Deprecated.</strong>
@@ -731,13 +737,13 @@ implements <a href="../../../../../org/a
</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#removePrintArea(int)">removePrintArea</a></strong>(int sheetIndex)</code>
<div class="block">Delete the printarea for the sheet specified</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#removeSheetAt(int)">removeSheetAt</a></strong>(int index)</code>
<div class="block">Removes sheet at the given index.<p/>
@@ -746,40 +752,40 @@ implements <a href="../../../../../org/a
the workbook.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setActiveSheet(int)">setActiveSheet</a></strong>(int index)</code>
<div class="block">Convenience method to set the active sheet.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setFirstVisibleTab(int)">setFirstVisibleTab</a></strong>(int index)</code>
<div class="block">Sets the first tab that is displayed in the list of tabs in excel.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setForceFormulaRecalculation(boolean)">setForceFormulaRecalculation</a></strong>(boolean value)</code>
<div class="block">Whether the application shall perform a full recalculation when the workbook is opened.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setHidden(boolean)">setHidden</a></strong>(boolean hiddenFlag)</code> </td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setMissingCellPolicy(org.apache.poi.ss.usermodel.Row.MissingCellPolicy)">setMissingCellPolicy</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Row.MissingCellPolicy.html" title="enum in org.apache.poi.ss.usermodel">Row.MissingCellPolicy</a> missingCellPolicy)</code>
<div class="block">Sets the policy on what to do when
getting missing or blank cells from a row.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setPivotTables(java.util.List)">setPivotTables</a></strong>(java.util.List<<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFPivotTable.html" title="class in org.apache.poi.xssf.usermodel">XSSFPivotTable</a>> pivotTables)</code> </td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setPrintArea(int,%20int,%20int,%20int,%20int)">setPrintArea</a></strong>(int sheetIndex,
int startColumn,
@@ -789,54 +795,61 @@ implements <a href="../../../../../org/a
<div class="block">For the Convenience of Java Programmers maintaining pointers.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setPrintArea(int,%20java.lang.String)">setPrintArea</a></strong>(int sheetIndex,
java.lang.String reference)</code>
<div class="block">Sets the printarea for the sheet provided</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setRevisionsPassword(java.lang.String,%20org.apache.poi.poifs.crypt.HashAlgorithm)">setRevisionsPassword</a></strong>(java.lang.String password,
<a href="../../../../../org/apache/poi/poifs/crypt/HashAlgorithm.html" title="enum in org.apache.poi.poifs.crypt">HashAlgorithm</a> hashAlgo)</code>
<div class="block">Sets the revisions password.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setSelectedTab(int)">setSelectedTab</a></strong>(int index)</code>
<div class="block">We only set one sheet as selected for compatibility with HSSF.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setSheetHidden(int,%20boolean)">setSheetHidden</a></strong>(int sheetIx,
boolean hidden)</code>
-<div class="block">Sets the visible state of this sheet.</div>
+<div class="block">Hide or unhide a sheet.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setSheetHidden(int,%20int)">setSheetHidden</a></strong>(int sheetIx,
int state)</code>
-<div class="block">Hide or unhide a sheet.</div>
+<div class="block"><strong>Deprecated.</strong> </div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setSheetName(int,%20java.lang.String)">setSheetName</a></strong>(int sheetIndex,
java.lang.String sheetname)</code>
<div class="block">Set the sheet name.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setSheetOrder(java.lang.String,%20int)">setSheetOrder</a></strong>(java.lang.String sheetname,
int pos)</code>
<div class="block">sets the order of appearance for a given sheet.</div>
</td>
</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setSheetVisibility(int,%20org.apache.poi.ss.usermodel.SheetVisibility)">setSheetVisibility</a></strong>(int sheetIx,
+ <a href="../../../../../org/apache/poi/ss/usermodel/SheetVisibility.html" title="enum in org.apache.poi.ss.usermodel">SheetVisibility</a> visibility)</code>
+<div class="block">Hide or unhide a sheet.</div>
+</td>
+</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setVBAProject(java.io.InputStream)">setVBAProject</a></strong>(java.io.InputStream vbaProjectStream)</code>
@@ -2290,16 +2303,17 @@ public void setHidden(boolean&
<li class="blockList">
<h4>isSheetHidden</h4>
<pre>public boolean isSheetHidden(int sheetIx)</pre>
+<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#isSheetHidden(int)">Workbook</a></code></strong></div>
<div class="block">Check whether a sheet is hidden.
<p>
Note that a sheet could instead be set to be very hidden, which is different
- (<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#isSheetVeryHidden(int)"><code>isSheetVeryHidden(int)</code></a>)
+ (<a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#isSheetVeryHidden(int)"><code>Workbook.isSheetVeryHidden(int)</code></a>)
</p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#isSheetHidden(int)">isSheetHidden</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>sheetIx</code> - Number</dd>
-<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if sheet is hidden</dd></dl>
+<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if sheet is hidden</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getSheetVisibility(int)"><code>Workbook.getSheetVisibility(int)</code></a></dd></dl>
</li>
</ul>
<a name="isSheetVeryHidden(int)">
@@ -2309,16 +2323,33 @@ public void setHidden(boolean&
<li class="blockList">
<h4>isSheetVeryHidden</h4>
<pre>public boolean isSheetVeryHidden(int sheetIx)</pre>
+<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#isSheetVeryHidden(int)">Workbook</a></code></strong></div>
<div class="block">Check whether a sheet is very hidden.
<p>
This is different from the normal hidden status
- (<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#isSheetHidden(int)"><code>isSheetHidden(int)</code></a>)
+ (<a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#isSheetHidden(int)"><code>Workbook.isSheetHidden(int)</code></a>)
</p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#isSheetVeryHidden(int)">isSheetVeryHidden</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>sheetIx</code> - sheet index to check</dd>
-<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if sheet is very hidden</dd></dl>
+<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if sheet is very hidden</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getSheetVisibility(int)"><code>Workbook.getSheetVisibility(int)</code></a></dd></dl>
+</li>
+</ul>
+<a name="getSheetVisibility(int)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getSheetVisibility</h4>
+<pre>public <a href="../../../../../org/apache/poi/ss/usermodel/SheetVisibility.html" title="enum in org.apache.poi.ss.usermodel">SheetVisibility</a> getSheetVisibility(int sheetIx)</pre>
+<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getSheetVisibility(int)">Workbook</a></code></strong></div>
+<div class="block">Get the visibility (visible, hidden, very hidden) of a sheet in this workbook</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getSheetVisibility(int)">getSheetVisibility</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>sheetIx</code> - the index of the sheet</dd>
+<dt><span class="strong">Returns:</span></dt><dd>the sheet visibility</dd></dl>
</li>
</ul>
<a name="setSheetHidden(int, boolean)">
@@ -2329,21 +2360,15 @@ public void setHidden(boolean&
<h4>setSheetHidden</h4>
<pre>public void setSheetHidden(int sheetIx,
boolean hidden)</pre>
-<div class="block">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>
+<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setSheetHidden(int,%20boolean)">Workbook</a></code></strong></div>
+<div class="block">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.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setSheetHidden(int,%20boolean)">setSheetHidden</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
-<dt><span class="strong">Parameters:</span></dt><dd><code>sheetIx</code> - the 0-based index of the sheet</dd><dd><code>hidden</code> - whether this sheet is hidden</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setSheetHidden(int,%20int)"><code>setSheetHidden(int, int)</code></a></dd></dl>
+<dt><span class="strong">Parameters:</span></dt><dd><code>sheetIx</code> - the sheet index (0-based)</dd><dd><code>hidden</code> - True to mark the sheet as hidden, false otherwise</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setSheetVisibility(int,%20org.apache.poi.ss.usermodel.SheetVisibility)"><code>Workbook.setSheetVisibility(int, SheetVisibility)</code></a></dd></dl>
</li>
</ul>
<a name="setSheetHidden(int, int)">
@@ -2352,8 +2377,12 @@ public void setHidden(boolean&
<ul class="blockList">
<li class="blockList">
<h4>setSheetHidden</h4>
-<pre>public void setSheetHidden(int sheetIx,
- int state)</pre>
+<pre>@Deprecated
+<a href="../../../../../org/apache/poi/util/Removal.html" title="annotation in org.apache.poi.util">@Removal</a>(<a href="../../../../../org/apache/poi/util/Removal.html#version()">version</a>="3.18")
+public void setSheetHidden(int sheetIx,
+ int state)</pre>
+<div class="block"><span class="strong">Deprecated.</span> </div>
+<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setSheetHidden(int,%20int)">Workbook</a></code></strong></div>
<div class="block">Hide or unhide a sheet.
<ul>
@@ -2370,9 +2399,26 @@ public void setHidden(boolean&
<dt><span class="strong">Parameters:</span></dt><dd><code>sheetIx</code> - the sheet index (0-based)</dd><dd><code>state</code> - 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>.</dd>
-<dt><span class="strong">Throws:</span></dt>
-<dd><code>java.lang.IllegalArgumentException</code> - if the supplied sheet index or state is invalid</dd></dl>
+ <code>Workbook.SHEET_STATE_VERY_HIDDEN</code>.</dd></dl>
+</li>
+</ul>
+<a name="setSheetVisibility(int, org.apache.poi.ss.usermodel.SheetVisibility)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setSheetVisibility</h4>
+<pre>public void setSheetVisibility(int sheetIx,
+ <a href="../../../../../org/apache/poi/ss/usermodel/SheetVisibility.html" title="enum in org.apache.poi.ss.usermodel">SheetVisibility</a> visibility)</pre>
+<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setSheetVisibility(int,%20org.apache.poi.ss.usermodel.SheetVisibility)">Workbook</a></code></strong></div>
+<div class="block">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.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setSheetVisibility(int,%20org.apache.poi.ss.usermodel.SheetVisibility)">setSheetVisibility</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>sheetIx</code> - the sheet index (0-based)</dd><dd><code>visibility</code> - the sheet visibility to set</dd></dl>
</li>
</ul>
<a name="onDeleteFormula(org.apache.poi.xssf.usermodel.XSSFCell)">
Modified: poi/site/publish/apidocs/overview-tree.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/overview-tree.html?rev=1779568&r1=1779567&r2=1779568&view=diff
==============================================================================
--- poi/site/publish/apidocs/overview-tree.html (original)
+++ poi/site/publish/apidocs/overview-tree.html Fri Jan 20 05:51:52 2017
@@ -3648,6 +3648,7 @@
<li type="circle">org.apache.poi.sl.usermodel.<a href="org/apache/poi/sl/usermodel/RectAlign.html" title="enum in org.apache.poi.sl.usermodel"><span class="strong">RectAlign</span></a></li>
<li type="circle">org.apache.poi.ss.usermodel.<a href="org/apache/poi/ss/usermodel/Row.MissingCellPolicy.html" title="enum in org.apache.poi.ss.usermodel"><span class="strong">Row.MissingCellPolicy</span></a></li>
<li type="circle">org.apache.poi.sl.usermodel.<a href="org/apache/poi/sl/usermodel/ShapeType.html" title="enum in org.apache.poi.sl.usermodel"><span class="strong">ShapeType</span></a></li>
+<li type="circle">org.apache.poi.ss.usermodel.<a href="org/apache/poi/ss/usermodel/SheetVisibility.html" title="enum in org.apache.poi.ss.usermodel"><span class="strong">SheetVisibility</span></a></li>
<li type="circle">org.apache.poi.xslf.usermodel.<a href="org/apache/poi/xslf/usermodel/SlideLayout.html" title="enum in org.apache.poi.xslf.usermodel"><span class="strong">SlideLayout</span></a></li>
<li type="circle">org.apache.poi.ss.<a href="org/apache/poi/ss/SpreadsheetVersion.html" title="enum in org.apache.poi.ss"><span class="strong">SpreadsheetVersion</span></a></li>
<li type="circle">org.apache.poi.sl.draw.binding.<a href="org/apache/poi/sl/draw/binding/STBlackWhiteMode.html" title="enum in org.apache.poi.sl.draw.binding"><span class="strong">STBlackWhiteMode</span></a></li>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org