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 2016/07/29 14:04:05 UTC
svn commit: r1754531 [2/2] - in /poi/site/publish/apidocs: ./
org/apache/poi/hssf/usermodel/ org/apache/poi/hssf/usermodel/class-use/
org/apache/poi/ss/usermodel/ org/apache/poi/ss/usermodel/class-use/
org/apache/poi/xssf/streaming/ org/apache/poi/xssf...
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=1754531&r1=1754530&r2=1754531&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 Jul 29 14:04:04 2016
@@ -382,244 +382,257 @@ implements <a href="../../../../../org/a
</td>
</tr>
<tr class="rowColor">
+<td class="colFirst"><code>java.util.List<<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFName.html" title="class in org.apache.poi.xssf.usermodel">XSSFName</a>></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getAllNames()">getAllNames</a></strong>()</code>
+<div class="block">Get a list of all the named ranges in the workbook.</div>
+</td>
+</tr>
+<tr class="altColor">
<td class="colFirst"><code>java.util.List<<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFPictureData.html" title="class in org.apache.poi.xssf.usermodel">XSSFPictureData</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getAllPictures()">getAllPictures</a></strong>()</code>
<div class="block">Gets all pictures from the Workbook.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/model/CalculationChain.html" title="class in org.apache.poi.xssf.model">CalculationChain</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getCalculationChain()">getCalculationChain</a></strong>()</code>
<div class="block">Return the <a href="../../../../../org/apache/poi/xssf/model/CalculationChain.html" title="class in org.apache.poi.xssf.model"><code>CalculationChain</code></a> object for this workbook</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFCellStyle.html" title="class in org.apache.poi.xssf.usermodel">XSSFCellStyle</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getCellStyleAt(int)">getCellStyleAt</a></strong>(int idx)</code>
<div class="block">Get the cell style object at the given index</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFCreationHelper.html" title="class in org.apache.poi.xssf.usermodel">XSSFCreationHelper</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getCreationHelper()">getCreationHelper</a></strong>()</code>
<div class="block">Returns an object that handles instantiating concrete
classes of the various instances for XSSF.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>org.openxmlformats.schemas.spreadsheetml.x2006.main.CTWorkbook</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getCTWorkbook()">getCTWorkbook</a></strong>()</code>
<div class="block">Return the underlying XML bean</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>java.util.Collection<<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFMap.html" title="class in org.apache.poi.xssf.usermodel">XSSFMap</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getCustomXMLMappings()">getCustomXMLMappings</a></strong>()</code> </td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>java.util.List<<a href="../../../../../org/apache/poi/xssf/model/ExternalLinksTable.html" title="class in org.apache.poi.xssf.model">ExternalLinksTable</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getExternalLinksTable()">getExternalLinksTable</a></strong>()</code>
<div class="block">Returns the list of <a href="../../../../../org/apache/poi/xssf/model/ExternalLinksTable.html" title="class in org.apache.poi.xssf.model"><code>ExternalLinksTable</code></a> object for this workbook</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getFirstVisibleTab()">getFirstVisibleTab</a></strong>()</code>
<div class="block">Gets the first tab that is displayed in the list of tabs in excel.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFFont.html" title="class in org.apache.poi.xssf.usermodel">XSSFFont</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getFontAt(short)">getFontAt</a></strong>(short idx)</code>
<div class="block">Get the font at the given index number</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#getForceFormulaRecalculation()">getForceFormulaRecalculation</a></strong>()</code>
<div class="block">Whether Excel will be asked to recalculate all formulas when the workbook is opened.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/model/MapInfo.html" title="class in org.apache.poi.xssf.model">MapInfo</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getMapInfo()">getMapInfo</a></strong>()</code> </td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/Row.MissingCellPolicy.html" title="enum in org.apache.poi.ss.usermodel">Row.MissingCellPolicy</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getMissingCellPolicy()">getMissingCellPolicy</a></strong>()</code>
<div class="block">Retrieves the current policy on what to do when
getting missing or blank cells from a row.</div>
</td>
</tr>
-<tr class="rowColor">
-<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFName.html" title="class in org.apache.poi.xssf.usermodel">XSSFName</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getName(java.lang.String)">getName</a></strong>(java.lang.String name)</code> </td>
-</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFName.html" title="class in org.apache.poi.xssf.usermodel">XSSFName</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getNameAt(int)">getNameAt</a></strong>(int nameIndex)</code> </td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getName(java.lang.String)">getName</a></strong>(java.lang.String name)</code>
+<div class="block">Get the first named range with the given name.</div>
+</td>
</tr>
<tr class="rowColor">
+<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFName.html" title="class in org.apache.poi.xssf.usermodel">XSSFName</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getNameAt(int)">getNameAt</a></strong>(int nameIndex)</code>
+<div class="block"><strong>Deprecated.</strong>
+<div class="block"><i>3.16. New projects should avoid accessing named ranges by index.</i></div>
+</div>
+</td>
+</tr>
+<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getNameIndex(java.lang.String)">getNameIndex</a></strong>(java.lang.String name)</code>
-<div class="block">Gets the named range index by his name
- <i>Note:</i>Excel named ranges are case-insensitive and
- this method performs a case-insensitive search.</div>
+<div class="block"><strong>Deprecated.</strong>
+<div class="block"><i>3.16. New projects should avoid accessing named ranges by index.
+ Use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getName(java.lang.String)"><code>getName(String)</code></a> instead.</i></div>
+</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>java.util.List<<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFName.html" title="class in org.apache.poi.xssf.usermodel">XSSFName</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getNames(java.lang.String)">getNames</a></strong>(java.lang.String name)</code>
-<div class="block">Returns all defined names with the given name.</div>
+<div class="block">Get the named ranges with the given name.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getNumberOfFonts()">getNumberOfFonts</a></strong>()</code>
<div class="block">Get the number of fonts in the this workbook</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getNumberOfNames()">getNumberOfNames</a></strong>()</code>
<div class="block">Get the number of named ranges in the this workbook</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#getNumberOfSheets()">getNumberOfSheets</a></strong>()</code>
<div class="block">Get the number of worksheets in the this workbook</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getNumCellStyles()">getNumCellStyles</a></strong>()</code>
<div class="block">Get the number of styles the workbook contains</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>java.util.List<<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFPivotTable.html" title="class in org.apache.poi.xssf.usermodel">XSSFPivotTable</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getPivotTables()">getPivotTables</a></strong>()</code> </td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getPrintArea(int)">getPrintArea</a></strong>(int sheetIndex)</code>
<div class="block">Retrieves the reference for the printarea of the specified sheet, the sheet name is appended to the reference even if it was not specified.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/model/SharedStringsTable.html" title="class in org.apache.poi.xssf.model">SharedStringsTable</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getSharedStringSource()">getSharedStringSource</a></strong>()</code>
<div class="block">Returns SharedStringsTable - tha cache of string for this workbook</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html" title="class in org.apache.poi.xssf.usermodel">XSSFSheet</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getSheet(java.lang.String)">getSheet</a></strong>(java.lang.String name)</code>
<div class="block">Get sheet with the given name (case insensitive match)</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html" title="class in org.apache.poi.xssf.usermodel">XSSFSheet</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getSheetAt(int)">getSheetAt</a></strong>(int index)</code>
<div class="block">Get the XSSFSheet object at the given index.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getSheetIndex(org.apache.poi.ss.usermodel.Sheet)">getSheetIndex</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Sheet.html" title="interface in org.apache.poi.ss.usermodel">Sheet</a> sheet)</code>
<div class="block">Returns the index of the given sheet</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#getSheetIndex(java.lang.String)">getSheetIndex</a></strong>(java.lang.String name)</code>
<div class="block">Returns the index of the sheet by his name (case insensitive match)</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getSheetName(int)">getSheetName</a></strong>(int sheetIx)</code>
<div class="block">Get the sheet name</div>
</td>
</tr>
-<tr class="rowColor">
+<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
@@ -629,7 +642,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>
@@ -637,44 +650,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>
@@ -682,16 +695,27 @@ 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">Remove the defined name at the specified index</div>
+<div class="block"><strong>Deprecated.</strong>
+<div class="block"><i>3.16. New projects should use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#removeName(org.apache.poi.ss.usermodel.Name)"><code>removeName(Name)</code></a>.</i></div>
+</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#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="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">Remove a defined name by name</div>
+<div class="block"><strong>Deprecated.</strong>
+<div class="block"><i>3.16. New projects should use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#removeName(org.apache.poi.ss.usermodel.Name)"><code>removeName(Name)</code></a>.</i></div>
+</div>
</td>
</tr>
<tr class="rowColor">
@@ -1504,11 +1528,15 @@ public <a href="../../../../../org/
<li class="blockList">
<h4>getName</h4>
<pre>public <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFName.html" title="class in org.apache.poi.xssf.usermodel">XSSFName</a> getName(java.lang.String name)</pre>
+<div class="block">Get the first named range with the given name.
+
+ Note: names of named ranges are not unique as they are scoped by sheet.
+ <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getNames(java.lang.String)"><code>getNames(String name)</code></a> returns all named ranges with the given name.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getName(java.lang.String)">getName</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>name</code> - the name of the defined name</dd>
-<dt><span class="strong">Returns:</span></dt><dd>the defined name with the specified name. <code>null</code> if not found.</dd></dl>
+<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - named range name</dd>
+<dt><span class="strong">Returns:</span></dt><dd>XSSFName with the given name. <code>null</code> is returned no named range could be found.</dd></dl>
</li>
</ul>
<a name="getNames(java.lang.String)">
@@ -1518,13 +1546,14 @@ public <a href="../../../../../org/
<li class="blockList">
<h4>getNames</h4>
<pre>public java.util.List<<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFName.html" title="class in org.apache.poi.xssf.usermodel">XSSFName</a>> getNames(java.lang.String name)</pre>
-<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getNames(java.lang.String)">Workbook</a></code></strong></div>
-<div class="block">Returns all defined names with the given name.</div>
+<div class="block">Get the named ranges with the given name.
+ <i>Note:</i>Excel named ranges are case-insensitive and
+ this method performs a case-insensitive search.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getNames(java.lang.String)">getNames</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>name</code> - the name of the defined name</dd>
-<dt><span class="strong">Returns:</span></dt><dd>a list of the defined names with the specified name. An empty list is returned if none is found.</dd></dl>
+<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - named range name</dd>
+<dt><span class="strong">Returns:</span></dt><dd>list of XSSFNames with the given name. An empty list if no named ranges could be found</dd></dl>
</li>
</ul>
<a name="getNameAt(int)">
@@ -1533,12 +1562,29 @@ public <a href="../../../../../org/
<ul class="blockList">
<li class="blockList">
<h4>getNameAt</h4>
-<pre>public <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFName.html" title="class in org.apache.poi.xssf.usermodel">XSSFName</a> getNameAt(int nameIndex)</pre>
+<pre>@Deprecated
+public <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFName.html" title="class in org.apache.poi.xssf.usermodel">XSSFName</a> getNameAt(int nameIndex)</pre>
+<div class="block"><span class="strong">Deprecated.</span> <i>3.16. New projects should avoid accessing named ranges by index.</i></div>
+<div class="block">Get the named range at the given index.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getNameAt(int)">getNameAt</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>nameIndex</code> - position of the named range (0-based)</dd>
-<dt><span class="strong">Returns:</span></dt><dd>the defined name at the specified index</dd></dl>
+<dt><span class="strong">Parameters:</span></dt><dd><code>nameIndex</code> - the index of the named range</dd>
+<dt><span class="strong">Returns:</span></dt><dd>the XSSFName at the given index</dd></dl>
+</li>
+</ul>
+<a name="getAllNames()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getAllNames</h4>
+<pre>public java.util.List<<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFName.html" title="class in org.apache.poi.xssf.usermodel">XSSFName</a>> getAllNames()</pre>
+<div class="block">Get a list of all the named ranges in the workbook.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getAllNames()">getAllNames</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">Returns:</span></dt><dd>list of XSSFNames in the workbook</dd></dl>
</li>
</ul>
<a name="getNameIndex(java.lang.String)">
@@ -1547,15 +1593,16 @@ public <a href="../../../../../org/
<ul class="blockList">
<li class="blockList">
<h4>getNameIndex</h4>
-<pre>public int getNameIndex(java.lang.String name)</pre>
-<div class="block">Gets the named range index by his name
- <i>Note:</i>Excel named ranges are case-insensitive and
- this method performs a case-insensitive search.</div>
+<pre>@Deprecated
+public int getNameIndex(java.lang.String name)</pre>
+<div class="block"><span class="strong">Deprecated.</span> <i>3.16. New projects should avoid accessing named ranges by index.
+ Use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getName(java.lang.String)"><code>getName(String)</code></a> instead.</i></div>
+<div class="block">Gets the named range index by name.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getNameIndex(java.lang.String)">getNameIndex</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>name</code> - named range name</dd>
-<dt><span class="strong">Returns:</span></dt><dd>named range index</dd></dl>
+<dt><span class="strong">Returns:</span></dt><dd>named range index. <code>-1</code> is returned if no named ranges could be found.</dd></dl>
</li>
</ul>
<a name="getNumCellStyles()">
@@ -1835,13 +1882,14 @@ public java.util.Iterator<<a hre
<ul class="blockList">
<li class="blockList">
<h4>removeName</h4>
-<pre>public void removeName(int nameIndex)</pre>
-<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#removeName(int)">Workbook</a></code></strong></div>
-<div class="block">Remove the defined name at the specified index</div>
+<pre>@Deprecated
+public void removeName(int nameIndex)</pre>
+<div class="block"><span class="strong">Deprecated.</span> <i>3.16. New projects should use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#removeName(org.apache.poi.ss.usermodel.Name)"><code>removeName(Name)</code></a>.</i></div>
+<div class="block">Remove the named range at the given index.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#removeName(int)">removeName</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>nameIndex</code> - named range index (0 based)</dd></dl>
+<dt><span class="strong">Parameters:</span></dt><dd><code>nameIndex</code> - the index of the named range name to remove</dd></dl>
</li>
</ul>
<a name="removeName(java.lang.String)">
@@ -1850,13 +1898,37 @@ public java.util.Iterator<<a hre
<ul class="blockList">
<li class="blockList">
<h4>removeName</h4>
-<pre>public void removeName(java.lang.String name)</pre>
-<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#removeName(java.lang.String)">Workbook</a></code></strong></div>
-<div class="block">Remove a defined name by name</div>
+<pre>@Deprecated
+public void removeName(java.lang.String name)</pre>
+<div class="block"><span class="strong">Deprecated.</span> <i>3.16. New projects should use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#removeName(org.apache.poi.ss.usermodel.Name)"><code>removeName(Name)</code></a>.</i></div>
+<div class="block">Remove the first named range found with the given name.
+
+ Note: names of named ranges are not unique (name + sheet
+ index is unique), so <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#removeName(org.apache.poi.ss.usermodel.Name)"><code>removeName(Name)</code></a> should
+ be used if possible.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#removeName(java.lang.String)">removeName</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>name</code> - the name of the defined name</dd></dl>
+<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the named range name to remove</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalArgumentException</code> - if no named range could be found</dd></dl>
+</li>
+</ul>
+<a name="removeName(org.apache.poi.ss.usermodel.Name)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>removeName</h4>
+<pre>public void removeName(<a href="../../../../../org/apache/poi/ss/usermodel/Name.html" title="interface in org.apache.poi.ss.usermodel">Name</a> name)</pre>
+<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>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#removeName(org.apache.poi.ss.usermodel.Name)">removeName</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>name</code> - the name to remove.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalArgumentException</code> - if the named range is not a part of this XSSFWorkbook</dd></dl>
</li>
</ul>
<a name="removePrintArea(int)">
Modified: poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/class-use/XSSFName.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/class-use/XSSFName.html?rev=1754531&r1=1754530&r2=1754531&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/class-use/XSSFName.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/class-use/XSSFName.html Fri Jul 29 14:04:04 2016
@@ -103,11 +103,17 @@
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/poi/xssf/usermodel/XSSFName.html" title="class in org.apache.poi.xssf.usermodel">XSSFName</a></code></td>
-<td class="colLast"><span class="strong">XSSFWorkbook.</span><code><strong><a href="../../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getName(java.lang.String)">getName</a></strong>(java.lang.String name)</code> </td>
+<td class="colLast"><span class="strong">XSSFWorkbook.</span><code><strong><a href="../../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getName(java.lang.String)">getName</a></strong>(java.lang.String name)</code>
+<div class="block">Get the first named range with the given name.</div>
+</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/poi/xssf/usermodel/XSSFName.html" title="class in org.apache.poi.xssf.usermodel">XSSFName</a></code></td>
-<td class="colLast"><span class="strong">XSSFWorkbook.</span><code><strong><a href="../../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getNameAt(int)">getNameAt</a></strong>(int nameIndex)</code> </td>
+<td class="colLast"><span class="strong">XSSFWorkbook.</span><code><strong><a href="../../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getNameAt(int)">getNameAt</a></strong>(int nameIndex)</code>
+<div class="block"><strong>Deprecated.</strong>
+<div class="block"><i>3.16. New projects should avoid accessing named ranges by index.</i></div>
+</div>
+</td>
</tr>
</tbody>
</table>
@@ -120,7 +126,15 @@
<tbody>
<tr class="altColor">
<td class="colFirst"><code>java.util.List<<a href="../../../../../../org/apache/poi/xssf/usermodel/XSSFName.html" title="class in org.apache.poi.xssf.usermodel">XSSFName</a>></code></td>
-<td class="colLast"><span class="strong">XSSFWorkbook.</span><code><strong><a href="../../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getNames(java.lang.String)">getNames</a></strong>(java.lang.String name)</code> </td>
+<td class="colLast"><span class="strong">XSSFWorkbook.</span><code><strong><a href="../../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getAllNames()">getAllNames</a></strong>()</code>
+<div class="block">Get a list of all the named ranges in the workbook.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.util.List<<a href="../../../../../../org/apache/poi/xssf/usermodel/XSSFName.html" title="class in org.apache.poi.xssf.usermodel">XSSFName</a>></code></td>
+<td class="colLast"><span class="strong">XSSFWorkbook.</span><code><strong><a href="../../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getNames(java.lang.String)">getNames</a></strong>(java.lang.String name)</code>
+<div class="block">Get the named ranges with the given name.</div>
+</td>
</tr>
</tbody>
</table>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org