Modified: poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFSheet.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFSheet.html?rev=1623854&r1=1623853&r2=1623854&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFSheet.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFSheet.html Tue Sep 9 15:59:14 2014 @@ -820,134 +820,254 @@ implements <a href="../../../../../org/a <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#lockAutoFilter()">lockAutoFilter</a></strong>()</code> -<div class="block">Enable Autofilters locking.</div> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#lockAutoFilter(boolean)"><code>lockAutoFilter(boolean)</code></a></i></div> +</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/XSSFSheet.html#lockAutoFilter(boolean)">lockAutoFilter</a></strong>(boolean enabled)</code> +<div class="block">Enable or disable Autofilters locking.</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/XSSFSheet.html#lockDeleteColumns()">lockDeleteColumns</a></strong>()</code> -<div class="block">Enable Deleting columns locking.</div> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#lockDeleteColumns(boolean)"><code>lockDeleteColumns(boolean)</code></a></i></div> +</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/XSSFSheet.html#lockDeleteColumns(boolean)">lockDeleteColumns</a></strong>(boolean enabled)</code> +<div class="block">Enable or disable Deleting columns locking.</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/XSSFSheet.html#lockDeleteRows()">lockDeleteRows</a></strong>()</code> -<div class="block">Enable Deleting rows locking.</div> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#lockDeleteRows(boolean)"><code>lockDeleteRows(boolean)</code></a></i></div> +</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/XSSFSheet.html#lockDeleteRows(boolean)">lockDeleteRows</a></strong>(boolean enabled)</code> +<div class="block">Enable or disable Deleting rows locking.</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/XSSFSheet.html#lockFormatCells()">lockFormatCells</a></strong>()</code> -<div class="block">Enable Formatting cells locking.</div> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#lockFormatCells(boolean)"><code>lockFormatCells(boolean)</code></a></i></div> +</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/XSSFSheet.html#lockFormatCells(boolean)">lockFormatCells</a></strong>(boolean enabled)</code> +<div class="block">Enable or disable Formatting cells locking.</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/XSSFSheet.html#lockFormatColumns()">lockFormatColumns</a></strong>()</code> -<div class="block">Enable Formatting columns locking.</div> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#lockFormatColumns(boolean)"><code>lockFormatColumns(boolean)</code></a></i></div> +</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/XSSFSheet.html#lockFormatColumns(boolean)">lockFormatColumns</a></strong>(boolean enabled)</code> +<div class="block">Enable or disable Formatting columns locking.</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/XSSFSheet.html#lockFormatRows()">lockFormatRows</a></strong>()</code> -<div class="block">Enable Formatting rows locking.</div> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#lockFormatRows(boolean)"><code>lockFormatRows(boolean)</code></a></i></div> +</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/XSSFSheet.html#lockFormatRows(boolean)">lockFormatRows</a></strong>(boolean enabled)</code> +<div class="block">Enable or disable Formatting rows locking.</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/XSSFSheet.html#lockInsertColumns()">lockInsertColumns</a></strong>()</code> -<div class="block">Enable Inserting columns locking.</div> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#lockInsertColumns(boolean)"><code>lockInsertColumns(boolean)</code></a></i></div> +</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/XSSFSheet.html#lockInsertColumns(boolean)">lockInsertColumns</a></strong>(boolean enabled)</code> +<div class="block">Enable or disable Inserting columns locking.</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/XSSFSheet.html#lockInsertHyperlinks()">lockInsertHyperlinks</a></strong>()</code> -<div class="block">Enable Inserting hyperlinks locking.</div> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#lockInsertHyperlinks(boolean)"><code>lockInsertHyperlinks(boolean)</code></a></i></div> +</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/XSSFSheet.html#lockInsertHyperlinks(boolean)">lockInsertHyperlinks</a></strong>(boolean enabled)</code> +<div class="block">Enable or disable Inserting hyperlinks locking.</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/XSSFSheet.html#lockInsertRows()">lockInsertRows</a></strong>()</code> -<div class="block">Enable Inserting rows locking.</div> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#lockInsertRows(boolean)"><code>lockInsertRows(boolean)</code></a></i></div> +</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/XSSFSheet.html#lockInsertRows(boolean)">lockInsertRows</a></strong>(boolean enabled)</code> +<div class="block">Enable or disable Inserting rows locking.</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/XSSFSheet.html#lockObjects()">lockObjects</a></strong>()</code> -<div class="block">Enable Objects locking.</div> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#lockObjects(boolean)"><code>lockObjects(boolean)</code></a></i></div> +</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/XSSFSheet.html#lockObjects(boolean)">lockObjects</a></strong>(boolean enabled)</code> +<div class="block">Enable or disable Objects locking.</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/XSSFSheet.html#lockPivotTables()">lockPivotTables</a></strong>()</code> -<div class="block">Enable Pivot Tables locking.</div> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#lockPivotTables(boolean)"><code>lockPivotTables(boolean)</code></a></i></div> +</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/XSSFSheet.html#lockPivotTables(boolean)">lockPivotTables</a></strong>(boolean enabled)</code> +<div class="block">Enable or disable Pivot Tables locking.</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/XSSFSheet.html#lockScenarios()">lockScenarios</a></strong>()</code> -<div class="block">Enable Scenarios locking.</div> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#lockScenarios(boolean)"><code>lockScenarios(boolean)</code></a></i></div> +</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/XSSFSheet.html#lockScenarios(boolean)">lockScenarios</a></strong>(boolean enabled)</code> +<div class="block">Enable or disable Scenarios locking.</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/XSSFSheet.html#lockSelectLockedCells()">lockSelectLockedCells</a></strong>()</code> -<div class="block">Enable Selection of locked cells locking.</div> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#lockSelectLockedCells(boolean)"><code>lockSelectLockedCells(boolean)</code></a></i></div> +</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/XSSFSheet.html#lockSelectLockedCells(boolean)">lockSelectLockedCells</a></strong>(boolean enabled)</code> +<div class="block">Enable or disable Selection of locked cells locking.</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/XSSFSheet.html#lockSelectUnlockedCells()">lockSelectUnlockedCells</a></strong>()</code> -<div class="block">Enable Selection of unlocked cells locking.</div> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#lockSelectUnlockedCells(boolean)"><code>lockSelectUnlockedCells(boolean)</code></a></i></div> +</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/XSSFSheet.html#lockSelectUnlockedCells(boolean)">lockSelectUnlockedCells</a></strong>(boolean enabled)</code> +<div class="block">Enable or disable Selection of unlocked cells locking.</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/XSSFSheet.html#lockSort()">lockSort</a></strong>()</code> -<div class="block">Enable Sort locking.</div> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#lockSort(boolean)"><code>lockSort(boolean)</code></a></i></div> +</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/XSSFSheet.html#lockSort(boolean)">lockSort</a></strong>(boolean enabled)</code> +<div class="block">Enable or disable Sort locking.</div> +</td> +</tr> +<tr class="rowColor"> <td class="colFirst"><code>protected void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#onDocumentCreate()">onDocumentCreate</a></strong>()</code> <div class="block">Initialize worksheet data when creating a new sheet.</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/XSSFSheet.html#onDocumentRead()">onDocumentRead</a></strong>()</code> <div class="block">Initialize worksheet data when reading in an exisiting file.</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/XSSFSheet.html#protectSheet(java.lang.String)">protectSheet</a></strong>(java.lang.String password)</code> <div class="block">Enables sheet protection and sets the password for the sheet.</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/XSSFSheet.html#read(java.io.InputStream)">read</a></strong>(java.io.InputStream is)</code> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/CellRange.html" title="interface in org.apache.poi.ss.usermodel">CellRange</a><<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFCell.html" title="class in org.apache.poi.xssf.usermodel">XSSFCell</a>></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#removeArrayFormula(org.apache.poi.ss.usermodel.Cell)">removeArrayFormula</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> <div class="block">Remove a Array Formula from this 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/XSSFSheet.html#removeColumnBreak(int)">removeColumnBreak</a></strong>(int column)</code> <div class="block">Removes a page break at the indicated column</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/XSSFSheet.html#removeMergedRegion(int)">removeMergedRegion</a></strong>(int index)</code> <div class="block">Removes a merged region of cells (hence letting them free)</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/XSSFSheet.html#removeMergedRegions(java.util.Set)">removeMergedRegions</a></strong>(java.util.Set<java.lang.Integer> indices)</code> <div class="block">Removes a number of merged regions of cells (hence letting them free) @@ -957,50 +1077,50 @@ implements <a href="../../../../../org/a merged region.</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/XSSFSheet.html#removeRow(org.apache.poi.ss.usermodel.Row)">removeRow</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Row.html" title="interface in org.apache.poi.ss.usermodel">Row</a> row)</code> <div class="block">Remove a row from this 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/XSSFSheet.html#removeRowBreak(int)">removeRowBreak</a></strong>(int row)</code> <div class="block">Removes the page break at the indicated row</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>java.util.Iterator<<a href="../../../../../org/apache/poi/ss/usermodel/Row.html" title="interface in org.apache.poi.ss.usermodel">Row</a>></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#rowIterator()">rowIterator</a></strong>()</code> <div class="block">Returns an iterator of the physical rows</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/XSSFSheet.html#setActiveCell(java.lang.String)">setActiveCell</a></strong>(java.lang.String cellRef)</code> <div class="block">Sets location of the active cell</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/CellRange.html" title="interface in org.apache.poi.ss.usermodel">CellRange</a><<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFCell.html" title="class in org.apache.poi.xssf.usermodel">XSSFCell</a>></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#setArrayFormula(java.lang.String,%20org.apache.poi.ss.util.CellRangeAddress)">setArrayFormula</a></strong>(java.lang.String formula, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddress.html" title="class in org.apache.poi.ss.util">CellRangeAddress</a> range)</code> <div class="block">Sets array formula to specified region for result.</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/XSSFSheet.html#setAutobreaks(boolean)">setAutobreaks</a></strong>(boolean value)</code> <div class="block">Flag indicating whether the sheet displays Automatic Page Breaks.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFAutoFilter.html" title="class in org.apache.poi.xssf.usermodel">XSSFAutoFilter</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#setAutoFilter(org.apache.poi.ss.util.CellRangeAddress)">setAutoFilter</a></strong>(<a href="../../../../../org/apache/poi/ss/util/CellRangeAddress.html" title="class in org.apache.poi.ss.util">CellRangeAddress</a> range)</code> <div class="block">Enable filtering for a range of cells</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>static void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#setCellComment(java.lang.String,%20org.apache.poi.xssf.usermodel.XSSFComment)">setCellComment</a></strong>(java.lang.String cellRef, <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFComment.html" title="class in org.apache.poi.xssf.usermodel">XSSFComment</a> comment)</code> @@ -1009,150 +1129,150 @@ 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/XSSFSheet.html#setColumnBreak(int)">setColumnBreak</a></strong>(int column)</code> <div class="block">Sets a page break at the indicated column.</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/XSSFSheet.html#setColumnGroupCollapsed(int,%20boolean)">setColumnGroupCollapsed</a></strong>(int columnNumber, boolean collapsed)</code> <div class="block">Expands or collapses a column group.</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/XSSFSheet.html#setColumnHidden(int,%20boolean)">setColumnHidden</a></strong>(int columnIndex, boolean hidden)</code> <div class="block">Get the visibility state for a given column.</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/XSSFSheet.html#setColumnWidth(int,%20int)">setColumnWidth</a></strong>(int columnIndex, int width)</code> <div class="block">Set the width (in units of 1/256th of a character width)</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/XSSFSheet.html#setDefaultColumnStyle(int,%20org.apache.poi.ss.usermodel.CellStyle)">setDefaultColumnStyle</a></strong>(int column, <a href="../../../../../org/apache/poi/ss/usermodel/CellStyle.html" title="interface in org.apache.poi.ss.usermodel">CellStyle</a> style)</code> <div class="block">Sets the default column style for a given column.</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/XSSFSheet.html#setDefaultColumnWidth(int)">setDefaultColumnWidth</a></strong>(int width)</code> <div class="block">Specifies the number of characters of the maximum digit width of the normal style's font.</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/XSSFSheet.html#setDefaultRowHeight(short)">setDefaultRowHeight</a></strong>(short height)</code> <div class="block">Set the default row height for the sheet (if the rows do not define their own height) in twips (1/20 of a point)</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/XSSFSheet.html#setDefaultRowHeightInPoints(float)">setDefaultRowHeightInPoints</a></strong>(float height)</code> <div class="block">Sets default row height measured in point size.</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/XSSFSheet.html#setDisplayFormulas(boolean)">setDisplayFormulas</a></strong>(boolean show)</code> <div class="block">Sets the flag indicating whether this sheet should display formulas.</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/XSSFSheet.html#setDisplayGridlines(boolean)">setDisplayGridlines</a></strong>(boolean show)</code> <div class="block">Sets the flag indicating whether this sheet should display the lines between rows and columns to make editing and reading easier.</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/XSSFSheet.html#setDisplayGuts(boolean)">setDisplayGuts</a></strong>(boolean value)</code> <div class="block">Set whether to display the guts or not</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/XSSFSheet.html#setDisplayRowColHeadings(boolean)">setDisplayRowColHeadings</a></strong>(boolean show)</code> <div class="block">Sets the flag indicating whether this sheet should display row and column headings.</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/XSSFSheet.html#setDisplayZeros(boolean)">setDisplayZeros</a></strong>(boolean value)</code> <div class="block">Set whether the window should show 0 (zero) in cells containing zero value.</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/XSSFSheet.html#setFitToPage(boolean)">setFitToPage</a></strong>(boolean b)</code> <div class="block">Flag indicating whether the Fit to Page print option is enabled.</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/XSSFSheet.html#setForceFormulaRecalculation(boolean)">setForceFormulaRecalculation</a></strong>(boolean value)</code> <div class="block">Control if Excel should be asked to recalculate all formulas on this sheet 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/XSSFSheet.html#setHorizontallyCenter(boolean)">setHorizontallyCenter</a></strong>(boolean value)</code> <div class="block">Center on page horizontally when printing.</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/XSSFSheet.html#setMargin(short,%20double)">setMargin</a></strong>(short margin, double size)</code> <div class="block">Sets the size of the margin in inches.</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/XSSFSheet.html#setPrintGridlines(boolean)">setPrintGridlines</a></strong>(boolean value)</code> <div class="block">Turns on or off the printing of gridlines.</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/XSSFSheet.html#setRepeatingColumns(org.apache.poi.ss.util.CellRangeAddress)">setRepeatingColumns</a></strong>(<a href="../../../../../org/apache/poi/ss/util/CellRangeAddress.html" title="class in org.apache.poi.ss.util">CellRangeAddress</a> columnRangeRef)</code> <div class="block">Sets the repeating columns used when printing the sheet, as found in File->PageSetup->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/XSSFSheet.html#setRepeatingRows(org.apache.poi.ss.util.CellRangeAddress)">setRepeatingRows</a></strong>(<a href="../../../../../org/apache/poi/ss/util/CellRangeAddress.html" title="class in org.apache.poi.ss.util">CellRangeAddress</a> rowRangeRef)</code> <div class="block">Sets the repeating rows used when printing the sheet, as found in File->PageSetup->Sheet.</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/XSSFSheet.html#setRightToLeft(boolean)">setRightToLeft</a></strong>(boolean value)</code> <div class="block">Sets whether the worksheet is displayed from right to left instead of from left to right.</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/XSSFSheet.html#setRowBreak(int)">setRowBreak</a></strong>(int row)</code> <div class="block">Sets a page break at the indicated row Breaks occur above the specified row and left of the specified column inclusive.</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/XSSFSheet.html#setRowGroupCollapsed(int,%20boolean)">setRowGroupCollapsed</a></strong>(int rowIndex, boolean collapse)</code> @@ -1160,24 +1280,31 @@ implements <a href="../../../../../org/a the rows in question hidden.</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/XSSFSheet.html#setRowSumsBelow(boolean)">setRowSumsBelow</a></strong>(boolean value)</code> <div class="block">Flag indicating whether summary rows appear below detail in an outline, when applying an outline.</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/XSSFSheet.html#setRowSumsRight(boolean)">setRowSumsRight</a></strong>(boolean value)</code> <div class="block">Flag indicating whether summary columns appear to the right of detail in an outline, when applying an outline.</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/XSSFSheet.html#setSelected(boolean)">setSelected</a></strong>(boolean value)</code> <div class="block">Sets a flag indicating whether this sheet is selected.</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/XSSFSheet.html#setSheetPassword(java.lang.String,%20org.apache.poi.poifs.crypt.HashAlgorithm)">setSheetPassword</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 sheet password.</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/XSSFSheet.html#setTabColor(int)">setTabColor</a></strong>(int colorIndex)</code> @@ -1253,6 +1380,13 @@ implements <a href="../../../../../org/a </td> </tr> <tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#validateSheetPassword(java.lang.String)">validateSheetPassword</a></strong>(java.lang.String password)</code> +<div class="block">Validate the password against the stored hash, the hashing method will be determined + by the existing password attributes</div> +</td> +</tr> +<tr class="rowColor"> <td class="colFirst"><code>protected void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#write(java.io.OutputStream)">write</a></strong>(java.io.OutputStream out)</code> </td> </tr> @@ -2163,6 +2297,31 @@ public <a href="../../../../../org/ <dt><span class="strong">Parameters:</span></dt><dd><code>password</code> - to set for protection. Pass <code>null</code> to remove protection</dd></dl> </li> </ul> +<a name="setSheetPassword(java.lang.String, org.apache.poi.poifs.crypt.HashAlgorithm)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSheetPassword</h4> +<pre>public void setSheetPassword(java.lang.String password, + <a href="../../../../../org/apache/poi/poifs/crypt/HashAlgorithm.html" title="enum in org.apache.poi.poifs.crypt">HashAlgorithm</a> hashAlgo)</pre> +<div class="block">Sets the sheet password.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>password</code> - if null, the password will be removed</dd><dd><code>hashAlgo</code> - if null, the password will be set as XOR password (Excel 2010 and earlier) + otherwise the given algorithm is used for calculating the hash password (Excel 2013)</dd></dl> +</li> +</ul> +<a name="validateSheetPassword(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>validateSheetPassword</h4> +<pre>public boolean validateSheetPassword(java.lang.String password)</pre> +<div class="block">Validate the password against the stored hash, the hashing method will be determined + by the existing password attributes</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true, if the hashes match (... though original password may differ ...)</dd></dl> +</li> +</ul> <a name="getRow(int)"> <!-- --> </a> @@ -3483,9 +3642,20 @@ public org.openxmlformats.schemas.s <li class="blockList"> <h4>lockAutoFilter</h4> <pre>public void lockAutoFilter()</pre> -<div class="block">Enable Autofilters locking. +<div class="block"><span class="strong">Deprecated.</span> <i>use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#lockAutoFilter(boolean)"><code>lockAutoFilter(boolean)</code></a></i></div> +<div class="block">Enable Autofilters locking.</div> +</li> +</ul> +<a name="lockAutoFilter(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>lockAutoFilter</h4> +<pre>public void lockAutoFilter(boolean enabled)</pre> +<div class="block">Enable or disable Autofilters locking. This does not modify sheet protection status. - To enforce this locking, call <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#enableLocking()"><code>enableLocking()</code></a></div> + To enforce this un-/locking, call <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#disableLocking()"><code>disableLocking()</code></a> or <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#enableLocking()"><code>enableLocking()</code></a></div> </li> </ul> <a name="lockDeleteColumns()"> @@ -3495,9 +3665,20 @@ public org.openxmlformats.schemas.s <li class="blockList"> <h4>lockDeleteColumns</h4> <pre>public void lockDeleteColumns()</pre> -<div class="block">Enable Deleting columns locking. +<div class="block"><span class="strong">Deprecated.</span> <i>use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#lockDeleteColumns(boolean)"><code>lockDeleteColumns(boolean)</code></a></i></div> +<div class="block">Enable Deleting columns locking.</div> +</li> +</ul> +<a name="lockDeleteColumns(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>lockDeleteColumns</h4> +<pre>public void lockDeleteColumns(boolean enabled)</pre> +<div class="block">Enable or disable Deleting columns locking. This does not modify sheet protection status. - To enforce this locking, call <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#enableLocking()"><code>enableLocking()</code></a></div> + To enforce this un-/locking, call <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#disableLocking()"><code>disableLocking()</code></a> or <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#enableLocking()"><code>enableLocking()</code></a></div> </li> </ul> <a name="lockDeleteRows()"> @@ -3507,9 +3688,20 @@ public org.openxmlformats.schemas.s <li class="blockList"> <h4>lockDeleteRows</h4> <pre>public void lockDeleteRows()</pre> -<div class="block">Enable Deleting rows locking. +<div class="block"><span class="strong">Deprecated.</span> <i>use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#lockDeleteRows(boolean)"><code>lockDeleteRows(boolean)</code></a></i></div> +<div class="block">Enable Deleting rows locking.</div> +</li> +</ul> +<a name="lockDeleteRows(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>lockDeleteRows</h4> +<pre>public void lockDeleteRows(boolean enabled)</pre> +<div class="block">Enable or disable Deleting rows locking. This does not modify sheet protection status. - To enforce this locking, call <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#enableLocking()"><code>enableLocking()</code></a></div> + To enforce this un-/locking, call <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#disableLocking()"><code>disableLocking()</code></a> or <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#enableLocking()"><code>enableLocking()</code></a></div> </li> </ul> <a name="lockFormatCells()"> @@ -3519,9 +3711,20 @@ public org.openxmlformats.schemas.s <li class="blockList"> <h4>lockFormatCells</h4> <pre>public void lockFormatCells()</pre> -<div class="block">Enable Formatting cells locking. +<div class="block"><span class="strong">Deprecated.</span> <i>use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#lockFormatCells(boolean)"><code>lockFormatCells(boolean)</code></a></i></div> +<div class="block">Enable Formatting cells locking.</div> +</li> +</ul> +<a name="lockFormatCells(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>lockFormatCells</h4> +<pre>public void lockFormatCells(boolean enabled)</pre> +<div class="block">Enable or disable Formatting cells locking. This does not modify sheet protection status. - To enforce this locking, call <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#enableLocking()"><code>enableLocking()</code></a></div> + To enforce this un-/locking, call <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#disableLocking()"><code>disableLocking()</code></a> or <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#enableLocking()"><code>enableLocking()</code></a></div> </li> </ul> <a name="lockFormatColumns()"> @@ -3531,9 +3734,20 @@ public org.openxmlformats.schemas.s <li class="blockList"> <h4>lockFormatColumns</h4> <pre>public void lockFormatColumns()</pre> -<div class="block">Enable Formatting columns locking. +<div class="block"><span class="strong">Deprecated.</span> <i>use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#lockFormatColumns(boolean)"><code>lockFormatColumns(boolean)</code></a></i></div> +<div class="block">Enable Formatting columns locking.</div> +</li> +</ul> +<a name="lockFormatColumns(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>lockFormatColumns</h4> +<pre>public void lockFormatColumns(boolean enabled)</pre> +<div class="block">Enable or disable Formatting columns locking. This does not modify sheet protection status. - To enforce this locking, call <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#enableLocking()"><code>enableLocking()</code></a></div> + To enforce this un-/locking, call <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#disableLocking()"><code>disableLocking()</code></a> or <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#enableLocking()"><code>enableLocking()</code></a></div> </li> </ul> <a name="lockFormatRows()"> @@ -3543,9 +3757,20 @@ public org.openxmlformats.schemas.s <li class="blockList"> <h4>lockFormatRows</h4> <pre>public void lockFormatRows()</pre> -<div class="block">Enable Formatting rows locking. +<div class="block"><span class="strong">Deprecated.</span> <i>use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#lockFormatRows(boolean)"><code>lockFormatRows(boolean)</code></a></i></div> +<div class="block">Enable Formatting rows locking.</div> +</li> +</ul> +<a name="lockFormatRows(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>lockFormatRows</h4> +<pre>public void lockFormatRows(boolean enabled)</pre> +<div class="block">Enable or disable Formatting rows locking. This does not modify sheet protection status. - To enforce this locking, call <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#enableLocking()"><code>enableLocking()</code></a></div> + To enforce this un-/locking, call <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#disableLocking()"><code>disableLocking()</code></a> or <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#enableLocking()"><code>enableLocking()</code></a></div> </li> </ul> <a name="lockInsertColumns()"> @@ -3555,9 +3780,20 @@ public org.openxmlformats.schemas.s <li class="blockList"> <h4>lockInsertColumns</h4> <pre>public void lockInsertColumns()</pre> -<div class="block">Enable Inserting columns locking. +<div class="block"><span class="strong">Deprecated.</span> <i>use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#lockInsertColumns(boolean)"><code>lockInsertColumns(boolean)</code></a></i></div> +<div class="block">Enable Inserting columns locking.</div> +</li> +</ul> +<a name="lockInsertColumns(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>lockInsertColumns</h4> +<pre>public void lockInsertColumns(boolean enabled)</pre> +<div class="block">Enable or disable Inserting columns locking. This does not modify sheet protection status. - To enforce this locking, call <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#enableLocking()"><code>enableLocking()</code></a></div> + To enforce this un-/locking, call <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#disableLocking()"><code>disableLocking()</code></a> or <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#enableLocking()"><code>enableLocking()</code></a></div> </li> </ul> <a name="lockInsertHyperlinks()"> @@ -3567,9 +3803,20 @@ public org.openxmlformats.schemas.s <li class="blockList"> <h4>lockInsertHyperlinks</h4> <pre>public void lockInsertHyperlinks()</pre> -<div class="block">Enable Inserting hyperlinks locking. +<div class="block"><span class="strong">Deprecated.</span> <i>use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#lockInsertHyperlinks(boolean)"><code>lockInsertHyperlinks(boolean)</code></a></i></div> +<div class="block">Enable Inserting hyperlinks locking.</div> +</li> +</ul> +<a name="lockInsertHyperlinks(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>lockInsertHyperlinks</h4> +<pre>public void lockInsertHyperlinks(boolean enabled)</pre> +<div class="block">Enable or disable Inserting hyperlinks locking. This does not modify sheet protection status. - To enforce this locking, call <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#enableLocking()"><code>enableLocking()</code></a></div> + To enforce this un-/locking, call <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#disableLocking()"><code>disableLocking()</code></a> or <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#enableLocking()"><code>enableLocking()</code></a></div> </li> </ul> <a name="lockInsertRows()"> @@ -3579,9 +3826,20 @@ public org.openxmlformats.schemas.s <li class="blockList"> <h4>lockInsertRows</h4> <pre>public void lockInsertRows()</pre> -<div class="block">Enable Inserting rows locking. +<div class="block"><span class="strong">Deprecated.</span> <i>use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#lockInsertRows(boolean)"><code>lockInsertRows(boolean)</code></a></i></div> +<div class="block">Enable Inserting rows locking.</div> +</li> +</ul> +<a name="lockInsertRows(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>lockInsertRows</h4> +<pre>public void lockInsertRows(boolean enabled)</pre> +<div class="block">Enable or disable Inserting rows locking. This does not modify sheet protection status. - To enforce this locking, call <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#enableLocking()"><code>enableLocking()</code></a></div> + To enforce this un-/locking, call <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#disableLocking()"><code>disableLocking()</code></a> or <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#enableLocking()"><code>enableLocking()</code></a></div> </li> </ul> <a name="lockPivotTables()"> @@ -3591,9 +3849,20 @@ public org.openxmlformats.schemas.s <li class="blockList"> <h4>lockPivotTables</h4> <pre>public void lockPivotTables()</pre> -<div class="block">Enable Pivot Tables locking. +<div class="block"><span class="strong">Deprecated.</span> <i>use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#lockPivotTables(boolean)"><code>lockPivotTables(boolean)</code></a></i></div> +<div class="block">Enable Pivot Tables locking.</div> +</li> +</ul> +<a name="lockPivotTables(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>lockPivotTables</h4> +<pre>public void lockPivotTables(boolean enabled)</pre> +<div class="block">Enable or disable Pivot Tables locking. This does not modify sheet protection status. - To enforce this locking, call <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#enableLocking()"><code>enableLocking()</code></a></div> + To enforce this un-/locking, call <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#disableLocking()"><code>disableLocking()</code></a> or <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#enableLocking()"><code>enableLocking()</code></a></div> </li> </ul> <a name="lockSort()"> @@ -3603,9 +3872,20 @@ public org.openxmlformats.schemas.s <li class="blockList"> <h4>lockSort</h4> <pre>public void lockSort()</pre> -<div class="block">Enable Sort locking. +<div class="block"><span class="strong">Deprecated.</span> <i>use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#lockSort(boolean)"><code>lockSort(boolean)</code></a></i></div> +<div class="block">Enable Sort locking.</div> +</li> +</ul> +<a name="lockSort(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>lockSort</h4> +<pre>public void lockSort(boolean enabled)</pre> +<div class="block">Enable or disable Sort locking. This does not modify sheet protection status. - To enforce this locking, call <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#enableLocking()"><code>enableLocking()</code></a></div> + To enforce this un-/locking, call <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#disableLocking()"><code>disableLocking()</code></a> or <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#enableLocking()"><code>enableLocking()</code></a></div> </li> </ul> <a name="lockObjects()"> @@ -3615,9 +3895,20 @@ public org.openxmlformats.schemas.s <li class="blockList"> <h4>lockObjects</h4> <pre>public void lockObjects()</pre> -<div class="block">Enable Objects locking. +<div class="block"><span class="strong">Deprecated.</span> <i>use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#lockObjects(boolean)"><code>lockObjects(boolean)</code></a></i></div> +<div class="block">Enable Objects locking.</div> +</li> +</ul> +<a name="lockObjects(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>lockObjects</h4> +<pre>public void lockObjects(boolean enabled)</pre> +<div class="block">Enable or disable Objects locking. This does not modify sheet protection status. - To enforce this locking, call <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#enableLocking()"><code>enableLocking()</code></a></div> + To enforce this un-/locking, call <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#disableLocking()"><code>disableLocking()</code></a> or <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#enableLocking()"><code>enableLocking()</code></a></div> </li> </ul> <a name="lockScenarios()"> @@ -3627,9 +3918,20 @@ public org.openxmlformats.schemas.s <li class="blockList"> <h4>lockScenarios</h4> <pre>public void lockScenarios()</pre> -<div class="block">Enable Scenarios locking. +<div class="block"><span class="strong">Deprecated.</span> <i>use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#lockScenarios(boolean)"><code>lockScenarios(boolean)</code></a></i></div> +<div class="block">Enable Scenarios locking.</div> +</li> +</ul> +<a name="lockScenarios(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>lockScenarios</h4> +<pre>public void lockScenarios(boolean enabled)</pre> +<div class="block">Enable or disable Scenarios locking. This does not modify sheet protection status. - To enforce this locking, call <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#enableLocking()"><code>enableLocking()</code></a></div> + To enforce this un-/locking, call <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#disableLocking()"><code>disableLocking()</code></a> or <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#enableLocking()"><code>enableLocking()</code></a></div> </li> </ul> <a name="lockSelectLockedCells()"> @@ -3639,9 +3941,20 @@ public org.openxmlformats.schemas.s <li class="blockList"> <h4>lockSelectLockedCells</h4> <pre>public void lockSelectLockedCells()</pre> -<div class="block">Enable Selection of locked cells locking. +<div class="block"><span class="strong">Deprecated.</span> <i>use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#lockSelectLockedCells(boolean)"><code>lockSelectLockedCells(boolean)</code></a></i></div> +<div class="block">Enable Selection of locked cells locking.</div> +</li> +</ul> +<a name="lockSelectLockedCells(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>lockSelectLockedCells</h4> +<pre>public void lockSelectLockedCells(boolean enabled)</pre> +<div class="block">Enable or disable Selection of locked cells locking. This does not modify sheet protection status. - To enforce this locking, call <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#enableLocking()"><code>enableLocking()</code></a></div> + To enforce this un-/locking, call <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#disableLocking()"><code>disableLocking()</code></a> or <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#enableLocking()"><code>enableLocking()</code></a></div> </li> </ul> <a name="lockSelectUnlockedCells()"> @@ -3651,9 +3964,20 @@ public org.openxmlformats.schemas.s <li class="blockList"> <h4>lockSelectUnlockedCells</h4> <pre>public void lockSelectUnlockedCells()</pre> -<div class="block">Enable Selection of unlocked cells locking. +<div class="block"><span class="strong">Deprecated.</span> <i>use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#lockSelectUnlockedCells(boolean)"><code>lockSelectUnlockedCells(boolean)</code></a></i></div> +<div class="block">Enable Selection of unlocked cells locking.</div> +</li> +</ul> +<a name="lockSelectUnlockedCells(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>lockSelectUnlockedCells</h4> +<pre>public void lockSelectUnlockedCells(boolean enabled)</pre> +<div class="block">Enable or disable Selection of unlocked cells locking. This does not modify sheet protection status. - To enforce this locking, call <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#enableLocking()"><code>enableLocking()</code></a></div> + To enforce this un-/locking, call <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#disableLocking()"><code>disableLocking()</code></a> or <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#enableLocking()"><code>enableLocking()</code></a></div> </li> </ul> <a name="setArrayFormula(java.lang.String, org.apache.poi.ss.util.CellRangeAddress)">
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=1623854&r1=1623853&r2=1623854&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 Tue Sep 9 15:59:14 2014 @@ -704,56 +704,90 @@ implements <a href="../../../../../org/a </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#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="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> </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> </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#setWorkbookPassword(java.lang.String,%20org.apache.poi.poifs.crypt.HashAlgorithm)">setWorkbookPassword</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 workbook password.</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#unLock()">unLock</a></strong>()</code> +<div class="block">Removes the workbook protection settings</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#unLockRevision()">unLockRevision</a></strong>()</code> <div class="block">Unlocks 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#unLockStructure()">unLockStructure</a></strong>()</code> <div class="block">Unlocks 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#unLockWindows()">unLockWindows</a></strong>()</code> <div class="block">Unlocks the windows that comprise the workbook.</div> </td> </tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#validateRevisionsPassword(java.lang.String)">validateRevisionsPassword</a></strong>(java.lang.String password)</code> +<div class="block">Validate the password against the stored hash, the hashing method will be determined + by the existing password attributes</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#validateWorkbookPassword(java.lang.String)">validateWorkbookPassword</a></strong>(java.lang.String password)</code> +<div class="block">Validate the password against the stored hash, the hashing method will be determined + by the existing password attributes</div> +</td> +</tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.POIXMLDocument"> @@ -2207,6 +2241,66 @@ public <a href="../../../../../org/ <div class="block">Unlocks the workbook for revisions.</div> </li> </ul> +<a name="setWorkbookPassword(java.lang.String, org.apache.poi.poifs.crypt.HashAlgorithm)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setWorkbookPassword</h4> +<pre>public void setWorkbookPassword(java.lang.String password, + <a href="../../../../../org/apache/poi/poifs/crypt/HashAlgorithm.html" title="enum in org.apache.poi.poifs.crypt">HashAlgorithm</a> hashAlgo)</pre> +<div class="block">Sets the workbook password.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>password</code> - if null, the password will be removed</dd><dd><code>hashAlgo</code> - if null, the password will be set as XOR password (Excel 2010 and earlier) + otherwise the given algorithm is used for calculating the hash password (Excel 2013)</dd></dl> +</li> +</ul> +<a name="validateWorkbookPassword(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>validateWorkbookPassword</h4> +<pre>public boolean validateWorkbookPassword(java.lang.String password)</pre> +<div class="block">Validate the password against the stored hash, the hashing method will be determined + by the existing password attributes</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true, if the hashes match (... though original password may differ ...)</dd></dl> +</li> +</ul> +<a name="setRevisionsPassword(java.lang.String, org.apache.poi.poifs.crypt.HashAlgorithm)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRevisionsPassword</h4> +<pre>public void setRevisionsPassword(java.lang.String password, + <a href="../../../../../org/apache/poi/poifs/crypt/HashAlgorithm.html" title="enum in org.apache.poi.poifs.crypt">HashAlgorithm</a> hashAlgo)</pre> +<div class="block">Sets the revisions password.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>password</code> - if null, the password will be removed</dd><dd><code>hashAlgo</code> - if null, the password will be set as XOR password (Excel 2010 and earlier) + otherwise the given algorithm is used for calculating the hash password (Excel 2013)</dd></dl> +</li> +</ul> +<a name="validateRevisionsPassword(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>validateRevisionsPassword</h4> +<pre>public boolean validateRevisionsPassword(java.lang.String password)</pre> +<div class="block">Validate the password against the stored hash, the hashing method will be determined + by the existing password attributes</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if the hashes match (... though original password may differ ...)</dd></dl> +</li> +</ul> +<a name="unLock()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>unLock</h4> +<pre>public void unLock()</pre> +<div class="block">Removes the workbook protection settings</div> +</li> +</ul> <a name="addToolPack(org.apache.poi.ss.formula.udf.UDFFinder)"> <!-- --> </a> Modified: poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/helpers/XSSFFormulaUtils.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/helpers/XSSFFormulaUtils.html?rev=1623854&r1=1623853&r2=1623854&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/helpers/XSSFFormulaUtils.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/helpers/XSSFFormulaUtils.html Tue Sep 9 15:59:14 2014 @@ -35,7 +35,7 @@ <div class="subNav"> <ul class="navList"> <li><a href="../../../../../../org/apache/poi/xssf/usermodel/helpers/HeaderFooterHelper.html" title="class in org.apache.poi.xssf.usermodel.helpers"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../../../org/apache/poi/xssf/usermodel/helpers/XSSFRowShifter.html" title="class in org.apache.poi.xssf.usermodel.helpers"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../../../org/apache/poi/xssf/usermodel/helpers/XSSFPaswordHelper.html" title="class in org.apache.poi.xssf.usermodel.helpers"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../../index.html?org/apache/poi/xssf/usermodel/helpers/XSSFFormulaUtils.html" target="_top">Frames</a></li> @@ -228,7 +228,7 @@ extends java.lang.Object</pre> <div class="subNav"> <ul class="navList"> <li><a href="../../../../../../org/apache/poi/xssf/usermodel/helpers/HeaderFooterHelper.html" title="class in org.apache.poi.xssf.usermodel.helpers"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../../../org/apache/poi/xssf/usermodel/helpers/XSSFRowShifter.html" title="class in org.apache.poi.xssf.usermodel.helpers"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../../../org/apache/poi/xssf/usermodel/helpers/XSSFPaswordHelper.html" title="class in org.apache.poi.xssf.usermodel.helpers"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../../index.html?org/apache/poi/xssf/usermodel/helpers/XSSFFormulaUtils.html" target="_top">Frames</a></li> Added: poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/helpers/XSSFPaswordHelper.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/helpers/XSSFPaswordHelper.html?rev=1623854&view=auto ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/helpers/XSSFPaswordHelper.html (added) +++ poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/helpers/XSSFPaswordHelper.html Tue Sep 9 15:59:14 2014 @@ -0,0 +1,292 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<title>XSSFPaswordHelper (POI API Documentation)</title> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="XSSFPaswordHelper (POI API Documentation)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/XSSFPaswordHelper.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/poi/xssf/usermodel/helpers/XSSFFormulaUtils.html" title="class in org.apache.poi.xssf.usermodel.helpers"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/poi/xssf/usermodel/helpers/XSSFRowShifter.html" title="class in org.apache.poi.xssf.usermodel.helpers"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/poi/xssf/usermodel/helpers/XSSFPaswordHelper.html" target="_top">Frames</a></li> +<li><a href="XSSFPaswordHelper.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.poi.xssf.usermodel.helpers</div> +<h2 title="Class XSSFPaswordHelper" class="title">Class XSSFPaswordHelper</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.poi.xssf.usermodel.helpers.XSSFPaswordHelper</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">XSSFPaswordHelper</span> +extends java.lang.Object</pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../../org/apache/poi/xssf/usermodel/helpers/XSSFPaswordHelper.html#XSSFPaswordHelper()">XSSFPaswordHelper</a></strong>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/xssf/usermodel/helpers/XSSFPaswordHelper.html#setPassword(org.apache.xmlbeans.XmlObject,%20java.lang.String,%20org.apache.poi.poifs.crypt.HashAlgorithm,%20java.lang.String)">setPassword</a></strong>(org.apache.xmlbeans.XmlObject xobj, + java.lang.String password, + <a href="../../../../../../org/apache/poi/poifs/crypt/HashAlgorithm.html" title="enum in org.apache.poi.poifs.crypt">HashAlgorithm</a> hashAlgo, + java.lang.String prefix)</code> +<div class="block">Sets the XORed or hashed password</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/xssf/usermodel/helpers/XSSFPaswordHelper.html#validatePassword(org.apache.xmlbeans.XmlObject,%20java.lang.String,%20java.lang.String)">validatePassword</a></strong>(org.apache.xmlbeans.XmlObject xobj, + java.lang.String password, + java.lang.String prefix)</code> +<div class="block">Validates the password, i.e.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="XSSFPaswordHelper()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>XSSFPaswordHelper</h4> +<pre>public XSSFPaswordHelper()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="setPassword(org.apache.xmlbeans.XmlObject, java.lang.String, org.apache.poi.poifs.crypt.HashAlgorithm, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPassword</h4> +<pre>public static void setPassword(org.apache.xmlbeans.XmlObject xobj, + java.lang.String password, + <a href="../../../../../../org/apache/poi/poifs/crypt/HashAlgorithm.html" title="enum in org.apache.poi.poifs.crypt">HashAlgorithm</a> hashAlgo, + java.lang.String prefix)</pre> +<div class="block">Sets the XORed or hashed password</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xobj</code> - the xmlbeans object which contains the password attributes</dd><dd><code>password</code> - the password, if null, the password attributes will be removed</dd><dd><code>hashAlgo</code> - the hash algorithm, if null the password will be XORed</dd><dd><code>prefix</code> - the prefix of the password attributes, may be null</dd></dl> +</li> +</ul> +<a name="validatePassword(org.apache.xmlbeans.XmlObject, java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>validatePassword</h4> +<pre>public static boolean validatePassword(org.apache.xmlbeans.XmlObject xobj, + java.lang.String password, + java.lang.String prefix)</pre> +<div class="block">Validates the password, i.e. + calculates the hash of the given password and compares it against the stored hash</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xobj</code> - the xmlbeans object which contains the password attributes</dd><dd><code>password</code> - the password, if null the method will always return false, + even if there's no password set</dd><dd><code>prefix</code> - the prefix of the password attributes, may be null</dd> +<dt><span class="strong">Returns:</span></dt><dd>true, if the hashes match</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/XSSFPaswordHelper.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/poi/xssf/usermodel/helpers/XSSFFormulaUtils.html" title="class in org.apache.poi.xssf.usermodel.helpers"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/poi/xssf/usermodel/helpers/XSSFRowShifter.html" title="class in org.apache.poi.xssf.usermodel.helpers"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/poi/xssf/usermodel/helpers/XSSFPaswordHelper.html" target="_top">Frames</a></li> +<li><a href="XSSFPaswordHelper.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small> + <i>Copyright 2014 The Apache Software Foundation or + its licensors, as applicable.</i> + </small></p> +</body> +</html> Modified: poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/helpers/XSSFRowShifter.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/helpers/XSSFRowShifter.html?rev=1623854&r1=1623853&r2=1623854&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/helpers/XSSFRowShifter.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/helpers/XSSFRowShifter.html Tue Sep 9 15:59:14 2014 @@ -34,7 +34,7 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../../org/apache/poi/xssf/usermodel/helpers/XSSFFormulaUtils.html" title="class in org.apache.poi.xssf.usermodel.helpers"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/poi/xssf/usermodel/helpers/XSSFPaswordHelper.html" title="class in org.apache.poi.xssf.usermodel.helpers"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../../org/apache/poi/xssf/usermodel/helpers/XSSFSingleXmlCell.html" title="class in org.apache.poi.xssf.usermodel.helpers"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> @@ -264,7 +264,7 @@ extends java.lang.Object</pre> </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../../org/apache/poi/xssf/usermodel/helpers/XSSFFormulaUtils.html" title="class in org.apache.poi.xssf.usermodel.helpers"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/poi/xssf/usermodel/helpers/XSSFPaswordHelper.html" title="class in org.apache.poi.xssf.usermodel.helpers"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../../org/apache/poi/xssf/usermodel/helpers/XSSFSingleXmlCell.html" title="class in org.apache.poi.xssf.usermodel.helpers"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> Added: poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/helpers/class-use/XSSFPaswordHelper.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/helpers/class-use/XSSFPaswordHelper.html?rev=1623854&view=auto ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/helpers/class-use/XSSFPaswordHelper.html (added) +++ poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/helpers/class-use/XSSFPaswordHelper.html Tue Sep 9 15:59:14 2014 @@ -0,0 +1,117 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<title>Uses of Class org.apache.poi.xssf.usermodel.helpers.XSSFPaswordHelper (POI API Documentation)</title> +<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Uses of Class org.apache.poi.xssf.usermodel.helpers.XSSFPaswordHelper (POI API Documentation)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../../overview-summary.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../../org/apache/poi/xssf/usermodel/helpers/XSSFPaswordHelper.html" title="class in org.apache.poi.xssf.usermodel.helpers">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../index.html?org/apache/poi/xssf/usermodel/helpers/class-use/XSSFPaswordHelper.html" target="_top">Frames</a></li> +<li><a href="XSSFPaswordHelper.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class org.apache.poi.xssf.usermodel.helpers.XSSFPaswordHelper" class="title">Uses of Class<br>org.apache.poi.xssf.usermodel.helpers.XSSFPaswordHelper</h2> +</div> +<div class="classUseContainer">No usage of org.apache.poi.xssf.usermodel.helpers.XSSFPaswordHelper</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../../overview-summary.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../../org/apache/poi/xssf/usermodel/helpers/XSSFPaswordHelper.html" title="class in org.apache.poi.xssf.usermodel.helpers">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../index.html?org/apache/poi/xssf/usermodel/helpers/class-use/XSSFPaswordHelper.html" target="_top">Frames</a></li> +<li><a href="XSSFPaswordHelper.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small> + <i>Copyright 2014 The Apache Software Foundation or + its licensors, as applicable.</i> + </small></p> +</body> +</html> Modified: poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/helpers/package-frame.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/helpers/package-frame.html?rev=1623854&r1=1623853&r2=1623854&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/helpers/package-frame.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/helpers/package-frame.html Tue Sep 9 15:59:14 2014 @@ -13,6 +13,7 @@ <li><a href="ColumnHelper.html" title="class in org.apache.poi.xssf.usermodel.helpers" target="classFrame">ColumnHelper</a></li> <li><a href="HeaderFooterHelper.html" title="class in org.apache.poi.xssf.usermodel.helpers" target="classFrame">HeaderFooterHelper</a></li> <li><a href="XSSFFormulaUtils.html" title="class in org.apache.poi.xssf.usermodel.helpers" target="classFrame">XSSFFormulaUtils</a></li> +<li><a href="XSSFPaswordHelper.html" title="class in org.apache.poi.xssf.usermodel.helpers" target="classFrame">XSSFPaswordHelper</a></li> <li><a href="XSSFRowShifter.html" title="class in org.apache.poi.xssf.usermodel.helpers" target="classFrame">XSSFRowShifter</a></li> <li><a href="XSSFSingleXmlCell.html" title="class in org.apache.poi.xssf.usermodel.helpers" target="classFrame">XSSFSingleXmlCell</a></li> <li><a href="XSSFXmlColumnPr.html" title="class in org.apache.poi.xssf.usermodel.helpers" target="classFrame">XSSFXmlColumnPr</a></li> Modified: poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/helpers/package-summary.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/helpers/package-summary.html?rev=1623854&r1=1623853&r2=1623854&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/helpers/package-summary.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/helpers/package-summary.html Tue Sep 9 15:59:14 2014 @@ -91,19 +91,23 @@ </td> </tr> <tr class="rowColor"> +<td class="colFirst"><a href="../../../../../../org/apache/poi/xssf/usermodel/helpers/XSSFPaswordHelper.html" title="class in org.apache.poi.xssf.usermodel.helpers">XSSFPaswordHelper</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> <td class="colFirst"><a href="../../../../../../org/apache/poi/xssf/usermodel/helpers/XSSFRowShifter.html" title="class in org.apache.poi.xssf.usermodel.helpers">XSSFRowShifter</a></td> <td class="colLast"> <div class="block">Helper for shifting rows up or down</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="../../../../../../org/apache/poi/xssf/usermodel/helpers/XSSFSingleXmlCell.html" title="class in org.apache.poi.xssf.usermodel.helpers">XSSFSingleXmlCell</a></td> <td class="colLast"> <div class="block">This class is a wrapper around the CTSingleXmlCell (Open Office XML Part 4: chapter 3.5.2.1)</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="../../../../../../org/apache/poi/xssf/usermodel/helpers/XSSFXmlColumnPr.html" title="class in org.apache.poi.xssf.usermodel.helpers">XSSFXmlColumnPr</a></td> <td class="colLast"> <div class="block">This class is a wrapper around the CTXmlColumnPr (Open Office XML Part 4: --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
