Modified: poi/site/publish/apidocs/org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html?rev=1794154&r1=1794153&r2=1794154&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html Sat May 6 14:51:28 2017 @@ -105,19 +105,6 @@ <pre>public class <span class="strong">EvaluationConditionalFormatRule</span> extends java.lang.Object implements java.lang.Comparable<<a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html" title="class in org.apache.poi.ss.formula">EvaluationConditionalFormatRule</a>></pre> -<div class="block">Abstracted and cached version of a Conditional Format rule for use with a - <a href="../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html" title="class in org.apache.poi.ss.formula"><code>ConditionalFormattingEvaluator</code></a>. This references a rule, its owning - <a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormatting.html" title="interface in org.apache.poi.ss.usermodel"><code>ConditionalFormatting</code></a>, its priority order (lower index = higher priority in Excel), - and the information needed to evaluate the rule for a given cell. - <p/> - Having this all combined and cached avoids repeated access calls to the - underlying structural objects, XSSF CT* objects and HSSF raw byte structures. - Those objects can be referenced from here. This object will be out of sync if - anything modifies the referenced structures' evaluation properties. - <p/> - The assumption is that consuming applications will read the display properties once and - create whatever style objects they need, caching those at the application level. - Thus this class only caches values needed for evaluation, not display.</div> </li> </ul> </div> @@ -221,34 +208,38 @@ implements java.lang.Comparable<<a hr <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html#getFormula2()">getFormula2</a></strong>()</code> </td> </tr> <tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel">ExcelNumberFormat</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html#getNumberFormat()">getNumberFormat</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">EvaluationConditionalFormatRule.OperatorEnum</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html#getOperator()">getOperator</a></strong>()</code> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html#getPriority()">getPriority</a></strong>()</code> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/util/CellRangeAddress.html" title="class in org.apache.poi.ss.util">CellRangeAddress</a>[]</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html#getRegions()">getRegions</a></strong>()</code> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html" title="interface in org.apache.poi.ss.usermodel">ConditionalFormattingRule</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html#getRule()">getRule</a></strong>()</code> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html#getRuleIndex()">getRuleIndex</a></strong>()</code> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/Sheet.html" title="interface in org.apache.poi.ss.usermodel">Sheet</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html#getSheet()">getSheet</a></strong>()</code> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionType.html" title="class in org.apache.poi.ss.usermodel">ConditionType</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html#getType()">getType</a></strong>()</code> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html#hashCode()">hashCode</a></strong>()</code> </td> </tr> @@ -306,6 +297,7 @@ implements java.lang.Comparable<<a hr <li class="blockList"> <h4>getSheet</h4> <pre>public <a href="../../../../../org/apache/poi/ss/usermodel/Sheet.html" title="interface in org.apache.poi.ss.usermodel">Sheet</a> getSheet()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>sheet</dd></dl> </li> </ul> <a name="getFormatting()"> @@ -325,6 +317,17 @@ implements java.lang.Comparable<<a hr <li class="blockList"> <h4>getFormattingIndex</h4> <pre>public int getFormattingIndex()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>conditional formatting index</dd></dl> +</li> +</ul> +<a name="getNumberFormat()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNumberFormat</h4> +<pre>public <a href="../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel">ExcelNumberFormat</a> getNumberFormat()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>Excel number format string to apply to matching cells, or null to keep the cell default</dd></dl> </li> </ul> <a name="getRule()"> @@ -344,6 +347,7 @@ implements java.lang.Comparable<<a hr <li class="blockList"> <h4>getRuleIndex</h4> <pre>public int getRuleIndex()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>rule index</dd></dl> </li> </ul> <a name="getRegions()">
Modified: poi/site/publish/apidocs/org/apache/poi/ss/formula/class-use/ConditionalFormattingEvaluator.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/class-use/ConditionalFormattingEvaluator.html?rev=1794154&r1=1794153&r2=1794154&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/class-use/ConditionalFormattingEvaluator.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/class-use/ConditionalFormattingEvaluator.html Sat May 6 14:51:28 2017 @@ -67,7 +67,67 @@ <div class="header"> <h2 title="Uses of Class org.apache.poi.ss.formula.ConditionalFormattingEvaluator" class="title">Uses of Class<br>org.apache.poi.ss.formula.ConditionalFormattingEvaluator</h2> </div> -<div class="classUseContainer">No usage of org.apache.poi.ss.formula.ConditionalFormattingEvaluator</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html" title="class in org.apache.poi.ss.formula">ConditionalFormattingEvaluator</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#org.apache.poi.ss.usermodel">org.apache.poi.ss.usermodel</a></td> +<td class="colLast"> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="org.apache.poi.ss.usermodel"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html" title="class in org.apache.poi.ss.formula">ConditionalFormattingEvaluator</a> in <a href="../../../../../../org/apache/poi/ss/usermodel/package-summary.html">org.apache.poi.ss.usermodel</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../org/apache/poi/ss/usermodel/package-summary.html">org.apache.poi.ss.usermodel</a> with parameters of type <a href="../../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html" title="class in org.apache.poi.ss.formula">ConditionalFormattingEvaluator</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><span class="strong">DataFormatter.</span><code><strong><a href="../../../../../../org/apache/poi/ss/usermodel/DataFormatter.html#formatCellValue(org.apache.poi.ss.usermodel.Cell,%20org.apache.poi.ss.usermodel.FormulaEvaluator,%20org.apache.poi.ss.formula.ConditionalFormattingEvaluator)">formatCellValue</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell, + <a href="../../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a> evaluator, + <a href="../../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html" title="class in org.apache.poi.ss.formula">ConditionalFormattingEvaluator</a> cfEvaluator)</code> +<div class="block"> + Returns the formatted value of a cell as a <tt>String</tt> regardless + of the cell type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel">ExcelNumberFormat</a></code></td> +<td class="colLast"><span class="strong">ExcelNumberFormat.</span><code><strong><a href="../../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html#from(org.apache.poi.ss.usermodel.Cell,%20org.apache.poi.ss.formula.ConditionalFormattingEvaluator)">from</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell, + <a href="../../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html" title="class in org.apache.poi.ss.formula">ConditionalFormattingEvaluator</a> cfEvaluator)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><span class="strong">DateUtil.</span><code><strong><a href="../../../../../../org/apache/poi/ss/usermodel/DateUtil.html#isCellDateFormatted(org.apache.poi.ss.usermodel.Cell,%20org.apache.poi.ss.formula.ConditionalFormattingEvaluator)">isCellDateFormatted</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell, + <a href="../../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html" title="class in org.apache.poi.ss.formula">ConditionalFormattingEvaluator</a> cfEvaluator)</code> +<div class="block">Check if a cell contains a date + Since dates are stored internally in Excel as double values + we infer it is a date if it is formatted as such.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar_bottom"> <!-- --> Modified: poi/site/publish/apidocs/org/apache/poi/ss/formula/package-summary.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/package-summary.html?rev=1794154&r1=1794153&r2=1794154&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/package-summary.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/package-summary.html Sat May 6 14:51:28 2017 @@ -230,10 +230,7 @@ </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html" title="class in org.apache.poi.ss.formula">EvaluationConditionalFormatRule</a></td> -<td class="colLast"> -<div class="block">Abstracted and cached version of a Conditional Format rule for use with a - <a href="../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html" title="class in org.apache.poi.ss.formula"><code>ConditionalFormattingEvaluator</code></a>.</div> -</td> +<td class="colLast"> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.ValueAndFormat.html" title="class in org.apache.poi.ss.formula">EvaluationConditionalFormatRule.ValueAndFormat</a></td> Modified: poi/site/publish/apidocs/org/apache/poi/ss/formula/package-use.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/package-use.html?rev=1794154&r1=1794153&r2=1794154&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/package-use.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/package-use.html Sat May 6 14:51:28 2017 @@ -389,10 +389,7 @@ </td> </tr> <tr class="altColor"> -<td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/EvaluationConditionalFormatRule.html#org.apache.poi.ss.formula">EvaluationConditionalFormatRule</a> -<div class="block">Abstracted and cached version of a Conditional Format rule for use with a - <a href="../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html" title="class in org.apache.poi.ss.formula"><code>ConditionalFormattingEvaluator</code></a>.</div> -</td> +<td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/EvaluationConditionalFormatRule.html#org.apache.poi.ss.formula">EvaluationConditionalFormatRule</a> </td> </tr> <tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/EvaluationConditionalFormatRule.OperatorEnum.html#org.apache.poi.ss.formula">EvaluationConditionalFormatRule.OperatorEnum</a> @@ -617,6 +614,13 @@ </tr> <tbody> <tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/ConditionalFormattingEvaluator.html#org.apache.poi.ss.usermodel">ConditionalFormattingEvaluator</a> +<div class="block">Evaluates Conditional Formatting constraints.<p/> + + For performance reasons, this class keeps a cache of all previously evaluated rules and cells.</div> +</td> +</tr> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/FormulaParseException.html#org.apache.poi.ss.usermodel">FormulaParseException</a> <div class="block">This exception thrown when a supplied formula has incorrect syntax (or syntax currently not supported by POI).</div> Modified: poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ConditionalFormattingRule.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ConditionalFormattingRule.html?rev=1794154&r1=1794153&r2=1794154&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ConditionalFormattingRule.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ConditionalFormattingRule.html Sat May 6 14:51:28 2017 @@ -203,16 +203,20 @@ <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html#getMultiStateFormatting()">getMultiStateFormatting</a></strong>()</code> </td> </tr> <tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel">ExcelNumberFormat</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html#getNumberFormat()">getNumberFormat</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/PatternFormatting.html" title="interface in org.apache.poi.ss.usermodel">PatternFormatting</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html#getPatternFormatting()">getPatternFormatting</a></strong>()</code> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html#getPriority()">getPriority</a></strong>()</code> <div class="block">The priority of the rule, if defined, otherwise 0.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html#getStopIfTrue()">getStopIfTrue</a></strong>()</code> <div class="block">Always true for HSSF rules, optional flag for XSSF rules.</div> @@ -329,6 +333,16 @@ <dl><dt><span class="strong">Returns:</span></dt><dd>color scale / color grate formatting object if defined, <code>null</code> otherwise</dd></dl> </li> </ul> +<a name="getNumberFormat()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNumberFormat</h4> +<pre><a href="../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel">ExcelNumberFormat</a> getNumberFormat()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>number format defined for this rule, or null if the cell default should be used</dd></dl> +</li> +</ul> <a name="getConditionType()"> <!-- --> </a> Modified: poi/site/publish/apidocs/org/apache/poi/ss/usermodel/DataFormatter.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/usermodel/DataFormatter.html?rev=1794154&r1=1794153&r2=1794154&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/usermodel/DataFormatter.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/usermodel/DataFormatter.html Sat May 6 14:51:28 2017 @@ -260,6 +260,16 @@ implements java.util.Observer</pre> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/DataFormatter.html#formatCellValue(org.apache.poi.ss.usermodel.Cell,%20org.apache.poi.ss.usermodel.FormulaEvaluator,%20org.apache.poi.ss.formula.ConditionalFormattingEvaluator)">formatCellValue</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell, + <a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a> evaluator, + <a href="../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html" title="class in org.apache.poi.ss.formula">ConditionalFormattingEvaluator</a> cfEvaluator)</code> +<div class="block"> + Returns the formatted value of a cell as a <tt>String</tt> regardless + of the cell type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/DataFormatter.html#formatRawCellContents(double,%20int,%20java.lang.String)">formatRawCellContents</a></strong>(double value, int formatIndex, java.lang.String formatString)</code> @@ -267,7 +277,7 @@ implements java.util.Observer</pre> format index and string, according to excel style rules.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/DataFormatter.html#formatRawCellContents(double,%20int,%20java.lang.String,%20boolean)">formatRawCellContents</a></strong>(double value, int formatIndex, @@ -277,20 +287,20 @@ implements java.util.Observer</pre> format index and string, according to excel style rules.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>java.text.Format</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/DataFormatter.html#getDefaultFormat(org.apache.poi.ss.usermodel.Cell)">getDefaultFormat</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">Returns a default format for a cell.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>java.util.Observable</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/DataFormatter.html#getLocaleChangedObservable()">getLocaleChangedObservable</a></strong>()</code> <div class="block">If the Locale has been changed via <a href="../../../../../org/apache/poi/util/LocaleUtil.html#setUserLocale(java.util.Locale)"><code>LocaleUtil.setUserLocale(Locale)</code></a> the stored formats need to be refreshed.</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/ss/usermodel/DataFormatter.html#setDefaultNumberFormat(java.text.Format)">setDefaultNumberFormat</a></strong>(java.text.Format format)</code> <div class="block"> @@ -298,21 +308,21 @@ implements java.util.Observer</pre> parsed successfully.</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/ss/usermodel/DataFormatter.html#setExcelStyleRoundingMode(java.text.DecimalFormat)">setExcelStyleRoundingMode</a></strong>(java.text.DecimalFormat format)</code> <div class="block">Enables excel style rounding mode (round half up) on the Decimal Format given.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>static void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/DataFormatter.html#setExcelStyleRoundingMode(java.text.DecimalFormat,%20java.math.RoundingMode)">setExcelStyleRoundingMode</a></strong>(java.text.DecimalFormat format, java.math.RoundingMode roundingMode)</code> <div class="block">Enables custom rounding mode on the given Decimal Format.</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/ss/usermodel/DataFormatter.html#update(java.util.Observable,%20java.lang.Object)">update</a></strong>(java.util.Observable observable, java.lang.Object localeObj)</code> @@ -475,7 +485,7 @@ implements java.util.Observer</pre> <a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a> evaluator)</pre> <div class="block"><p> Returns the formatted value of a cell as a <tt>String</tt> regardless - of the cell type. If the Excel format pattern cannot be parsed then the + of the cell type. If the Excel number format pattern cannot be parsed then the cell value will be formatted using a default format. </p> <p>When passed a null or blank cell, this method will return an empty @@ -488,6 +498,39 @@ implements java.util.Observer</pre> <dt><span class="strong">Returns:</span></dt><dd>a string value of the cell</dd></dl> </li> </ul> +<a name="formatCellValue(org.apache.poi.ss.usermodel.Cell, org.apache.poi.ss.usermodel.FormulaEvaluator, org.apache.poi.ss.formula.ConditionalFormattingEvaluator)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>formatCellValue</h4> +<pre>public java.lang.String formatCellValue(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell, + <a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a> evaluator, + <a href="../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html" title="class in org.apache.poi.ss.formula">ConditionalFormattingEvaluator</a> cfEvaluator)</pre> +<div class="block"><p> + Returns the formatted value of a cell as a <tt>String</tt> regardless + of the cell type. If the Excel number format pattern cannot be parsed then the + cell value will be formatted using a default format. + </p> + <p>When passed a null or blank cell, this method will return an empty + String (""). Formula cells will be evaluated using the given + <a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel"><code>FormulaEvaluator</code></a> if the evaluator is non-null. If the + evaluator is null, then the formula String will be returned. The caller + is responsible for setting the currentRow on the evaluator +</p> + <p> + When a ConditionalFormattingEvaluator is present, it is checked first to see + if there is a number format to apply. If multiple rules apply, the last one is used. + If no ConditionalFormattingEvaluator is present, no rules apply, or the applied + rules do not define a format, the cell's style format is used. + </p> + <p> + The two evaluators should be from the same context, to avoid inconsistencies in cached values. +</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cell</code> - The cell (can be null)</dd><dd><code>evaluator</code> - The FormulaEvaluator (can be null)</dd><dd><code>cfEvaluator</code> - ConditionalFormattingEvaluator (can be null)</dd> +<dt><span class="strong">Returns:</span></dt><dd>a string value of the cell</dd></dl> +</li> +</ul> <a name="setDefaultNumberFormat(java.text.Format)"> <!-- --> </a> Modified: poi/site/publish/apidocs/org/apache/poi/ss/usermodel/DateUtil.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/usermodel/DateUtil.html?rev=1794154&r1=1794153&r2=1794154&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/usermodel/DateUtil.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/usermodel/DateUtil.html Sat May 6 14:51:28 2017 @@ -295,13 +295,20 @@ extends java.lang.Object</pre> </tr> <tr class="rowColor"> <td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/DateUtil.html#isADateFormat(org.apache.poi.ss.usermodel.ExcelNumberFormat)">isADateFormat</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel">ExcelNumberFormat</a> numFmt)</code> +<div class="block">Given a format ID and its format String, will check to see if the + format represents a date format or not.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/DateUtil.html#isADateFormat(int,%20java.lang.String)">isADateFormat</a></strong>(int formatIndex, java.lang.String formatString)</code> <div class="block">Given a format ID and its format String, will check to see if the format represents a date format or not.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>static boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/DateUtil.html#isCellDateFormatted(org.apache.poi.ss.usermodel.Cell)">isCellDateFormatted</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">Check if a cell contains a date @@ -309,6 +316,15 @@ extends java.lang.Object</pre> we infer it is a date if it is formatted as such.</div> </td> </tr> +<tr class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/DateUtil.html#isCellDateFormatted(org.apache.poi.ss.usermodel.Cell,%20org.apache.poi.ss.formula.ConditionalFormattingEvaluator)">isCellDateFormatted</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell, + <a href="../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html" title="class in org.apache.poi.ss.formula">ConditionalFormattingEvaluator</a> cfEvaluator)</code> +<div class="block">Check if a cell contains a date + Since dates are stored internally in Excel as double values + we infer it is a date if it is formatted as such.</div> +</td> +</tr> <tr class="rowColor"> <td class="colFirst"><code>static boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/DateUtil.html#isCellInternalDateFormatted(org.apache.poi.ss.usermodel.Cell)">isCellInternalDateFormatted</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> @@ -679,6 +695,24 @@ extends java.lang.Object</pre> <dt><span class="strong">Returns:</span></dt><dd>Java representation of the date, or null if date is not a valid Excel date</dd></dl> </li> </ul> +<a name="isADateFormat(org.apache.poi.ss.usermodel.ExcelNumberFormat)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isADateFormat</h4> +<pre>public static boolean isADateFormat(<a href="../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel">ExcelNumberFormat</a> numFmt)</pre> +<div class="block">Given a format ID and its format String, will check to see if the + format represents a date format or not. + Firstly, it will check to see if the format ID corresponds to an + internal excel date format (eg most US date formats) + If not, it will check to see if the format string only contains + date formatting characters (ymd-/), which covers most + non US date formats.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>numFmt</code> - The number format index and string expression, or null if not specified</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if it is a valid date format, false if not or null</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/ss/usermodel/DateUtil.html#isInternalDateFormat(int)"><code>isInternalDateFormat(int)</code></a></dd></dl> +</li> +</ul> <a name="isADateFormat(int, java.lang.String)"> <!-- --> </a> @@ -694,7 +728,8 @@ extends java.lang.Object</pre> If not, it will check to see if the format string only contains date formatting characters (ymd-/), which covers most non US date formats.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>formatIndex</code> - The index of the format, eg from ExtendedFormatRecord.getFormatIndex</dd><dd><code>formatString</code> - The format string, eg from FormatRecord.getFormatString</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/ss/usermodel/DateUtil.html#isInternalDateFormat(int)"><code>isInternalDateFormat(int)</code></a></dd></dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>formatIndex</code> - The index of the format, eg from ExtendedFormatRecord.getFormatIndex</dd><dd><code>formatString</code> - The format string, eg from FormatRecord.getFormatString</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if it is a valid date format, false if not or null</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/ss/usermodel/DateUtil.html#isInternalDateFormat(int)"><code>isInternalDateFormat(int)</code></a></dd></dl> </li> </ul> <a name="isInternalDateFormat(int)"> @@ -719,7 +754,26 @@ extends java.lang.Object</pre> <div class="block">Check if a cell contains a date Since dates are stored internally in Excel as double values we infer it is a date if it is formatted as such.</div> -<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/ss/usermodel/DateUtil.html#isADateFormat(int,%20java.lang.String)"><code>isADateFormat(int, String)</code></a>, +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cell</code> - </dd> +<dt><span class="strong">Returns:</span></dt><dd>true if it looks like a date</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/ss/usermodel/DateUtil.html#isADateFormat(int,%20java.lang.String)"><code>isADateFormat(int, String)</code></a>, +<a href="../../../../../org/apache/poi/ss/usermodel/DateUtil.html#isInternalDateFormat(int)"><code>isInternalDateFormat(int)</code></a></dd></dl> +</li> +</ul> +<a name="isCellDateFormatted(org.apache.poi.ss.usermodel.Cell, org.apache.poi.ss.formula.ConditionalFormattingEvaluator)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isCellDateFormatted</h4> +<pre>public static boolean isCellDateFormatted(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell, + <a href="../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html" title="class in org.apache.poi.ss.formula">ConditionalFormattingEvaluator</a> cfEvaluator)</pre> +<div class="block">Check if a cell contains a date + Since dates are stored internally in Excel as double values + we infer it is a date if it is formatted as such. + Format is determined from applicable conditional formatting, if + any, or cell style.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cell</code> - </dd><dd><code>cfEvaluator</code> - if available, or null</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if it looks like a date</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/ss/usermodel/DateUtil.html#isADateFormat(int,%20java.lang.String)"><code>isADateFormat(int, String)</code></a>, <a href="../../../../../org/apache/poi/ss/usermodel/DateUtil.html#isInternalDateFormat(int)"><code>isInternalDateFormat(int)</code></a></dd></dl> </li> </ul> Modified: poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ExcelGeneralNumberFormat.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ExcelGeneralNumberFormat.html?rev=1794154&r1=1794153&r2=1794154&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ExcelGeneralNumberFormat.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ExcelGeneralNumberFormat.html Sat May 6 14:51:28 2017 @@ -39,7 +39,7 @@ <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/poi/ss/usermodel/Drawing.html" title="interface in org.apache.poi.ss.usermodel"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/poi/ss/usermodel/ExcelStyleDateFormatter.html" title="class in org.apache.poi.ss.usermodel"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/poi/ss/usermodel/ExcelGeneralNumberFormat.html" target="_top">Frames</a></li> @@ -275,7 +275,7 @@ extends java.text.Format</pre> <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/poi/ss/usermodel/Drawing.html" title="interface in org.apache.poi.ss.usermodel"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/poi/ss/usermodel/ExcelStyleDateFormatter.html" title="class in org.apache.poi.ss.usermodel"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/poi/ss/usermodel/ExcelGeneralNumberFormat.html" target="_top">Frames</a></li> Added: poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ExcelNumberFormat.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ExcelNumberFormat.html?rev=1794154&view=auto ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ExcelNumberFormat.html (added) +++ poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ExcelNumberFormat.html Sat May 6 14:51:28 2017 @@ -0,0 +1,317 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<title>ExcelNumberFormat (POI API Documentation)</title> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ExcelNumberFormat (POI API Documentation)"; + } + } + catch(err) { + } +//--> +</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/ExcelNumberFormat.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/ss/usermodel/ExcelGeneralNumberFormat.html" title="class in org.apache.poi.ss.usermodel"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/poi/ss/usermodel/ExcelStyleDateFormatter.html" title="class in org.apache.poi.ss.usermodel"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/poi/ss/usermodel/ExcelNumberFormat.html" target="_top">Frames</a></li> +<li><a href="ExcelNumberFormat.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.ss.usermodel</div> +<h2 title="Class ExcelNumberFormat" class="title">Class ExcelNumberFormat</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.poi.ss.usermodel.ExcelNumberFormat</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">ExcelNumberFormat</span> +extends java.lang.Object</pre> +<div class="block">Object to hold a number format index and string, for various formatting evaluations</div> +</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/ss/usermodel/ExcelNumberFormat.html#ExcelNumberFormat(int,%20java.lang.String)">ExcelNumberFormat</a></strong>(int idx, + java.lang.String format)</code> +<div class="block">Use this carefully, prefer factory methods to ensure id/format relationships are not broken or confused.</div> +</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 <a href="../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel">ExcelNumberFormat</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html#from(org.apache.poi.ss.usermodel.Cell,%20org.apache.poi.ss.formula.ConditionalFormattingEvaluator)">from</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell, + <a href="../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html" title="class in org.apache.poi.ss.formula">ConditionalFormattingEvaluator</a> cfEvaluator)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel">ExcelNumberFormat</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html#from(org.apache.poi.ss.usermodel.CellStyle)">from</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/CellStyle.html" title="interface in org.apache.poi.ss.usermodel">CellStyle</a> style)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html#getFormat()">getFormat</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html#getIdx()">getIdx</a></strong>()</code> </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="ExcelNumberFormat(int, java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ExcelNumberFormat</h4> +<pre>public ExcelNumberFormat(int idx, + java.lang.String format)</pre> +<div class="block">Use this carefully, prefer factory methods to ensure id/format relationships are not broken or confused. + Left public so <a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html#getNumberFormat()"><code>ConditionalFormattingRule.getNumberFormat()</code></a> implementations can use it.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>idx</code> - Excel number format index, either a built-in or a higher custom # mapped in the workbook style table</dd><dd><code>format</code> - Excel number format string for the index</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="from(org.apache.poi.ss.usermodel.CellStyle)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>from</h4> +<pre>public static <a href="../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel">ExcelNumberFormat</a> from(<a href="../../../../../org/apache/poi/ss/usermodel/CellStyle.html" title="interface in org.apache.poi.ss.usermodel">CellStyle</a> style)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>style</code> - </dd> +<dt><span class="strong">Returns:</span></dt><dd>null if the style is null, instance from style data format values otherwise</dd></dl> +</li> +</ul> +<a name="from(org.apache.poi.ss.usermodel.Cell, org.apache.poi.ss.formula.ConditionalFormattingEvaluator)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>from</h4> +<pre>public static <a href="../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel">ExcelNumberFormat</a> from(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell, + <a href="../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html" title="class in org.apache.poi.ss.formula">ConditionalFormattingEvaluator</a> cfEvaluator)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cell</code> - cell to extract format from</dd><dd><code>cfEvaluator</code> - ConditionalFormattingEvaluator to use, or null if none in this context</dd> +<dt><span class="strong">Returns:</span></dt><dd>number format from highest-priority rule with a number format, or the cell style, or null if none of the above apply/are defined</dd></dl> +</li> +</ul> +<a name="getIdx()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIdx</h4> +<pre>public int getIdx()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>Excel number format index, either a built-in or a higher custom # mapped in the workbook style table</dd></dl> +</li> +</ul> +<a name="getFormat()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getFormat</h4> +<pre>public java.lang.String getFormat()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>Excel number format string for the index</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/ExcelNumberFormat.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/ss/usermodel/ExcelGeneralNumberFormat.html" title="class in org.apache.poi.ss.usermodel"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/poi/ss/usermodel/ExcelStyleDateFormatter.html" title="class in org.apache.poi.ss.usermodel"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/poi/ss/usermodel/ExcelNumberFormat.html" target="_top">Frames</a></li> +<li><a href="ExcelNumberFormat.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 2017 The Apache Software Foundation or + its licensors, as applicable.</i> + </small></p> +</body> +</html> Modified: poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ExcelStyleDateFormatter.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ExcelStyleDateFormatter.html?rev=1794154&r1=1794153&r2=1794154&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ExcelStyleDateFormatter.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ExcelStyleDateFormatter.html Sat May 6 14:51:28 2017 @@ -38,7 +38,7 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/poi/ss/usermodel/ExcelGeneralNumberFormat.html" title="class in org.apache.poi.ss.usermodel"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/poi/ss/usermodel/ExtendedColor.html" title="class in org.apache.poi.ss.usermodel"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> @@ -537,7 +537,7 @@ extends java.text.SimpleDateFormat</pre> </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/poi/ss/usermodel/ExcelGeneralNumberFormat.html" title="class in org.apache.poi.ss.usermodel"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/poi/ss/usermodel/ExtendedColor.html" title="class in org.apache.poi.ss.usermodel"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> Modified: poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/Cell.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/Cell.html?rev=1794154&r1=1794153&r2=1794154&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/Cell.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/Cell.html Sat May 6 14:51:28 2017 @@ -552,6 +552,21 @@ </td> </tr> <tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><span class="strong">DataFormatter.</span><code><strong><a href="../../../../../../org/apache/poi/ss/usermodel/DataFormatter.html#formatCellValue(org.apache.poi.ss.usermodel.Cell,%20org.apache.poi.ss.usermodel.FormulaEvaluator,%20org.apache.poi.ss.formula.ConditionalFormattingEvaluator)">formatCellValue</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell, + <a href="../../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a> evaluator, + <a href="../../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html" title="class in org.apache.poi.ss.formula">ConditionalFormattingEvaluator</a> cfEvaluator)</code> +<div class="block"> + Returns the formatted value of a cell as a <tt>String</tt> regardless + of the cell type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel">ExcelNumberFormat</a></code></td> +<td class="colLast"><span class="strong">ExcelNumberFormat.</span><code><strong><a href="../../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html#from(org.apache.poi.ss.usermodel.Cell,%20org.apache.poi.ss.formula.ConditionalFormattingEvaluator)">from</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell, + <a href="../../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html" title="class in org.apache.poi.ss.formula">ConditionalFormattingEvaluator</a> cfEvaluator)</code> </td> +</tr> +<tr class="rowColor"> <td class="colFirst"><code>java.text.Format</code></td> <td class="colLast"><span class="strong">DataFormatter.</span><code><strong><a href="../../../../../../org/apache/poi/ss/usermodel/DataFormatter.html#getDefaultFormat(org.apache.poi.ss.usermodel.Cell)">getDefaultFormat</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">Returns a default format for a cell.</div> @@ -567,39 +582,48 @@ </tr> <tr class="rowColor"> <td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><span class="strong">DateUtil.</span><code><strong><a href="../../../../../../org/apache/poi/ss/usermodel/DateUtil.html#isCellDateFormatted(org.apache.poi.ss.usermodel.Cell,%20org.apache.poi.ss.formula.ConditionalFormattingEvaluator)">isCellDateFormatted</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell, + <a href="../../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html" title="class in org.apache.poi.ss.formula">ConditionalFormattingEvaluator</a> cfEvaluator)</code> +<div class="block">Check if a cell contains a date + Since dates are stored internally in Excel as double values + we infer it is a date if it is formatted as such.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static boolean</code></td> <td class="colLast"><span class="strong">DateUtil.</span><code><strong><a href="../../../../../../org/apache/poi/ss/usermodel/DateUtil.html#isCellInternalDateFormatted(org.apache.poi.ss.usermodel.Cell)">isCellInternalDateFormatted</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">Check if a cell contains a date, checking only for internal excel date formats.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><span class="strong">FormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html#notifyDeleteCell(org.apache.poi.ss.usermodel.Cell)">notifyDeleteCell</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">Should be called to tell the cell value cache that the specified cell has just become a formula cell, or the formula text has changed</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><span class="strong">FormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html#notifySetFormula(org.apache.poi.ss.usermodel.Cell)">notifySetFormula</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">Should be called to tell the cell value cache that the specified (value or formula) cell has changed.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><span class="strong">FormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html#notifyUpdateCell(org.apache.poi.ss.usermodel.Cell)">notifyUpdateCell</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">Should be called to tell the cell value cache that the specified (value or formula) cell has changed.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../../../org/apache/poi/ss/usermodel/CellRange.html" title="interface in org.apache.poi.ss.usermodel">CellRange</a><? extends <a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a>></code></td> <td class="colLast"><span class="strong">Sheet.</span><code><strong><a href="../../../../../../org/apache/poi/ss/usermodel/Sheet.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="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><span class="strong">Row.</span><code><strong><a href="../../../../../../org/apache/poi/ss/usermodel/Row.html#removeCell(org.apache.poi.ss.usermodel.Cell)">removeCell</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 the Cell from this row.</div> Modified: poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/CellStyle.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/CellStyle.html?rev=1794154&r1=1794153&r2=1794154&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/CellStyle.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/CellStyle.html Sat May 6 14:51:28 2017 @@ -247,19 +247,23 @@ </td> </tr> <tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel">ExcelNumberFormat</a></code></td> +<td class="colLast"><span class="strong">ExcelNumberFormat.</span><code><strong><a href="../../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html#from(org.apache.poi.ss.usermodel.CellStyle)">from</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/CellStyle.html" title="interface in org.apache.poi.ss.usermodel">CellStyle</a> style)</code> </td> +</tr> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><span class="strong">Cell.</span><code><strong><a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html#setCellStyle(org.apache.poi.ss.usermodel.CellStyle)">setCellStyle</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/CellStyle.html" title="interface in org.apache.poi.ss.usermodel">CellStyle</a> style)</code> <div class="block">Set the style for the cell.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><span class="strong">Sheet.</span><code><strong><a href="../../../../../../org/apache/poi/ss/usermodel/Sheet.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"><span class="strong">Row.</span><code><strong><a href="../../../../../../org/apache/poi/ss/usermodel/Row.html#setRowStyle(org.apache.poi.ss.usermodel.CellStyle)">setRowStyle</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/CellStyle.html" title="interface in org.apache.poi.ss.usermodel">CellStyle</a> style)</code> <div class="block">Applies a whole-row cell styling to the row.</div> Added: poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/ExcelNumberFormat.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/ExcelNumberFormat.html?rev=1794154&view=auto ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/ExcelNumberFormat.html (added) +++ poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/ExcelNumberFormat.html Sat May 6 14:51:28 2017 @@ -0,0 +1,260 @@ +<!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.ss.usermodel.ExcelNumberFormat (POI API Documentation)</title> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Uses of Class org.apache.poi.ss.usermodel.ExcelNumberFormat (POI API Documentation)"; + } + } + catch(err) { + } +//--> +</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/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel">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/ss/usermodel/class-use/ExcelNumberFormat.html" target="_top">Frames</a></li> +<li><a href="ExcelNumberFormat.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.ss.usermodel.ExcelNumberFormat" class="title">Uses of Class<br>org.apache.poi.ss.usermodel.ExcelNumberFormat</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel">ExcelNumberFormat</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#org.apache.poi.hssf.usermodel">org.apache.poi.hssf.usermodel</a></td> +<td class="colLast"> +<div class="block">usermodel package maps HSSF low level strutures to familiar workbook/sheet model</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#org.apache.poi.ss.formula">org.apache.poi.ss.formula</a></td> +<td class="colLast"> +<div class="block">This package contains common internal POI code for manipulating formulas.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#org.apache.poi.ss.usermodel">org.apache.poi.ss.usermodel</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#org.apache.poi.xssf.usermodel">org.apache.poi.xssf.usermodel</a></td> +<td class="colLast"> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="org.apache.poi.hssf.usermodel"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel">ExcelNumberFormat</a> in <a href="../../../../../../org/apache/poi/hssf/usermodel/package-summary.html">org.apache.poi.hssf.usermodel</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../org/apache/poi/hssf/usermodel/package-summary.html">org.apache.poi.hssf.usermodel</a> that return <a href="../../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel">ExcelNumberFormat</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel">ExcelNumberFormat</a></code></td> +<td class="colLast"><span class="strong">HSSFConditionalFormattingRule.</span><code><strong><a href="../../../../../../org/apache/poi/hssf/usermodel/HSSFConditionalFormattingRule.html#getNumberFormat()">getNumberFormat</a></strong>()</code> +<div class="block">Always null for HSSF records, until someone figures out where to find it</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="org.apache.poi.ss.formula"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel">ExcelNumberFormat</a> in <a href="../../../../../../org/apache/poi/ss/formula/package-summary.html">org.apache.poi.ss.formula</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../org/apache/poi/ss/formula/package-summary.html">org.apache.poi.ss.formula</a> that return <a href="../../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel">ExcelNumberFormat</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel">ExcelNumberFormat</a></code></td> +<td class="colLast"><span class="strong">EvaluationConditionalFormatRule.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html#getNumberFormat()">getNumberFormat</a></strong>()</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="org.apache.poi.ss.usermodel"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel">ExcelNumberFormat</a> in <a href="../../../../../../org/apache/poi/ss/usermodel/package-summary.html">org.apache.poi.ss.usermodel</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../org/apache/poi/ss/usermodel/package-summary.html">org.apache.poi.ss.usermodel</a> that return <a href="../../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel">ExcelNumberFormat</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel">ExcelNumberFormat</a></code></td> +<td class="colLast"><span class="strong">ExcelNumberFormat.</span><code><strong><a href="../../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html#from(org.apache.poi.ss.usermodel.Cell,%20org.apache.poi.ss.formula.ConditionalFormattingEvaluator)">from</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell, + <a href="../../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html" title="class in org.apache.poi.ss.formula">ConditionalFormattingEvaluator</a> cfEvaluator)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel">ExcelNumberFormat</a></code></td> +<td class="colLast"><span class="strong">ExcelNumberFormat.</span><code><strong><a href="../../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html#from(org.apache.poi.ss.usermodel.CellStyle)">from</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/CellStyle.html" title="interface in org.apache.poi.ss.usermodel">CellStyle</a> style)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel">ExcelNumberFormat</a></code></td> +<td class="colLast"><span class="strong">ConditionalFormattingRule.</span><code><strong><a href="../../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html#getNumberFormat()">getNumberFormat</a></strong>()</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../org/apache/poi/ss/usermodel/package-summary.html">org.apache.poi.ss.usermodel</a> with parameters of type <a href="../../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel">ExcelNumberFormat</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><span class="strong">DateUtil.</span><code><strong><a href="../../../../../../org/apache/poi/ss/usermodel/DateUtil.html#isADateFormat(org.apache.poi.ss.usermodel.ExcelNumberFormat)">isADateFormat</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel">ExcelNumberFormat</a> numFmt)</code> +<div class="block">Given a format ID and its format String, will check to see if the + format represents a date format or not.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="org.apache.poi.xssf.usermodel"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel">ExcelNumberFormat</a> in <a href="../../../../../../org/apache/poi/xssf/usermodel/package-summary.html">org.apache.poi.xssf.usermodel</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../org/apache/poi/xssf/usermodel/package-summary.html">org.apache.poi.xssf.usermodel</a> that return <a href="../../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel">ExcelNumberFormat</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel">ExcelNumberFormat</a></code></td> +<td class="colLast"><span class="strong">XSSFConditionalFormattingRule.</span><code><strong><a href="../../../../../../org/apache/poi/xssf/usermodel/XSSFConditionalFormattingRule.html#getNumberFormat()">getNumberFormat</a></strong>()</code> +<div class="block">Return the number format from the dxf style record if present, null if not</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel">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/ss/usermodel/class-use/ExcelNumberFormat.html" target="_top">Frames</a></li> +<li><a href="ExcelNumberFormat.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 2017 The Apache Software Foundation or + its licensors, as applicable.</i> + </small></p> +</body> +</html> Modified: poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/FormulaEvaluator.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/FormulaEvaluator.html?rev=1794154&r1=1794153&r2=1794154&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/FormulaEvaluator.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/FormulaEvaluator.html Sat May 6 14:51:28 2017 @@ -228,6 +228,16 @@ of the cell type.</div> </td> </tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><span class="strong">DataFormatter.</span><code><strong><a href="../../../../../../org/apache/poi/ss/usermodel/DataFormatter.html#formatCellValue(org.apache.poi.ss.usermodel.Cell,%20org.apache.poi.ss.usermodel.FormulaEvaluator,%20org.apache.poi.ss.formula.ConditionalFormattingEvaluator)">formatCellValue</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell, + <a href="../../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a> evaluator, + <a href="../../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html" title="class in org.apache.poi.ss.formula">ConditionalFormattingEvaluator</a> cfEvaluator)</code> +<div class="block"> + Returns the formatted value of a cell as a <tt>String</tt> regardless + of the cell type.</div> +</td> +</tr> </tbody> </table> <table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> Modified: poi/site/publish/apidocs/org/apache/poi/ss/usermodel/package-frame.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/usermodel/package-frame.html?rev=1794154&r1=1794153&r2=1794154&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/usermodel/package-frame.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/usermodel/package-frame.html Sat May 6 14:51:28 2017 @@ -71,6 +71,7 @@ <li><a href="DataValidationConstraint.ValidationType.html" title="class in org.apache.poi.ss.usermodel" target="classFrame">DataValidationConstraint.ValidationType</a></li> <li><a href="DateUtil.html" title="class in org.apache.poi.ss.usermodel" target="classFrame">DateUtil</a></li> <li><a href="ExcelGeneralNumberFormat.html" title="class in org.apache.poi.ss.usermodel" target="classFrame">ExcelGeneralNumberFormat</a></li> +<li><a href="ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel" target="classFrame">ExcelNumberFormat</a></li> <li><a href="ExcelStyleDateFormatter.html" title="class in org.apache.poi.ss.usermodel" target="classFrame">ExcelStyleDateFormatter</a></li> <li><a href="ExtendedColor.html" title="class in org.apache.poi.ss.usermodel" target="classFrame">ExtendedColor</a></li> <li><a href="FractionFormat.html" title="class in org.apache.poi.ss.usermodel" target="classFrame">FractionFormat</a></li> Modified: poi/site/publish/apidocs/org/apache/poi/ss/usermodel/package-summary.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/usermodel/package-summary.html?rev=1794154&r1=1794153&r2=1794154&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/usermodel/package-summary.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/usermodel/package-summary.html Sat May 6 14:51:28 2017 @@ -424,6 +424,12 @@ </td> </tr> <tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel">ExcelNumberFormat</a></td> +<td class="colLast"> +<div class="block">Object to hold a number format index and string, for various formatting evaluations</div> +</td> +</tr> +<tr class="rowColor"> <td class="colFirst"><a href="../../../../../org/apache/poi/ss/usermodel/ExcelStyleDateFormatter.html" title="class in org.apache.poi.ss.usermodel">ExcelStyleDateFormatter</a></td> <td class="colLast"> <div class="block">A wrapper around a <code>SimpleDateFormat</code> instance, @@ -431,7 +437,7 @@ are not supported by <code>SimpleDateFormat</code>.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="../../../../../org/apache/poi/ss/usermodel/ExtendedColor.html" title="class in org.apache.poi.ss.usermodel">ExtendedColor</a></td> <td class="colLast"> <div class="block">Represents a XSSF-style color (based on either a @@ -439,19 +445,19 @@ <a href="../../../../../org/apache/poi/hssf/record/common/ExtendedColor.html" title="class in org.apache.poi.hssf.record.common"><code>ExtendedColor</code></a></div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="../../../../../org/apache/poi/ss/usermodel/FractionFormat.html" title="class in org.apache.poi.ss.usermodel">FractionFormat</a></td> <td class="colLast"> <div class="block">Format class that handles Excel style fractions, such as "# #/#" and "#/###"</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="../../../../../org/apache/poi/ss/usermodel/ShapeTypes.html" title="class in org.apache.poi.ss.usermodel">ShapeTypes</a></td> <td class="colLast"> <div class="block">All known types of automatic shapes in DrawingML</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="../../../../../org/apache/poi/ss/usermodel/WorkbookFactory.html" title="class in org.apache.poi.ss.usermodel">WorkbookFactory</a></td> <td class="colLast"> <div class="block">Factory for creating the appropriate kind of Workbook Modified: poi/site/publish/apidocs/org/apache/poi/ss/usermodel/package-tree.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/usermodel/package-tree.html?rev=1794154&r1=1794153&r2=1794154&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/usermodel/package-tree.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/usermodel/package-tree.html Sat May 6 14:51:28 2017 @@ -87,6 +87,7 @@ <li type="circle">org.apache.poi.ss.usermodel.<a href="../../../../../org/apache/poi/ss/usermodel/DataValidationConstraint.OperatorType.html" title="class in org.apache.poi.ss.usermodel"><span class="strong">DataValidationConstraint.OperatorType</span></a></li> <li type="circle">org.apache.poi.ss.usermodel.<a href="../../../../../org/apache/poi/ss/usermodel/DataValidationConstraint.ValidationType.html" title="class in org.apache.poi.ss.usermodel"><span class="strong">DataValidationConstraint.ValidationType</span></a></li> <li type="circle">org.apache.poi.ss.usermodel.<a href="../../../../../org/apache/poi/ss/usermodel/DateUtil.html" title="class in org.apache.poi.ss.usermodel"><span class="strong">DateUtil</span></a></li> +<li type="circle">org.apache.poi.ss.usermodel.<a href="../../../../../org/apache/poi/ss/usermodel/ExcelNumberFormat.html" title="class in org.apache.poi.ss.usermodel"><span class="strong">ExcelNumberFormat</span></a></li> <li type="circle">org.apache.poi.ss.usermodel.<a href="../../../../../org/apache/poi/ss/usermodel/ExtendedColor.html" title="class in org.apache.poi.ss.usermodel"><span class="strong">ExtendedColor</span></a> (implements org.apache.poi.ss.usermodel.<a href="../../../../../org/apache/poi/ss/usermodel/Color.html" title="interface in org.apache.poi.ss.usermodel">Color</a>)</li> <li type="circle">java.text.Format (implements java.lang.Cloneable, java.io.Serializable) <ul> --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
