Modified: poi/site/publish/apidocs/org/apache/poi/ss/format/CellFormat.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/format/CellFormat.html?rev=1809043&r1=1809042&r2=1809043&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/format/CellFormat.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/format/CellFormat.html Wed Sep 20 15:48:44 2017 @@ -17,7 +17,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":9,"i6":9,"i7":10,"i8":41,"i9":41}; +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":9,"i6":9,"i7":10,"i8":9,"i9":41}; var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -234,19 +234,16 @@ extends java.lang.Object</pre> </td> </tr> <tr id="i8" class="altColor"> -<td class="colFirst"><code>static int</code></td> +<td class="colFirst"><code>static <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/format/CellFormat.html#ultimateType-org.apache.poi.ss.usermodel.Cell-">ultimateType</a></span>(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> -<div class="block"><span class="deprecationComment">POI 3.15. This will return a CellType enum in the future</span></div> -</div> +<div class="block">Returns the ultimate cell type, following the results of formulas.</div> </td> </tr> <tr id="i9" class="rowColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/format/CellFormat.html#ultimateTypeEnum-org.apache.poi.ss.usermodel.Cell-">ultimateTypeEnum</a></span>(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> <div class="block"><span class="deprecatedLabel">Deprecated.</span> -<div class="block"><span class="deprecationComment">POI 3.15 beta 3 - Will be deleted when we make the CellType enum transition. See bug 59791.</span></div> +<div class="block"><span class="deprecationComment">use <code>ultimateType</code> instead</span></div> </div> </td> </tr> @@ -388,15 +385,11 @@ extends java.lang.Object</pre> <ul class="blockList"> <li class="blockList"> <h4>ultimateType</h4> -<pre>public static int ultimateType(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</pre> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">POI 3.15. This will return a CellType enum in the future</span></div> +<pre>public static <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a> ultimateType(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</pre> <div class="block">Returns the ultimate cell type, following the results of formulas. If the cell is a <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html#FORMULA"><code>CellType.FORMULA</code></a>, this returns the result of - <a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#getCachedFormulaResultTypeEnum--"><code>Cell.getCachedFormulaResultTypeEnum()</code></a>. Otherwise this returns the - result of <a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#getCellTypeEnum--"><code>Cell.getCellTypeEnum()</code></a>. - - Will return <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel"><code>CellType</code></a> in a future version of POI. - For forwards compatibility, do not hard-code cell type literals in your code.</div> + <a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#getCachedFormulaResultType--"><code>Cell.getCachedFormulaResultType()</code></a>. Otherwise this returns the + result of <a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#getCellType--"><code>Cell.getCellType()</code></a>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>cell</code> - The cell.</dd> @@ -411,13 +404,14 @@ extends java.lang.Object</pre> <ul class="blockList"> <li class="blockList"> <h4>ultimateTypeEnum</h4> -<pre>public static <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a> ultimateTypeEnum(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</pre> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">POI 3.15 beta 3 - Will be deleted when we make the CellType enum transition. See bug 59791.</span></div> +<pre>@Deprecated + <a href="../../../../../org/apache/poi/util/Removal.html" title="annotation in org.apache.poi.util">@Removal</a>(<a href="../../../../../org/apache/poi/util/Removal.html#version--">version</a>="4.2") +public static <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a> ultimateTypeEnum(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <code>ultimateType</code> instead</span></div> <div class="block">Returns the ultimate cell type, following the results of formulas. If the cell is a <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html#FORMULA"><code>CellType.FORMULA</code></a>, this returns the result of - <a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#getCachedFormulaResultTypeEnum--"><code>Cell.getCachedFormulaResultTypeEnum()</code></a>. Otherwise this returns the - result of <a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#getCellTypeEnum--"><code>Cell.getCellTypeEnum()</code></a>.</div> + <a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#getCachedFormulaResultType--"><code>Cell.getCachedFormulaResultType()</code></a>. Otherwise this returns the + result of <a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#getCellType--"><code>Cell.getCellType()</code></a>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>cell</code> - The cell.</dd>
Modified: poi/site/publish/apidocs/org/apache/poi/ss/formula/BaseFormulaEvaluator.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/BaseFormulaEvaluator.html?rev=1809043&r1=1809042&r2=1809043&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/BaseFormulaEvaluator.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/BaseFormulaEvaluator.html Wed Sep 20 15:48:44 2017 @@ -17,7 +17,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":6,"i3":10,"i4":9,"i5":9,"i6":42,"i7":10,"i8":6,"i9":10,"i10":9,"i11":10,"i12":10,"i13":10,"i14":9,"i15":10}; +var methods = {"i0":10,"i1":10,"i2":6,"i3":10,"i4":9,"i5":9,"i6":10,"i7":42,"i8":6,"i9":10,"i10":9,"i11":10,"i12":10,"i13":10,"i14":9,"i15":10}; var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -213,18 +213,18 @@ implements <a href="../../../../../org/a <a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a> evaluator)</code> </td> </tr> <tr id="i6" class="altColor"> -<td class="colFirst"><code>int</code></td> +<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#evaluateFormulaCell-org.apache.poi.ss.usermodel.Cell-">evaluateFormulaCell</a></span>(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> -<div class="block"><span class="deprecationComment">3.15. Will return a <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel"><code>CellType</code></a> enum in the future.</span></div> -</div> +<div class="block">If cell contains formula, it evaluates the formula, + and saves the result of the formula.</div> </td> </tr> <tr id="i7" class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#evaluateFormulaCellEnum-org.apache.poi.ss.usermodel.Cell-">evaluateFormulaCellEnum</a></span>(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> -<div class="block">If cell contains formula, it evaluates the formula, - and saves the result of the formula.</div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">use <code>evaluateFormulaCell(cell)</code> instead</span></div> +</div> </td> </tr> <tr id="i8" class="altColor"> @@ -448,19 +448,19 @@ implements <a href="../../../../../org/a of the old formula. Else if cell does not contain formula, this method leaves the cell unchanged. - Note that the same instance of HSSFCell is returned to + Note that the same instance of <a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel"><code>Cell</code></a> is returned to allow chained calls like: <pre> int evaluatedCellType = evaluator.evaluateInCell(cell).getCellType(); </pre> Be aware that your cell value will be changed to hold the result of the formula. If you simply want the formula - value computed for you, use <a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#evaluateFormulaCellEnum-org.apache.poi.ss.usermodel.Cell-"><code>evaluateFormulaCellEnum(Cell)</code></a>}</div> + value computed for you, use <a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#evaluateFormulaCell-org.apache.poi.ss.usermodel.Cell-"><code>evaluateFormulaCell(Cell)</code></a>}</div> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html#evaluateInCell-org.apache.poi.ss.usermodel.Cell-">evaluateInCell</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a></code></dd> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>cell</code> - </dd> +<dd><code>cell</code> - The <a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel"><code>Cell</code></a> to evaluate and modify.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>the <code>cell</code> that was passed in, allowing for chained calls</dd> </dl> @@ -481,26 +481,29 @@ implements <a href="../../../../../org/a <ul class="blockList"> <li class="blockList"> <h4>evaluateFormulaCell</h4> -<pre>public int evaluateFormulaCell(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</pre> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">3.15. Will return a <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel"><code>CellType</code></a> enum in the future.</span></div> -<div class="block">If cell contains formula, it evaluates the formula, and saves the result of the formula. The - cell remains as a formula cell. If the cell does not contain formula, this method returns -1 - and leaves the cell unchanged. - - Note that the type of the <em>formula result</em> is returned, so you know what kind of - cached formula result is also stored with the formula. +<pre>public <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a> evaluateFormulaCell(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</pre> +<div class="block">If cell contains formula, it evaluates the formula, + and saves the result of the formula. The cell + remains as a formula cell. + Else if cell does not contain formula, this method leaves + the cell unchanged. + Note that the type of the formula result is returned, + so you know what kind of value is also stored with + the formula. <pre> - int evaluatedCellType = evaluator.evaluateFormulaCell(cell); + CellType evaluatedCellType = evaluator.evaluateFormulaCell(cell); </pre> - Be aware that your cell will hold both the formula, and the result. If you want the cell - replaced with the result of the formula, use <a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#evaluateInCell-org.apache.poi.ss.usermodel.Cell-"><code>evaluateInCell(org.apache.poi.ss.usermodel.Cell)</code></a></div> + Be aware that your cell will hold both the formula, + and the result. If you want the cell replaced with + the result of the formula, use <a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#evaluate-org.apache.poi.ss.usermodel.Cell-"><code>evaluate(org.apache.poi.ss.usermodel.Cell)</code></a> }</div> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html#evaluateFormulaCell-org.apache.poi.ss.usermodel.Cell-">evaluateFormulaCell</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a></code></dd> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>cell</code> - The cell to evaluate</dd> <dt><span class="returnLabel">Returns:</span></dt> -<dd>-1 for non-formula cells, or the type of the <em>formula result</em></dd> +<dd>The type of the formula result (the cell's type remains as CellType.FORMULA however) + If cell is not a formula cell, returns <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html#Z:Z_NONE"><code>CellType._NONE</code></a> rather than throwing an exception.</dd> </dl> </li> </ul> @@ -510,7 +513,10 @@ implements <a href="../../../../../org/a <ul class="blockList"> <li class="blockList"> <h4>evaluateFormulaCellEnum</h4> -<pre>public <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a> evaluateFormulaCellEnum(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</pre> +<pre>@Deprecated + <a href="../../../../../org/apache/poi/util/Removal.html" title="annotation in org.apache.poi.util">@Removal</a>(<a href="../../../../../org/apache/poi/util/Removal.html#version--">version</a>="4.2") +public <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a> evaluateFormulaCellEnum(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <code>evaluateFormulaCell(cell)</code> instead</span></div> <div class="block">If cell contains formula, it evaluates the formula, and saves the result of the formula. The cell remains as a formula cell. @@ -520,7 +526,7 @@ implements <a href="../../../../../org/a so you know what kind of value is also stored with the formula. <pre> - CellType evaluatedCellType = evaluator.evaluateFormulaCellEnum(cell); + CellType evaluatedCellType = evaluator.evaluateFormulaCell(cell); </pre> Be aware that your cell will hold both the formula, and the result. If you want the cell replaced with Modified: poi/site/publish/apidocs/org/apache/poi/ss/formula/EvaluationCell.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/EvaluationCell.html?rev=1809043&r1=1809042&r2=1809043&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/EvaluationCell.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/EvaluationCell.html Wed Sep 20 15:48:44 2017 @@ -17,7 +17,7 @@ catch(err) { } //--> -var methods = {"i0":6,"i1":6,"i2":38,"i3":38,"i4":38,"i5":38,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6}; +var methods = {"i0":6,"i1":6,"i2":6,"i3":38,"i4":6,"i5":38,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -136,12 +136,8 @@ var activeTableTab = "activeTableTab"; <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/formula/EvaluationCell.html#getBooleanCellValue--">getBooleanCellValue</a></span>()</code> </td> </tr> <tr id="i2" class="altColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/formula/EvaluationCell.html#getCachedFormulaResultType--">getCachedFormulaResultType</a></span>()</code> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> -<div class="block"><span class="deprecationComment">3.15. Will return a <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel"><code>CellType</code></a> enum in the future.</span></div> -</div> -</td> +<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/formula/EvaluationCell.html#getCachedFormulaResultType--">getCachedFormulaResultType</a></span>()</code> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a></code></td> @@ -153,19 +149,14 @@ var activeTableTab = "activeTableTab"; </td> </tr> <tr id="i4" class="altColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/formula/EvaluationCell.html#getCellType--">getCellType</a></span>()</code> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> -<div class="block"><span class="deprecationComment">3.15. Will return a <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel"><code>CellType</code></a> enum in the future.</span></div> -</div> -</td> +<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/formula/EvaluationCell.html#getCellType--">getCellType</a></span>()</code> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/formula/EvaluationCell.html#getCellTypeEnum--">getCellTypeEnum</a></span>()</code> <div class="block"><span class="deprecatedLabel">Deprecated.</span> -<div class="block"><span class="deprecationComment">POI 3.15 beta 3. - Will be deleted when we make the CellType enum transition. See bug 59791.</span></div> +<div class="block"><span class="deprecationComment">POI 3.15 beta 3.</span></div> </div> </td> </tr> @@ -263,14 +254,7 @@ var activeTableTab = "activeTableTab"; <ul class="blockList"> <li class="blockList"> <h4>getCellType</h4> -<pre>int getCellType()</pre> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">3.15. Will return a <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel"><code>CellType</code></a> enum in the future.</span></div> -<div class="block">Will return <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel"><code>CellType</code></a> in a future version of POI. - For forwards compatibility, do not hard-code cell type literals in your code.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>cell type</dd> -</dl> +<pre><a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a> getCellType()</pre> </li> </ul> <a name="getCellTypeEnum--"> @@ -279,9 +263,10 @@ var activeTableTab = "activeTableTab"; <ul class="blockList"> <li class="blockList"> <h4>getCellTypeEnum</h4> -<pre><a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a> getCellTypeEnum()</pre> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">POI 3.15 beta 3. - Will be deleted when we make the CellType enum transition. See bug 59791.</span></div> +<pre>@Deprecated + <a href="../../../../../org/apache/poi/util/Removal.html" title="annotation in org.apache.poi.util">@Removal</a>(<a href="../../../../../org/apache/poi/util/Removal.html#version--">version</a>="4.2") +<a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a> getCellTypeEnum()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">POI 3.15 beta 3.</span></div> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>POI 3.15 beta 3</dd> @@ -348,10 +333,7 @@ var activeTableTab = "activeTableTab"; <ul class="blockList"> <li class="blockList"> <h4>getCachedFormulaResultType</h4> -<pre>int getCachedFormulaResultType()</pre> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">3.15. Will return a <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel"><code>CellType</code></a> enum in the future.</span></div> -<div class="block">Will return <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel"><code>CellType</code></a> in a future version of POI. - For forwards compatibility, do not hard-code cell type literals in your code.</div> +<pre><a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a> getCachedFormulaResultType()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>cell type of cached formula result</dd> @@ -364,7 +346,9 @@ var activeTableTab = "activeTableTab"; <ul class="blockListLast"> <li class="blockList"> <h4>getCachedFormulaResultTypeEnum</h4> -<pre><a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a> getCachedFormulaResultTypeEnum()</pre> +<pre>@Deprecated + <a href="../../../../../org/apache/poi/util/Removal.html" title="annotation in org.apache.poi.util">@Removal</a>(<a href="../../../../../org/apache/poi/util/Removal.html#version--">version</a>="4.2") +<a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a> getCachedFormulaResultTypeEnum()</pre> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">POI 3.15 beta 3. Will be deleted when we make the CellType enum transition. See bug 59791.</span></div> <dl> Modified: poi/site/publish/apidocs/org/apache/poi/ss/formula/IStabilityClassifier.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/IStabilityClassifier.html?rev=1809043&r1=1809042&r2=1809043&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/IStabilityClassifier.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/IStabilityClassifier.html Wed Sep 20 15:48:44 2017 @@ -129,7 +129,7 @@ var activeTableTab = "activeTableTab"; <li>To retain freedom to change any cell definition at any time, an application may classify all cells as 'not final'. This freedom comes at the expense of greater memory consumption.</li> <li>For the purpose of these classifications, setting the cached formula result of a cell (for - example in <a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html#evaluateFormulaCellEnum-org.apache.poi.ss.usermodel.Cell-"><code>FormulaEvaluator.evaluateFormulaCellEnum(org.apache.poi.ss.usermodel.Cell)</code></a>) + example in <a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html#evaluateFormulaCell-org.apache.poi.ss.usermodel.Cell-"><code>FormulaEvaluator.evaluateFormulaCell(org.apache.poi.ss.usermodel.Cell)</code></a>) does not constitute changing the definition of the cell.</li> <li>Updating cells which have been classified as 'final' will cause the evaluator to behave unpredictably (typically ignoring the update).</li> Modified: poi/site/publish/apidocs/org/apache/poi/ss/usermodel/Cell.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/usermodel/Cell.html?rev=1809043&r1=1809042&r2=1809043&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/usermodel/Cell.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/usermodel/Cell.html Wed Sep 20 15:48:44 2017 @@ -17,7 +17,7 @@ catch(err) { } //--> -var methods = {"i0":6,"i1":6,"i2":6,"i3":38,"i4":6,"i5":6,"i6":6,"i7":6,"i8":38,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":38,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6,"i36":6}; +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":38,"i5":6,"i6":6,"i7":6,"i8":6,"i9":38,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -74,13 +74,13 @@ var activeTableTab = "activeTableTab"; <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> -<li><a href="#field.summary">Field</a> | </li> +<li>Field | </li> <li>Constr | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> -<li><a href="#field.detail">Field</a> | </li> +<li>Field | </li> <li>Constr | </li> <li><a href="#method.detail">Method</a></li> </ul> @@ -122,69 +122,6 @@ var activeTableTab = "activeTableTab"; <div class="summary"> <ul class="blockList"> <li class="blockList"> -<!-- =========== FIELD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="field.summary"> -<!-- --> -</a> -<h3>Field Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> -<caption><span>Fields</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Field and Description</th> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>static int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#CELL_TYPE_BLANK">CELL_TYPE_BLANK</a></span></code> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> -<div class="block"><span class="deprecationComment">POI 3.15 beta 3. Use <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html#BLANK"><code>CellType.BLANK</code></a> instead.</span></div> -</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>static int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#CELL_TYPE_BOOLEAN">CELL_TYPE_BOOLEAN</a></span></code> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> -<div class="block"><span class="deprecationComment">POI 3.15 beta 3. Use <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html#BOOLEAN"><code>CellType.BOOLEAN</code></a> instead.</span></div> -</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>static int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#CELL_TYPE_ERROR">CELL_TYPE_ERROR</a></span></code> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> -<div class="block"><span class="deprecationComment">POI 3.15 beta 3. Use <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html#ERROR"><code>CellType.ERROR</code></a> instead.</span></div> -</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>static int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#CELL_TYPE_FORMULA">CELL_TYPE_FORMULA</a></span></code> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> -<div class="block"><span class="deprecationComment">POI 3.15 beta 3. Use <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html#FORMULA"><code>CellType.FORMULA</code></a> instead.</span></div> -</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>static int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#CELL_TYPE_NUMERIC">CELL_TYPE_NUMERIC</a></span></code> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> -<div class="block"><span class="deprecationComment">POI 3.15 beta 3. Use <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html#NUMERIC"><code>CellType.NUMERIC</code></a> instead.</span></div> -</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>static int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#CELL_TYPE_STRING">CELL_TYPE_STRING</a></span></code> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> -<div class="block"><span class="deprecationComment">POI 3.15 beta 3. Use <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html#STRING"><code>CellType.STRING</code></a> instead.</span></div> -</div> -</td> -</tr> -</table> -</li> -</ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="method.summary"> @@ -216,17 +153,17 @@ var activeTableTab = "activeTableTab"; </td> </tr> <tr id="i3" class="rowColor"> -<td class="colFirst"><code>int</code></td> +<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#getCachedFormulaResultType--">getCachedFormulaResultType</a></span>()</code> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> -<div class="block"><span class="deprecationComment">3.15. Will return a <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel"><code>CellType</code></a> enum in the future.</span></div> -</div> +<div class="block">Only valid for formula cells + + Will return <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel"><code>CellType</code></a> in a future version of POI.</div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#getCachedFormulaResultTypeEnum--">getCachedFormulaResultTypeEnum</a></span>()</code> -<div class="block">Only valid for formula cells</div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> </td> </tr> <tr id="i5" class="rowColor"> @@ -248,17 +185,15 @@ var activeTableTab = "activeTableTab"; </td> </tr> <tr id="i8" class="altColor"> -<td class="colFirst"><code>int</code></td> +<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#getCellType--">getCellType</a></span>()</code> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> -<div class="block"><span class="deprecationComment">POI 3.15. Will return a <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel"><code>CellType</code></a> enum in the future.</span></div> -</div> +<div class="block">Return the cell type.</div> </td> </tr> <tr id="i9" class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#getCellTypeEnum--">getCellTypeEnum</a></span>()</code> -<div class="block">Return the cell type.</div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> </td> </tr> <tr id="i10" class="altColor"> @@ -373,50 +308,42 @@ var activeTableTab = "activeTableTab"; </tr> <tr id="i29" class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#setCellType-int-">setCellType</a></span>(int cellType)</code> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> -<div class="block"><span class="deprecationComment">POI 3.15 beta 3. Use <a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#setCellType-org.apache.poi.ss.usermodel.CellType-"><code>setCellType(CellType)</code></a> instead.</span></div> -</div> -</td> -</tr> -<tr id="i30" class="altColor"> -<td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#setCellValue-boolean-">setCellValue</a></span>(boolean value)</code> <div class="block">Set a boolean value for the cell</div> </td> </tr> -<tr id="i31" class="rowColor"> +<tr id="i30" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#setCellValue-java.util.Calendar-">setCellValue</a></span>(java.util.Calendar value)</code> <div class="block">Set a date value for the cell.</div> </td> </tr> -<tr id="i32" class="altColor"> +<tr id="i31" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#setCellValue-java.util.Date-">setCellValue</a></span>(java.util.Date value)</code> <div class="block">Converts the supplied date to its equivalent Excel numeric value and sets that into the cell.</div> </td> </tr> -<tr id="i33" class="rowColor"> +<tr id="i32" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#setCellValue-double-">setCellValue</a></span>(double value)</code> <div class="block">Set a numeric value for the cell</div> </td> </tr> -<tr id="i34" class="altColor"> +<tr id="i33" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#setCellValue-org.apache.poi.ss.usermodel.RichTextString-">setCellValue</a></span>(<a href="../../../../../org/apache/poi/ss/usermodel/RichTextString.html" title="interface in org.apache.poi.ss.usermodel">RichTextString</a> value)</code> <div class="block">Set a rich string value for the cell.</div> </td> </tr> -<tr id="i35" class="rowColor"> +<tr id="i34" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#setCellValue-java.lang.String-">setCellValue</a></span>(java.lang.String value)</code> <div class="block">Set a string value for the cell.</div> </td> </tr> -<tr id="i36" class="altColor"> +<tr id="i35" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#setHyperlink-org.apache.poi.ss.usermodel.Hyperlink-">setHyperlink</a></span>(<a href="../../../../../org/apache/poi/ss/usermodel/Hyperlink.html" title="interface in org.apache.poi.ss.usermodel">Hyperlink</a> link)</code> <div class="block">Assign a hyperlink to this cell</div> @@ -431,128 +358,6 @@ var activeTableTab = "activeTableTab"; <div class="details"> <ul class="blockList"> <li class="blockList"> -<!-- ============ FIELD DETAIL =========== --> -<ul class="blockList"> -<li class="blockList"><a name="field.detail"> -<!-- --> -</a> -<h3>Field Detail</h3> -<a name="CELL_TYPE_NUMERIC"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>CELL_TYPE_NUMERIC</h4> -<pre>@Deprecated - <a href="../../../../../org/apache/poi/util/Removal.html" title="annotation in org.apache.poi.util">@Removal</a>(<a href="../../../../../org/apache/poi/util/Removal.html#version--">version</a>="4.0") -static final int CELL_TYPE_NUMERIC</pre> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">POI 3.15 beta 3. Use <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html#NUMERIC"><code>CellType.NUMERIC</code></a> instead.</span></div> -<div class="block">Numeric Cell type (0)</div> -<dl> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#setCellType-int-"><code>setCellType(int)</code></a>, -<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#getCellType--"><code>getCellType()</code></a>, -<a href="../../../../../constant-values.html#org.apache.poi.ss.usermodel.Cell.CELL_TYPE_NUMERIC">Constant Field Values</a></dd> -</dl> -</li> -</ul> -<a name="CELL_TYPE_STRING"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>CELL_TYPE_STRING</h4> -<pre>@Deprecated - <a href="../../../../../org/apache/poi/util/Removal.html" title="annotation in org.apache.poi.util">@Removal</a>(<a href="../../../../../org/apache/poi/util/Removal.html#version--">version</a>="4.0") -static final int CELL_TYPE_STRING</pre> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">POI 3.15 beta 3. Use <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html#STRING"><code>CellType.STRING</code></a> instead.</span></div> -<div class="block">String Cell type (1)</div> -<dl> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#setCellType-int-"><code>setCellType(int)</code></a>, -<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#getCellType--"><code>getCellType()</code></a>, -<a href="../../../../../constant-values.html#org.apache.poi.ss.usermodel.Cell.CELL_TYPE_STRING">Constant Field Values</a></dd> -</dl> -</li> -</ul> -<a name="CELL_TYPE_FORMULA"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>CELL_TYPE_FORMULA</h4> -<pre>@Deprecated - <a href="../../../../../org/apache/poi/util/Removal.html" title="annotation in org.apache.poi.util">@Removal</a>(<a href="../../../../../org/apache/poi/util/Removal.html#version--">version</a>="4.0") -static final int CELL_TYPE_FORMULA</pre> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">POI 3.15 beta 3. Use <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html#FORMULA"><code>CellType.FORMULA</code></a> instead.</span></div> -<div class="block">Formula Cell type (2)</div> -<dl> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#setCellType-int-"><code>setCellType(int)</code></a>, -<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#getCellType--"><code>getCellType()</code></a>, -<a href="../../../../../constant-values.html#org.apache.poi.ss.usermodel.Cell.CELL_TYPE_FORMULA">Constant Field Values</a></dd> -</dl> -</li> -</ul> -<a name="CELL_TYPE_BLANK"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>CELL_TYPE_BLANK</h4> -<pre>@Deprecated - <a href="../../../../../org/apache/poi/util/Removal.html" title="annotation in org.apache.poi.util">@Removal</a>(<a href="../../../../../org/apache/poi/util/Removal.html#version--">version</a>="4.0") -static final int CELL_TYPE_BLANK</pre> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">POI 3.15 beta 3. Use <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html#BLANK"><code>CellType.BLANK</code></a> instead.</span></div> -<div class="block">Blank Cell type (3)</div> -<dl> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#setCellType-int-"><code>setCellType(int)</code></a>, -<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#getCellType--"><code>getCellType()</code></a>, -<a href="../../../../../constant-values.html#org.apache.poi.ss.usermodel.Cell.CELL_TYPE_BLANK">Constant Field Values</a></dd> -</dl> -</li> -</ul> -<a name="CELL_TYPE_BOOLEAN"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>CELL_TYPE_BOOLEAN</h4> -<pre>@Deprecated - <a href="../../../../../org/apache/poi/util/Removal.html" title="annotation in org.apache.poi.util">@Removal</a>(<a href="../../../../../org/apache/poi/util/Removal.html#version--">version</a>="4.0") -static final int CELL_TYPE_BOOLEAN</pre> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">POI 3.15 beta 3. Use <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html#BOOLEAN"><code>CellType.BOOLEAN</code></a> instead.</span></div> -<div class="block">Boolean Cell type (4)</div> -<dl> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#setCellType-int-"><code>setCellType(int)</code></a>, -<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#getCellType--"><code>getCellType()</code></a>, -<a href="../../../../../constant-values.html#org.apache.poi.ss.usermodel.Cell.CELL_TYPE_BOOLEAN">Constant Field Values</a></dd> -</dl> -</li> -</ul> -<a name="CELL_TYPE_ERROR"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>CELL_TYPE_ERROR</h4> -<pre>@Deprecated - <a href="../../../../../org/apache/poi/util/Removal.html" title="annotation in org.apache.poi.util">@Removal</a>(<a href="../../../../../org/apache/poi/util/Removal.html#version--">version</a>="4.0") -static final int CELL_TYPE_ERROR</pre> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">POI 3.15 beta 3. Use <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html#ERROR"><code>CellType.ERROR</code></a> instead.</span></div> -<div class="block">Error Cell type (5)</div> -<dl> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#setCellType-int-"><code>setCellType(int)</code></a>, -<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#getCellType--"><code>getCellType()</code></a>, -<a href="../../../../../constant-values.html#org.apache.poi.ss.usermodel.Cell.CELL_TYPE_ERROR">Constant Field Values</a></dd> -</dl> -</li> -</ul> -</li> -</ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method.detail"> @@ -615,38 +420,6 @@ static final int CELL_TYPE_ERROR</p </dl> </li> </ul> -<a name="setCellType-int-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>setCellType</h4> -<pre>@Deprecated - <a href="../../../../../org/apache/poi/util/Removal.html" title="annotation in org.apache.poi.util">@Removal</a>(<a href="../../../../../org/apache/poi/util/Removal.html#version--">version</a>="4.0") -void setCellType(int cellType)</pre> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">POI 3.15 beta 3. Use <a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#setCellType-org.apache.poi.ss.usermodel.CellType-"><code>setCellType(CellType)</code></a> instead.</span></div> -<div class="block">Set the cells type (numeric, formula or string). - <p>If the cell currently contains a value, the value will - be converted to match the new type, if possible. Formatting - is generally lost in the process however.</p> - <p>If what you want to do is get a String value for your - numeric cell, <i>stop!</i>. This is not the way to do it. - Instead, for fetching the string value of a numeric or boolean - or date cell, use <a href="../../../../../org/apache/poi/ss/usermodel/DataFormatter.html" title="class in org.apache.poi.ss.usermodel"><code>DataFormatter</code></a> instead.</p></div> -<dl> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code>java.lang.IllegalArgumentException</code> - if the specified cell type is invalid</dd> -<dd><code>java.lang.IllegalStateException</code> - if the current value cannot be converted to the new type</dd> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../../../org/apache/poi/ss/usermodel/CellType.html#NUMERIC"><code>CellType.NUMERIC</code></a>, -<a href="../../../../../org/apache/poi/ss/usermodel/CellType.html#STRING"><code>CellType.STRING</code></a>, -<a href="../../../../../org/apache/poi/ss/usermodel/CellType.html#FORMULA"><code>CellType.FORMULA</code></a>, -<a href="../../../../../org/apache/poi/ss/usermodel/CellType.html#BLANK"><code>CellType.BLANK</code></a>, -<a href="../../../../../org/apache/poi/ss/usermodel/CellType.html#BOOLEAN"><code>CellType.BOOLEAN</code></a>, -<a href="../../../../../org/apache/poi/ss/usermodel/CellType.html#ERROR"><code>CellType.ERROR</code></a></dd> -</dl> -</li> -</ul> <a name="setCellType-org.apache.poi.ss.usermodel.CellType-"> <!-- --> </a> @@ -675,13 +448,8 @@ void setCellType(int cellType) <ul class="blockList"> <li class="blockList"> <h4>getCellType</h4> -<pre>@Deprecated -int getCellType()</pre> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">POI 3.15. Will return a <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel"><code>CellType</code></a> enum in the future.</span></div> -<div class="block">Return the cell type. - - Will return <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel"><code>CellType</code></a> in version 4.0 of POI. - For forwards compatibility, do not hard-code cell type literals in your code.</div> +<pre><a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a> getCellType()</pre> +<div class="block">Return the cell type.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the cell type</dd> @@ -694,8 +462,10 @@ int getCellType()</pre> <ul class="blockList"> <li class="blockList"> <h4>getCellTypeEnum</h4> -<pre><a href="../../../../../org/apache/poi/util/Removal.html" title="annotation in org.apache.poi.util">@Removal</a>(<a href="../../../../../org/apache/poi/util/Removal.html#version--">version</a>="4.2") +<pre>@Deprecated + <a href="../../../../../org/apache/poi/util/Removal.html" title="annotation in org.apache.poi.util">@Removal</a>(<a href="../../../../../org/apache/poi/util/Removal.html#version--">version</a>="4.2") <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a> getCellTypeEnum()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">Return the cell type.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -712,9 +482,7 @@ int getCellType()</pre> <ul class="blockList"> <li class="blockList"> <h4>getCachedFormulaResultType</h4> -<pre>@Deprecated -int getCachedFormulaResultType()</pre> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">3.15. Will return a <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel"><code>CellType</code></a> enum in the future.</span></div> +<pre><a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a> getCachedFormulaResultType()</pre> <div class="block">Only valid for formula cells Will return <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel"><code>CellType</code></a> in a future version of POI. @@ -733,7 +501,10 @@ int getCachedFormulaResultType()</p <ul class="blockList"> <li class="blockList"> <h4>getCachedFormulaResultTypeEnum</h4> -<pre><a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a> getCachedFormulaResultTypeEnum()</pre> +<pre>@Deprecated + <a href="../../../../../org/apache/poi/util/Removal.html" title="annotation in org.apache.poi.util">@Removal</a>(<a href="../../../../../org/apache/poi/util/Removal.html#version--">version</a>="4.2") +<a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a> getCachedFormulaResultTypeEnum()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">Only valid for formula cells</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -879,7 +650,7 @@ int getCachedFormulaResultType()</p <dt><span class="returnLabel">Returns:</span></dt> <dd>a formula for the cell</dd> <dt><span class="throwsLabel">Throws:</span></dt> -<dd><code>java.lang.IllegalStateException</code> - if the cell type returned by <a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#getCellTypeEnum--"><code>getCellTypeEnum()</code></a> is not <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html#FORMULA"><code>CellType.FORMULA</code></a></dd> +<dd><code>java.lang.IllegalStateException</code> - if the cell type returned by <a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#getCellType--"><code>getCellType()</code></a> is not <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html#FORMULA"><code>CellType.FORMULA</code></a></dd> </dl> </li> </ul> @@ -899,7 +670,7 @@ int getCachedFormulaResultType()</p <dt><span class="returnLabel">Returns:</span></dt> <dd>the value of the cell as a number</dd> <dt><span class="throwsLabel">Throws:</span></dt> -<dd><code>java.lang.IllegalStateException</code> - if the cell type returned by <a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#getCellTypeEnum--"><code>getCellTypeEnum()</code></a> is <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html#STRING"><code>CellType.STRING</code></a></dd> +<dd><code>java.lang.IllegalStateException</code> - if the cell type returned by <a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#getCellType--"><code>getCellType()</code></a> is <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html#STRING"><code>CellType.STRING</code></a></dd> <dd><code>java.lang.NumberFormatException</code> - if the cell value isn't a parsable <code>double</code>.</dd> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../../../org/apache/poi/ss/usermodel/DataFormatter.html" title="class in org.apache.poi.ss.usermodel"><code>for turning this number into a string similar to that which Excel would render this number as.</code></a></dd> @@ -921,7 +692,7 @@ int getCachedFormulaResultType()</p <dt><span class="returnLabel">Returns:</span></dt> <dd>the value of the cell as a date</dd> <dt><span class="throwsLabel">Throws:</span></dt> -<dd><code>java.lang.IllegalStateException</code> - if the cell type returned by <a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#getCellTypeEnum--"><code>getCellTypeEnum()</code></a> is <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html#STRING"><code>CellType.STRING</code></a></dd> +<dd><code>java.lang.IllegalStateException</code> - if the cell type returned by <a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#getCellType--"><code>getCellType()</code></a> is <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html#STRING"><code>CellType.STRING</code></a></dd> <dd><code>java.lang.NumberFormatException</code> - if the cell value isn't a parsable <code>double</code>.</dd> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../../../org/apache/poi/ss/usermodel/DataFormatter.html" title="class in org.apache.poi.ss.usermodel"><code>for formatting this date into a string similar to how excel does.</code></a></dd> @@ -1014,7 +785,7 @@ int getCachedFormulaResultType()</p <dt><span class="returnLabel">Returns:</span></dt> <dd>the value of the cell as a boolean</dd> <dt><span class="throwsLabel">Throws:</span></dt> -<dd><code>java.lang.IllegalStateException</code> - if the cell type returned by <a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#getCellTypeEnum--"><code>getCellTypeEnum()</code></a> +<dd><code>java.lang.IllegalStateException</code> - if the cell type returned by <a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#getCellType--"><code>getCellType()</code></a> is not <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html#BOOLEAN"><code>CellType.BOOLEAN</code></a>, <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html#BLANK"><code>CellType.BLANK</code></a> or <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html#FORMULA"><code>CellType.FORMULA</code></a></dd> </dl> </li> @@ -1035,7 +806,7 @@ int getCachedFormulaResultType()</p <dt><span class="returnLabel">Returns:</span></dt> <dd>the value of the cell as an error code</dd> <dt><span class="throwsLabel">Throws:</span></dt> -<dd><code>java.lang.IllegalStateException</code> - if the cell type returned by <a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#getCellTypeEnum--"><code>getCellTypeEnum()</code></a> isn't <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html#ERROR"><code>CellType.ERROR</code></a></dd> +<dd><code>java.lang.IllegalStateException</code> - if the cell type returned by <a href="../../../../../org/apache/poi/ss/usermodel/Cell.html#getCellType--"><code>getCellType()</code></a> isn't <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html#ERROR"><code>CellType.ERROR</code></a></dd> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../../../org/apache/poi/ss/usermodel/FormulaError.html" title="enum in org.apache.poi.ss.usermodel"><code>for error codes</code></a></dd> </dl> @@ -1261,13 +1032,13 @@ int getCachedFormulaResultType()</p <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> -<li><a href="#field.summary">Field</a> | </li> +<li>Field | </li> <li>Constr | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> -<li><a href="#field.detail">Field</a> | </li> +<li>Field | </li> <li>Constr | </li> <li><a href="#method.detail">Method</a></li> </ul> Modified: poi/site/publish/apidocs/org/apache/poi/ss/usermodel/CellValue.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/usermodel/CellValue.html?rev=1809043&r1=1809042&r2=1809043&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/usermodel/CellValue.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/usermodel/CellValue.html Wed Sep 20 15:48:44 2017 @@ -17,7 +17,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":42,"i3":10,"i4":9,"i5":10,"i6":10,"i7":10,"i8":10,"i9":9}; +var methods = {"i0":10,"i1":10,"i2":10,"i3":42,"i4":9,"i5":10,"i6":10,"i7":10,"i8":10,"i9":9}; var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -183,17 +183,17 @@ extends java.lang.Object</pre> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/usermodel/CellValue.html#getBooleanValue--">getBooleanValue</a></span>()</code> </td> </tr> <tr id="i2" class="altColor"> -<td class="colFirst"><code>int</code></td> +<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/usermodel/CellValue.html#getCellType--">getCellType</a></span>()</code> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> -<div class="block"><span class="deprecationComment">POI 3.15. Use <a href="../../../../../org/apache/poi/ss/usermodel/CellValue.html#getCellTypeEnum--"><code>getCellTypeEnum()</code></a> instead.</span></div> -</div> +<div class="block">Return the cell type.</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/usermodel/CellValue.html#getCellTypeEnum--">getCellTypeEnum</a></span>()</code> -<div class="block">Return the cell type.</div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">use <code>getCellType</code> instead</span></div> +</div> </td> </tr> <tr id="i4" class="altColor"> @@ -357,15 +357,16 @@ extends java.lang.Object</pre> <ul class="blockList"> <li class="blockList"> <h4>getCellTypeEnum</h4> -<pre><a href="../../../../../org/apache/poi/util/Removal.html" title="annotation in org.apache.poi.util">@Removal</a>(<a href="../../../../../org/apache/poi/util/Removal.html#version--">version</a>="4.2") +<pre>@Deprecated + <a href="../../../../../org/apache/poi/util/Removal.html" title="annotation in org.apache.poi.util">@Removal</a>(<a href="../../../../../org/apache/poi/util/Removal.html#version--">version</a>="4.2") public <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a> getCellTypeEnum()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <code>getCellType</code> instead</span></div> <div class="block">Return the cell type.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the cell type</dd> <dt><span class="simpleTagLabel">Since:</span></dt> -<dd>POI 3.15 - Will be renamed to <code>getCellTypeEnum()</code> when we make the CellType enum transition in POI 4.0. See bug 59791.</dd> +<dd>POI 3.15</dd> </dl> </li> </ul> @@ -375,13 +376,8 @@ public <a href="../../../../../org/ <ul class="blockList"> <li class="blockList"> <h4>getCellType</h4> -<pre>@Deprecated -public int getCellType()</pre> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">POI 3.15. Use <a href="../../../../../org/apache/poi/ss/usermodel/CellValue.html#getCellTypeEnum--"><code>getCellTypeEnum()</code></a> instead.</span></div> -<div class="block">Return the cell type. - - Will return <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel"><code>CellType</code></a> in version 4.0 of POI. - For forwards compatibility, do not hard-code cell type literals in your code.</div> +<pre>public <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a> getCellType()</pre> +<div class="block">Return the cell type.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the cell type</dd> Modified: poi/site/publish/apidocs/org/apache/poi/ss/usermodel/FormulaEvaluator.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/usermodel/FormulaEvaluator.html?rev=1809043&r1=1809042&r2=1809043&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/usermodel/FormulaEvaluator.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/usermodel/FormulaEvaluator.html Wed Sep 20 15:48:44 2017 @@ -17,7 +17,7 @@ catch(err) { } //--> -var methods = {"i0":6,"i1":6,"i2":6,"i3":38,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6}; +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":38,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -153,18 +153,18 @@ var activeTableTab = "activeTableTab"; </td> </tr> <tr id="i3" class="rowColor"> -<td class="colFirst"><code>int</code></td> +<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html#evaluateFormulaCell-org.apache.poi.ss.usermodel.Cell-">evaluateFormulaCell</a></span>(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> -<div class="block"><span class="deprecationComment">3.15. Will return a <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel"><code>CellType</code></a> enum in the future</span></div> -</div> +<div class="block">If cell contains formula, it evaluates the formula, + and saves the result of the formula.</div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html#evaluateFormulaCellEnum-org.apache.poi.ss.usermodel.Cell-">evaluateFormulaCellEnum</a></span>(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> -<div class="block">If cell contains formula, it evaluates the formula, - and saves the result of the formula.</div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">use <code>evaluateFormulaCell(cell)</code></span></div> +</div> </td> </tr> <tr id="i5" class="rowColor"> @@ -310,7 +310,7 @@ var activeTableTab = "activeTableTab"; original cell.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>cell</code> - </dd> +<dd><code>cell</code> - The <a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel"><code>Cell</code></a> to evaluate</dd> </dl> </li> </ul> @@ -320,8 +320,7 @@ var activeTableTab = "activeTableTab"; <ul class="blockList"> <li class="blockList"> <h4>evaluateFormulaCell</h4> -<pre>int evaluateFormulaCell(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</pre> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">3.15. Will return a <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel"><code>CellType</code></a> enum in the future</span></div> +<pre><a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a> evaluateFormulaCell(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</pre> <div class="block">If cell contains formula, it evaluates the formula, and saves the result of the formula. The cell remains as a formula cell. @@ -353,7 +352,10 @@ var activeTableTab = "activeTableTab"; <ul class="blockList"> <li class="blockList"> <h4>evaluateFormulaCellEnum</h4> -<pre><a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a> evaluateFormulaCellEnum(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</pre> +<pre>@Deprecated + <a href="../../../../../org/apache/poi/util/Removal.html" title="annotation in org.apache.poi.util">@Removal</a>(<a href="../../../../../org/apache/poi/util/Removal.html#version--">version</a>="4.2") +<a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a> evaluateFormulaCellEnum(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <code>evaluateFormulaCell(cell)</code></span></div> <div class="block">If cell contains formula, it evaluates the formula, and saves the result of the formula. The cell remains as a formula cell. @@ -363,7 +365,7 @@ var activeTableTab = "activeTableTab"; so you know what kind of value is also stored with the formula. <pre> - CellType evaluatedCellType = evaluator.evaluateFormulaCellEnum(cell); + CellType evaluatedCellType = evaluator.evaluateFormulaCell(cell); </pre> Be aware that your cell will hold both the formula, and the result. If you want the cell replaced with @@ -398,10 +400,10 @@ var activeTableTab = "activeTableTab"; </pre> Be aware that your cell value will be changed to hold the result of the formula. If you simply want the formula - value computed for you, use <a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html#evaluateFormulaCellEnum-org.apache.poi.ss.usermodel.Cell-"><code>evaluateFormulaCellEnum(Cell)</code></a></div> + value computed for you, use <a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html#evaluateFormulaCell-org.apache.poi.ss.usermodel.Cell-"><code>evaluateFormulaCell(Cell)</code></a></div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>cell</code> - </dd> +<dd><code>cell</code> - The <a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel"><code>Cell</code></a> to evaluate and modify.</dd> </dl> </li> </ul> Modified: poi/site/publish/apidocs/org/apache/poi/ss/usermodel/Name.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/usermodel/Name.html?rev=1809043&r1=1809042&r2=1809043&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/usermodel/Name.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/usermodel/Name.html Wed Sep 20 15:48:44 2017 @@ -358,7 +358,12 @@ var activeTableTab = "activeTableTab"; <li><code>HR!$A$1:$Z$345</code></li> <li><code>SUM(Sheet1!A1,Sheet2!B2)</li> <li><code>-PMT(Interest_Rate/12,Number_of_Payments,Loan_Amount)</li> - </ul></div> + </ul> + + Note: Using relative values like 'A1:B1' can lead to unexpected moving of + the cell that the name points to when working with the workbook in Microsoft Excel, + usually using absolute references like '$A$1:$B$1' avoids this, see also + https://superuser.com/a/1031047/126954</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>formulaText</code> - the reference for this name</dd> Modified: poi/site/publish/apidocs/org/apache/poi/ss/usermodel/TableStyleType.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/usermodel/TableStyleType.html?rev=1809043&r1=1809042&r2=1809043&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/usermodel/TableStyleType.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/usermodel/TableStyleType.html Wed Sep 20 15:48:44 2017 @@ -49,7 +49,7 @@ var activeTableTab = "activeTableTab"; <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/poi/ss/usermodel/TableStyleInfo.html" title="interface in org.apache.poi.ss.usermodel"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/poi/ss/usermodel/Textbox.html" title="interface in org.apache.poi.ss.usermodel"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../../org/apache/poi/ss/usermodel/VerticalAlignment.html" title="enum in org.apache.poi.ss.usermodel"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/poi/ss/usermodel/TableStyleType.html" target="_top">Frames</a></li> @@ -659,7 +659,7 @@ not permitted.)</div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/poi/ss/usermodel/TableStyleInfo.html" title="interface in org.apache.poi.ss.usermodel"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/poi/ss/usermodel/Textbox.html" title="interface in org.apache.poi.ss.usermodel"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../../org/apache/poi/ss/usermodel/VerticalAlignment.html" title="enum in org.apache.poi.ss.usermodel"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/poi/ss/usermodel/TableStyleType.html" target="_top">Frames</a></li> Modified: poi/site/publish/apidocs/org/apache/poi/ss/usermodel/VerticalAlignment.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/usermodel/VerticalAlignment.html?rev=1809043&r1=1809042&r2=1809043&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/usermodel/VerticalAlignment.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/usermodel/VerticalAlignment.html Wed Sep 20 15:48:44 2017 @@ -48,7 +48,7 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/poi/ss/usermodel/Textbox.html" title="interface in org.apache.poi.ss.usermodel"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/poi/ss/usermodel/TableStyleType.html" title="enum in org.apache.poi.ss.usermodel"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> @@ -403,7 +403,7 @@ not permitted.)</div> </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/poi/ss/usermodel/Textbox.html" title="interface in org.apache.poi.ss.usermodel"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/poi/ss/usermodel/TableStyleType.html" title="enum in org.apache.poi.ss.usermodel"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
