Modified: poi/site/publish/apidocs/org/apache/poi/ss/util/CellRangeAddress.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/util/CellRangeAddress.html?rev=1782942&r1=1782941&r2=1782942&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/util/CellRangeAddress.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/util/CellRangeAddress.html Tue Feb 14 09:47:17 2017 @@ -208,7 +208,7 @@ extends <a href="../../../../../org/apac <!-- --> </a> <h3>Methods inherited from class org.apache.poi.ss.util.<a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html" title="class in org.apache.poi.ss.util">CellRangeAddressBase</a></h3> -<code><a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#containsColumn(int)">containsColumn</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#containsRow(int)">containsRow</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#equals(java.lang.Object)">equals</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#getFirstColumn()">getFirstColumn</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#getFirstRow()">getFirstRow</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#getLastColumn()">getLastColumn</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#getLastRow()">getLastRow</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#getMaxColumn()">getMaxColumn</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#getMaxRow()">getMaxRow</a>, <a href="../../../../. ./org/apache/poi/ss/util/CellRangeAddressBase.html#getMinColumn()">getMinColumn</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#getMinRow()">getMinRow</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#getNumberOfCells()">getNumberOfCells</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#hashCode()">hashCode</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#intersects(org.apache.poi.ss.util.CellRangeAddressBase)">intersects</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#isFullColumnRange()">isFullColumnRange</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#isFullRowRange()">isFullRowRange</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#isInRange(int,%20int)">isInRange</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#setFirstColumn(int)">setFirstColumn</a> , <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#setFirstRow(int)">setFirstRow</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#setLastColumn(int)">setLastColumn</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#setLastRow(int)">setLastRow</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#toString()">toString</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#validate(org.apache.poi.ss.SpreadsheetVersion)">validate</a></code></li> +<code><a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#containsColumn(int)">containsColumn</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#containsRow(int)">containsRow</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#equals(java.lang.Object)">equals</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#getFirstColumn()">getFirstColumn</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#getFirstRow()">getFirstRow</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#getLastColumn()">getLastColumn</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#getLastRow()">getLastRow</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#getMaxColumn()">getMaxColumn</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#getMaxRow()">getMaxRow</a>, <a href="../../../../. ./org/apache/poi/ss/util/CellRangeAddressBase.html#getMinColumn()">getMinColumn</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#getMinRow()">getMinRow</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#getNumberOfCells()">getNumberOfCells</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#hashCode()">hashCode</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#intersects(org.apache.poi.ss.util.CellRangeAddressBase)">intersects</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#isFullColumnRange()">isFullColumnRange</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#isFullRowRange()">isFullRowRange</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#isInRange(org.apache.poi.ss.usermodel.Cell)">isInRange</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#isInRange(org.apa che.poi.ss.util.CellReference)">isInRange</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#isInRange(int,%20int)">isInRange</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#setFirstColumn(int)">setFirstColumn</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#setFirstRow(int)">setFirstRow</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#setLastColumn(int)">setLastColumn</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#setLastRow(int)">setLastRow</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#toString()">toString</a>, <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#validate(org.apache.poi.ss.SpreadsheetVersion)">validate</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
Modified: poi/site/publish/apidocs/org/apache/poi/ss/util/CellRangeAddressBase.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/util/CellRangeAddressBase.html?rev=1782942&r1=1782941&r2=1782942&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/util/CellRangeAddressBase.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/util/CellRangeAddressBase.html Tue Feb 14 09:47:17 2017 @@ -219,6 +219,20 @@ extends java.lang.Object</pre> </tr> <tr class="altColor"> <td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#isInRange(org.apache.poi.ss.usermodel.Cell)">isInRange</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">Determines if the given <a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel"><code>Cell</code></a> lies within the bounds + of this range.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#isInRange(org.apache.poi.ss.util.CellReference)">isInRange</a></strong>(<a href="../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a> ref)</code> +<div class="block">Determines if the given <a href="../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util"><code>CellReference</code></a> lies within the bounds + of this range.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#isInRange(int,%20int)">isInRange</a></strong>(int rowInd, int colInd)</code> <div class="block">Determines if the given coordinates lie within the bounds @@ -378,6 +392,36 @@ extends java.lang.Object</pre> <dt><span class="strong">Returns:</span></dt><dd>True if the coordinates lie within the bounds, false otherwise.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#intersects(org.apache.poi.ss.util.CellRangeAddressBase)"><code>for checking if two ranges overlap</code></a></dd></dl> </li> </ul> +<a name="isInRange(org.apache.poi.ss.util.CellReference)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isInRange</h4> +<pre>public boolean isInRange(<a href="../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a> ref)</pre> +<div class="block">Determines if the given <a href="../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util"><code>CellReference</code></a> lies within the bounds + of this range. + <p/>NOTE: It is up to the caller to ensure the reference is + for the correct sheet, since this instance doesn't have a sheet reference.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ref</code> - the CellReference to check</dd> +<dt><span class="strong">Returns:</span></dt><dd>True if the reference lies within the bounds, false otherwise.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#intersects(org.apache.poi.ss.util.CellRangeAddressBase)"><code>for checking if two ranges overlap</code></a></dd></dl> +</li> +</ul> +<a name="isInRange(org.apache.poi.ss.usermodel.Cell)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isInRange</h4> +<pre>public boolean isInRange(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</pre> +<div class="block">Determines if the given <a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel"><code>Cell</code></a> lies within the bounds + of this range. + <p/>NOTE: It is up to the caller to ensure the reference is + for the correct sheet, since this instance doesn't have a sheet reference.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cell</code> - the Cell to check</dd> +<dt><span class="strong">Returns:</span></dt><dd>True if the cell lies within the bounds, false otherwise.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#intersects(org.apache.poi.ss.util.CellRangeAddressBase)"><code>for checking if two ranges overlap</code></a></dd></dl> +</li> +</ul> <a name="containsRow(int)"> <!-- --> </a> Modified: poi/site/publish/apidocs/org/apache/poi/ss/util/SheetUtil.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/util/SheetUtil.html?rev=1782942&r1=1782941&r2=1782942&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/util/SheetUtil.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/util/SheetUtil.html Tue Feb 14 09:47:17 2017 @@ -156,6 +156,14 @@ extends java.lang.Object</pre> </td> </tr> <tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/SheetUtil.html#getCell(org.apache.poi.ss.usermodel.Sheet,%20int,%20int)">getCell</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Sheet.html" title="interface in org.apache.poi.ss.usermodel">Sheet</a> sheet, + int rowIx, + int colIx)</code> +<div class="block">Return the cell, without taking account of merged regions.</div> +</td> +</tr> +<tr class="rowColor"> <td class="colFirst"><code>static double</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/SheetUtil.html#getCellWidth(org.apache.poi.ss.usermodel.Cell,%20int,%20org.apache.poi.ss.usermodel.DataFormatter,%20boolean)">getCellWidth</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell, int defaultCharWidth, @@ -164,7 +172,7 @@ extends java.lang.Object</pre> <div class="block">Compute width of a single cell</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/SheetUtil.html#getCellWithMerges(org.apache.poi.ss.usermodel.Sheet,%20int,%20int)">getCellWithMerges</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Sheet.html" title="interface in org.apache.poi.ss.usermodel">Sheet</a> sheet, int rowIx, @@ -172,7 +180,7 @@ extends java.lang.Object</pre> <div class="block">Return the cell, taking account of merged regions.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>static double</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/SheetUtil.html#getColumnWidth(org.apache.poi.ss.usermodel.Sheet,%20int,%20boolean)">getColumnWidth</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Sheet.html" title="interface in org.apache.poi.ss.usermodel">Sheet</a> sheet, int column, @@ -180,7 +188,7 @@ extends java.lang.Object</pre> <div class="block">Compute width of a column and return the result</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>static double</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/SheetUtil.html#getColumnWidth(org.apache.poi.ss.usermodel.Sheet,%20int,%20boolean,%20int,%20int)">getColumnWidth</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Sheet.html" title="interface in org.apache.poi.ss.usermodel">Sheet</a> sheet, int column, @@ -190,7 +198,7 @@ extends java.lang.Object</pre> <div class="block">Compute width of a column based on a subset of the rows and return the result</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/SheetUtil.html#getDefaultCharWidth(org.apache.poi.ss.usermodel.Workbook)">getDefaultCharWidth</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a> wb)</code> <div class="block">Get default character width using the Workbook's default font</div> @@ -327,6 +335,28 @@ public static boolean contains <dt><span class="strong">Returns:</span></dt><dd>true if the range contains the cell [rowIx, colIx]</dd></dl> </li> </ul> +<a name="getCell(org.apache.poi.ss.usermodel.Sheet, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCell</h4> +<pre>public static <a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> getCell(<a href="../../../../../org/apache/poi/ss/usermodel/Sheet.html" title="interface in org.apache.poi.ss.usermodel">Sheet</a> sheet, + int rowIx, + int colIx)</pre> +<div class="block">Return the cell, without taking account of merged regions. + <p/> + Use <a href="../../../../../org/apache/poi/ss/util/SheetUtil.html#getCellWithMerges(org.apache.poi.ss.usermodel.Sheet,%20int,%20int)"><code>getCellWithMerges(Sheet, int, int)</code></a> if you want the top left + cell from merged regions instead when the reference is a merged cell. + <p/> + Use this where you want to know if the given cell is explicitly defined + or not.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sheet</code> - </dd><dd><code>rowIx</code> - </dd><dd><code>colIx</code> - </dd> +<dt><span class="strong">Returns:</span></dt><dd>cell at the given location, or null if not defined</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.NullPointerException</code> - if sheet is null</dd></dl> +</li> +</ul> <a name="getCellWithMerges(org.apache.poi.ss.usermodel.Sheet, int, int)"> <!-- --> </a> @@ -345,6 +375,10 @@ public static boolean contains then will return the cell itself. <p>If there is no cell defined at the given co-ordinates, will return null.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sheet</code> - </dd><dd><code>rowIx</code> - </dd><dd><code>colIx</code> - </dd> +<dt><span class="strong">Returns:</span></dt><dd>cell at the given location, its base merged cell, or null if not defined</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.NullPointerException</code> - if sheet is null</dd></dl> </li> </ul> </li> Modified: poi/site/publish/apidocs/org/apache/poi/ss/util/class-use/CellRangeAddress.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/util/class-use/CellRangeAddress.html?rev=1782942&r1=1782941&r2=1782942&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/util/class-use/CellRangeAddress.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/util/class-use/CellRangeAddress.html Tue Feb 14 09:47:17 2017 @@ -117,34 +117,40 @@ HSSF concepts.</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="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="#org.apache.poi.ss.usermodel.charts">org.apache.poi.ss.usermodel.charts</a></td> <td class="colLast"> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="#org.apache.poi.ss.usermodel.helpers">org.apache.poi.ss.usermodel.helpers</a></td> <td class="colLast"> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="#org.apache.poi.ss.util">org.apache.poi.ss.util</a></td> <td class="colLast"> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="#org.apache.poi.ss.util.cellwalk">org.apache.poi.ss.util.cellwalk</a></td> <td class="colLast"> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="#org.apache.poi.xssf.streaming">org.apache.poi.xssf.streaming</a></td> <td class="colLast"> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="#org.apache.poi.xssf.usermodel">org.apache.poi.xssf.usermodel</a></td> <td class="colLast"> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="#org.apache.poi.xssf.usermodel.helpers">org.apache.poi.xssf.usermodel.helpers</a></td> <td class="colLast"> </td> </tr> @@ -611,6 +617,41 @@ HSSF concepts.</div> </tr> </tbody> </table> +</li> +<li class="blockList"><a name="org.apache.poi.ss.formula"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/poi/ss/util/CellRangeAddress.html" title="class in org.apache.poi.ss.util">CellRangeAddress</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/util/CellRangeAddress.html" title="class in org.apache.poi.ss.util">CellRangeAddress</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/util/CellRangeAddress.html" title="class in org.apache.poi.ss.util">CellRangeAddress</a>[]</code></td> +<td class="colLast"><span class="strong">EvaluationConditionalFormatRule.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html#getRegions()">getRegions</a></strong>()</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../../org/apache/poi/ss/formula/package-summary.html">org.apache.poi.ss.formula</a> with parameters of type <a href="../../../../../../org/apache/poi/ss/util/CellRangeAddress.html" title="class in org.apache.poi.ss.util">CellRangeAddress</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html#EvaluationConditionalFormatRule(org.apache.poi.ss.formula.WorkbookEvaluator,%20org.apache.poi.ss.usermodel.Sheet,%20org.apache.poi.ss.usermodel.ConditionalFormatting,%20int,%20org.apache.poi.ss.usermodel.ConditionalFormattingRule,%20int,%20org.apache.poi.ss.util.CellRangeAddress[])">EvaluationConditionalFormatRule</a></strong>(<a href="../../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html" title="class in org.apache.poi.ss.formula">WorkbookEvaluator</a> workbookEvaluator, + <a href="../../../../../../org/apache/poi/ss/usermodel/Sheet.html" title="interface in org.apache.poi.ss.usermodel">Sheet</a> sheet, + <a href="../../../../../../org/apache/poi/ss/usermodel/ConditionalFormatting.html" title="interface in org.apache.poi.ss.usermodel">ConditionalFormatting</a> formatting, + int formattingIndex, + <a href="../../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html" title="interface in org.apache.poi.ss.usermodel">ConditionalFormattingRule</a> rule, + int ruleIndex, + <a href="../../../../../../org/apache/poi/ss/util/CellRangeAddress.html" title="class in org.apache.poi.ss.util">CellRangeAddress</a>[] regions)</code> </td> +</tr> +</tbody> +</table> </li> <li class="blockList"><a name="org.apache.poi.ss.usermodel"> <!-- --> Modified: poi/site/publish/apidocs/org/apache/poi/ss/util/class-use/CellRangeAddressBase.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/util/class-use/CellRangeAddressBase.html?rev=1782942&r1=1782941&r2=1782942&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/util/class-use/CellRangeAddressBase.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/util/class-use/CellRangeAddressBase.html Tue Feb 14 09:47:17 2017 @@ -91,6 +91,12 @@ HSSF concepts.</div> </td> </tr> <tr class="altColor"> +<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="rowColor"> <td class="colFirst"><a href="#org.apache.poi.ss.util">org.apache.poi.ss.util</a></td> <td class="colLast"> </td> </tr> @@ -159,6 +165,65 @@ HSSF concepts.</div> </tr> </tbody> </table> +</li> +<li class="blockList"><a name="org.apache.poi.ss.formula"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html" title="class in org.apache.poi.ss.util">CellRangeAddressBase</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/util/CellRangeAddressBase.html" title="class in org.apache.poi.ss.util">CellRangeAddressBase</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/util/CellRangeAddressBase.html" title="class in org.apache.poi.ss.util">CellRangeAddressBase</a></code></td> +<td class="colLast"><span class="strong">DataValidationEvaluator.DataValidationContext.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.DataValidationContext.html#getRegion()">getRegion</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/formula/package-summary.html">org.apache.poi.ss.formula</a> with parameters of type <a href="../../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html" title="class in org.apache.poi.ss.util">CellRangeAddressBase</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>protected boolean</code></td> +<td class="colLast"><span class="strong">WorkbookEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html#adjustRegionRelativeReference(org.apache.poi.ss.formula.ptg.Ptg[],%20org.apache.poi.ss.util.CellReference,%20org.apache.poi.ss.util.CellRangeAddressBase)">adjustRegionRelativeReference</a></strong>(<a href="../../../../../../org/apache/poi/ss/formula/ptg/Ptg.html" title="class in org.apache.poi.ss.formula.ptg">Ptg</a>[] ptgs, + <a href="../../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a> target, + <a href="../../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html" title="class in org.apache.poi.ss.util">CellRangeAddressBase</a> region)</code> +<div class="block">Adjust formula relative references by the offset between the start of the given region and the given target cell.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/poi/ss/formula/eval/ValueEval.html" title="interface in org.apache.poi.ss.formula.eval">ValueEval</a></code></td> +<td class="colLast"><span class="strong">WorkbookEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html#evaluate(java.lang.String,%20org.apache.poi.ss.util.CellReference,%20org.apache.poi.ss.util.CellRangeAddressBase)">evaluate</a></strong>(java.lang.String formula, + <a href="../../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a> target, + <a href="../../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html" title="class in org.apache.poi.ss.util">CellRangeAddressBase</a> region)</code> +<div class="block">Some expressions need to be evaluated in terms of an offset from the top left corner of a region, + such as some data validation and conditional format expressions, when those constraints apply + to contiguous cells.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../../org/apache/poi/ss/formula/package-summary.html">org.apache.poi.ss.formula</a> with parameters of type <a href="../../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html" title="class in org.apache.poi.ss.util">CellRangeAddressBase</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.DataValidationContext.html#DataValidationEvaluator.DataValidationContext(org.apache.poi.ss.usermodel.DataValidation,%20org.apache.poi.ss.formula.DataValidationEvaluator,%20org.apache.poi.ss.util.CellRangeAddressBase,%20org.apache.poi.ss.util.CellReference)">DataValidationEvaluator.DataValidationContext</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/DataValidation.html" title="interface in org.apache.poi.ss.usermodel">DataValidation</a> dv, + <a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.html" title="class in org.apache.poi.ss.formula">DataValidationEvaluator</a> dve, + <a href="../../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html" title="class in org.apache.poi.ss.util">CellRangeAddressBase</a> region, + <a href="../../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a> target)</code> </td> +</tr> +</tbody> +</table> </li> <li class="blockList"><a name="org.apache.poi.ss.util"> <!-- --> Modified: poi/site/publish/apidocs/org/apache/poi/ss/util/class-use/CellReference.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/util/class-use/CellReference.html?rev=1782942&r1=1782941&r2=1782942&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/util/class-use/CellReference.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/util/class-use/CellReference.html Tue Feb 14 09:47:17 2017 @@ -215,6 +215,14 @@ HSSF concepts.</div> if this formula belongs to such a grouping.</div> </td> </tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a></code></td> +<td class="colLast"><span class="strong">ConditionalFormattingEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html#getRef(org.apache.poi.ss.usermodel.Cell)">getRef</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a></code></td> +<td class="colLast"><span class="strong">DataValidationEvaluator.DataValidationContext.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.DataValidationContext.html#getTarget()">getTarget</a></strong>()</code> </td> +</tr> </tbody> </table> <table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> @@ -225,12 +233,84 @@ HSSF concepts.</div> </tr> <tbody> <tr class="altColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><span class="strong">WorkbookEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html#adjustRegionRelativeReference(org.apache.poi.ss.formula.ptg.Ptg[],%20org.apache.poi.ss.util.CellReference,%20org.apache.poi.ss.util.CellRangeAddressBase)">adjustRegionRelativeReference</a></strong>(<a href="../../../../../../org/apache/poi/ss/formula/ptg/Ptg.html" title="class in org.apache.poi.ss.formula.ptg">Ptg</a>[] ptgs, + <a href="../../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a> target, + <a href="../../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html" title="class in org.apache.poi.ss.util">CellRangeAddressBase</a> region)</code> +<div class="block">Adjust formula relative references by the offset between the start of the given region and the given target cell.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/poi/ss/formula/eval/ValueEval.html" title="interface in org.apache.poi.ss.formula.eval">ValueEval</a></code></td> +<td class="colLast"><span class="strong">WorkbookEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html#evaluate(java.lang.String,%20org.apache.poi.ss.util.CellReference)">evaluate</a></strong>(java.lang.String formula, + <a href="../../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a> ref)</code> +<div class="block">Evaluate a formula outside a cell value, e.g.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/poi/ss/formula/eval/ValueEval.html" title="interface in org.apache.poi.ss.formula.eval">ValueEval</a></code></td> +<td class="colLast"><span class="strong">WorkbookEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html#evaluate(java.lang.String,%20org.apache.poi.ss.util.CellReference,%20org.apache.poi.ss.util.CellRangeAddressBase)">evaluate</a></strong>(java.lang.String formula, + <a href="../../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a> target, + <a href="../../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html" title="class in org.apache.poi.ss.util">CellRangeAddressBase</a> region)</code> +<div class="block">Some expressions need to be evaluated in terms of an offset from the top left corner of a region, + such as some data validation and conditional format expressions, when those constraints apply + to contiguous cells.</div> +</td> +</tr> +<tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../../org/apache/poi/ss/formula/ptg/Ptg.html" title="class in org.apache.poi.ss.formula.ptg">Ptg</a></code></td> <td class="colLast"><span class="strong">FormulaParsingWorkbook.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/FormulaParsingWorkbook.html#get3DReferencePtg(org.apache.poi.ss.util.CellReference,%20org.apache.poi.ss.formula.SheetIdentifier)">get3DReferencePtg</a></strong>(<a href="../../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a> cell, <a href="../../../../../../org/apache/poi/ss/formula/SheetIdentifier.html" title="class in org.apache.poi.ss.formula">SheetIdentifier</a> sheet)</code> <div class="block">Produce the appropriate Ptg for a 3d cell reference</div> </td> </tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html" title="class in org.apache.poi.ss.formula">EvaluationConditionalFormatRule</a>></code></td> +<td class="colLast"><span class="strong">ConditionalFormattingEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html#getConditionalFormattingForCell(org.apache.poi.ss.util.CellReference)">getConditionalFormattingForCell</a></strong>(<a href="../../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a> cellRef)</code> +<div class="block">This checks all applicable <a href="../../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html" title="interface in org.apache.poi.ss.usermodel"><code>ConditionalFormattingRule</code></a>s for the cell's sheet, + in defined "priority" order, returning the matches if any.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.DataValidationContext.html" title="class in org.apache.poi.ss.formula">DataValidationEvaluator.DataValidationContext</a></code></td> +<td class="colLast"><span class="strong">DataValidationEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.html#getValidationContextForCell(org.apache.poi.ss.util.CellReference)">getValidationContextForCell</a></strong>(<a href="../../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a> cell)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/poi/ss/usermodel/DataValidation.html" title="interface in org.apache.poi.ss.usermodel">DataValidation</a></code></td> +<td class="colLast"><span class="strong">DataValidationEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.html#getValidationForCell(org.apache.poi.ss.util.CellReference)">getValidationForCell</a></strong>(<a href="../../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a> cell)</code> +<div class="block">Finds and returns the <a href="../../../../../../org/apache/poi/ss/usermodel/DataValidation.html" title="interface in org.apache.poi.ss.usermodel"><code>DataValidation</code></a> for the cell, if there is + one.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../../../org/apache/poi/ss/formula/eval/ValueEval.html" title="interface in org.apache.poi.ss.formula.eval">ValueEval</a>></code></td> +<td class="colLast"><span class="strong">DataValidationEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.html#getValidationValuesForCell(org.apache.poi.ss.util.CellReference)">getValidationValuesForCell</a></strong>(<a href="../../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a> cell)</code> +<div class="block">If <a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.html#getValidationForCell(org.apache.poi.ss.util.CellReference)"><code>DataValidationEvaluator.getValidationForCell(CellReference)</code></a> returns an instance, and the + <a href="../../../../../../org/apache/poi/ss/usermodel/DataValidationConstraint.ValidationType.html" title="class in org.apache.poi.ss.usermodel"><code>DataValidationConstraint.ValidationType</code></a> is <a href="../../../../../../org/apache/poi/ss/usermodel/DataValidationConstraint.ValidationType.html#LIST"><code>DataValidationConstraint.ValidationType.LIST</code></a>, return the valid + values, whether they are from a static list or cell range.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">DataValidationEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.html#isValidCell(org.apache.poi.ss.util.CellReference)">isValidCell</a></strong>(<a href="../../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a> cellRef)</code> +<div class="block">Use the validation returned by <a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.html#getValidationForCell(org.apache.poi.ss.util.CellReference)"><code>DataValidationEvaluator.getValidationForCell(CellReference)</code></a> if you + want the error display details.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../../org/apache/poi/ss/formula/package-summary.html">org.apache.poi.ss.formula</a> with parameters of type <a href="../../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.DataValidationContext.html#DataValidationEvaluator.DataValidationContext(org.apache.poi.ss.usermodel.DataValidation,%20org.apache.poi.ss.formula.DataValidationEvaluator,%20org.apache.poi.ss.util.CellRangeAddressBase,%20org.apache.poi.ss.util.CellReference)">DataValidationEvaluator.DataValidationContext</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/DataValidation.html" title="interface in org.apache.poi.ss.usermodel">DataValidation</a> dv, + <a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.html" title="class in org.apache.poi.ss.formula">DataValidationEvaluator</a> dve, + <a href="../../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html" title="class in org.apache.poi.ss.util">CellRangeAddressBase</a> region, + <a href="../../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a> target)</code> </td> +</tr> </tbody> </table> </li> @@ -337,6 +417,13 @@ HSSF concepts.</div> </tr> <tbody> <tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">CellRangeAddressBase.</span><code><strong><a href="../../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#isInRange(org.apache.poi.ss.util.CellReference)">isInRange</a></strong>(<a href="../../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a> ref)</code> +<div class="block">Determines if the given <a href="../../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util"><code>CellReference</code></a> lies within the bounds + of this range.</div> +</td> +</tr> +<tr class="rowColor"> <td class="colFirst"><code>static boolean</code></td> <td class="colLast"><span class="strong">AreaReference.</span><code><strong><a href="../../../../../../org/apache/poi/ss/util/AreaReference.html#isWholeColumnReference(org.apache.poi.ss.SpreadsheetVersion,%20org.apache.poi.ss.util.CellReference,%20org.apache.poi.ss.util.CellReference)">isWholeColumnReference</a></strong>(<a href="../../../../../../org/apache/poi/ss/SpreadsheetVersion.html" title="enum in org.apache.poi.ss">SpreadsheetVersion</a> version, <a href="../../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a> topLeft, Modified: poi/site/publish/apidocs/org/apache/poi/ss/util/package-use.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/util/package-use.html?rev=1782942&r1=1782941&r2=1782942&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/util/package-use.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/util/package-use.html Tue Feb 14 09:47:17 2017 @@ -384,6 +384,18 @@ HSSF concepts.</div> <td class="colOne"><a href="../../../../../org/apache/poi/ss/util/class-use/AreaReference.html#org.apache.poi.ss.formula">AreaReference</a> </td> </tr> <tr class="rowColor"> +<td class="colOne"><a href="../../../../../org/apache/poi/ss/util/class-use/CellRangeAddress.html#org.apache.poi.ss.formula">CellRangeAddress</a> +<div class="block">See OOO documentation: excelfileformat.pdf sec 2.5.14 - 'Cell Range Address'<p/></div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/poi/ss/util/class-use/CellRangeAddressBase.html#org.apache.poi.ss.formula">CellRangeAddressBase</a> +<div class="block">See OOO documentation: excelfileformat.pdf sec 2.5.14 - 'Cell Range Address'<p/> + + Common superclass of 8-bit and 16-bit versions</div> +</td> +</tr> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/util/class-use/CellReference.html#org.apache.poi.ss.formula">CellReference</a> <div class="block">Common conversion functions between Excel style A1, C27 style cell references, and POI usermodel style row=0, column=0 Modified: poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.html?rev=1782942&r1=1782941&r2=1782942&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.html Tue Feb 14 09:47:17 2017 @@ -735,6 +735,8 @@ public int getExternalSheetInd max column and row numbers, max arguments to a function, etc.)</div> <dl> <dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html#getSpreadsheetVersion()">getSpreadsheetVersion</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html" title="interface in org.apache.poi.ss.formula">EvaluationWorkbook</a></code></dd> +<dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/poi/ss/formula/FormulaParsingWorkbook.html#getSpreadsheetVersion()">getSpreadsheetVersion</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/formula/FormulaParsingWorkbook.html" title="interface in org.apache.poi.ss.formula">FormulaParsingWorkbook</a></code></dd> </dl> </li> Added: poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFConditionFilterData.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFConditionFilterData.html?rev=1782942&view=auto ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFConditionFilterData.html (added) +++ poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFConditionFilterData.html Tue Feb 14 09:47:17 2017 @@ -0,0 +1,322 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<title>XSSFConditionFilterData (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="XSSFConditionFilterData (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/XSSFConditionFilterData.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFConditionalFormattingThreshold.html" title="class in org.apache.poi.xssf.usermodel"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFConnector.html" title="class in org.apache.poi.xssf.usermodel"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/poi/xssf/usermodel/XSSFConditionFilterData.html" target="_top">Frames</a></li> +<li><a href="XSSFConditionFilterData.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.poi.xssf.usermodel</div> +<h2 title="Class XSSFConditionFilterData" class="title">Class XSSFConditionFilterData</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.poi.xssf.usermodel.XSSFConditionFilterData</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html" title="interface in org.apache.poi.ss.usermodel">ConditionFilterData</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">XSSFConditionFilterData</span> +extends java.lang.Object +implements <a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html" title="interface in org.apache.poi.ss.usermodel">ConditionFilterData</a></pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFConditionFilterData.html#getAboveAverage()">getAboveAverage</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFConditionFilterData.html#getBottom()">getBottom</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFConditionFilterData.html#getEqualAverage()">getEqualAverage</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFConditionFilterData.html#getPercent()">getPercent</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFConditionFilterData.html#getRank()">getRank</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/xssf/usermodel/XSSFConditionFilterData.html#getStdDev()">getStdDev</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"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getAboveAverage()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAboveAverage</h4> +<pre>public boolean getAboveAverage()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html#getAboveAverage()">getAboveAverage</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html" title="interface in org.apache.poi.ss.usermodel">ConditionFilterData</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>true if the flag is missing or set to true</dd></dl> +</li> +</ul> +<a name="getBottom()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBottom</h4> +<pre>public boolean getBottom()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html#getBottom()">getBottom</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html" title="interface in org.apache.poi.ss.usermodel">ConditionFilterData</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>true if the flag is set</dd></dl> +</li> +</ul> +<a name="getEqualAverage()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEqualAverage</h4> +<pre>public boolean getEqualAverage()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html#getEqualAverage()">getEqualAverage</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html" title="interface in org.apache.poi.ss.usermodel">ConditionFilterData</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>true if the flag is set</dd></dl> +</li> +</ul> +<a name="getPercent()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPercent</h4> +<pre>public boolean getPercent()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html#getPercent()">getPercent</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html" title="interface in org.apache.poi.ss.usermodel">ConditionFilterData</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>true if the flag is set</dd></dl> +</li> +</ul> +<a name="getRank()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRank</h4> +<pre>public long getRank()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html#getRank()">getRank</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html" title="interface in org.apache.poi.ss.usermodel">ConditionFilterData</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>value, or 0 if not used/defined</dd></dl> +</li> +</ul> +<a name="getStdDev()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getStdDev</h4> +<pre>public int getStdDev()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html#getStdDev()">getStdDev</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html" title="interface in org.apache.poi.ss.usermodel">ConditionFilterData</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>value, or 0 if not used/defined</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/XSSFConditionFilterData.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFConditionalFormattingThreshold.html" title="class in org.apache.poi.xssf.usermodel"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFConnector.html" title="class in org.apache.poi.xssf.usermodel"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/poi/xssf/usermodel/XSSFConditionFilterData.html" target="_top">Frames</a></li> +<li><a href="XSSFConditionFilterData.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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/xssf/usermodel/XSSFConditionalFormattingRule.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFConditionalFormattingRule.html?rev=1782942&r1=1782941&r2=1782942&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFConditionalFormattingRule.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFConditionalFormattingRule.html Tue Feb 14 09:47:17 2017 @@ -105,7 +105,7 @@ <pre>public class <span class="strong">XSSFConditionalFormattingRule</span> extends java.lang.Object implements <a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html" title="interface in org.apache.poi.ss.usermodel">ConditionalFormattingRule</a></pre> -<div class="block">XSSF suport for Conditional Formatting rules</div> +<div class="block">XSSF support for Conditional Formatting rules</div> </li> </ul> </div> @@ -173,15 +173,31 @@ implements <a href="../../../../../org/a </td> </tr> <tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html" title="enum in org.apache.poi.ss.usermodel">ConditionFilterType</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFConditionalFormattingRule.html#getConditionFilterType()">getConditionFilterType</a></strong>()</code> +<div class="block">Will return null if <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFConditionalFormattingRule.html#getConditionType()"><code>getConditionType()</code></a> != <a href="../../../../../org/apache/poi/ss/usermodel/ConditionType.html#FILTER"><code>ConditionType.FILTER</code></a></div> +</td> +</tr> +<tr class="altColor"> <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/xssf/usermodel/XSSFConditionalFormattingRule.html#getConditionType()">getConditionType</a></strong>()</code> <div class="block">Type of conditional formatting rule.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFDataBarFormatting.html" title="class in org.apache.poi.xssf.usermodel">XSSFDataBarFormatting</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFConditionalFormattingRule.html#getDataBarFormatting()">getDataBarFormatting</a></strong>()</code> </td> </tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html" title="interface in org.apache.poi.ss.usermodel">ConditionFilterData</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFConditionalFormattingRule.html#getFilterConfiguration()">getFilterConfiguration</a></strong>()</code> +<div class="block">This is null if + <p/> + <code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html#getConditionFilterType()"><code>ConditionalFormattingRule.getConditionFilterType()</code></a> == null</code> + <p/> + This means it is always null for HSSF, which does not define the extended condition types.</div> +</td> +</tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFFontFormatting.html" title="class in org.apache.poi.xssf.usermodel">XSSFFontFormatting</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFConditionalFormattingRule.html#getFontFormatting()">getFontFormatting</a></strong>()</code> </td> @@ -208,6 +224,19 @@ implements <a href="../../../../../org/a <td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFPatternFormatting.html" title="class in org.apache.poi.xssf.usermodel">XSSFPatternFormatting</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFConditionalFormattingRule.html#getPatternFormatting()">getPatternFormatting</a></strong>()</code> </td> </tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFConditionalFormattingRule.html#getPriority()">getPriority</a></strong>()</code> +<div class="block">HSSF just returns 0, XSSF uses the value stored in the model if present, + otherwise uses 0.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFConditionalFormattingRule.html#getStopIfTrue()">getStopIfTrue</a></strong>()</code> +<div class="block">Always true for HSSF rules, optional flag for XSSF rules.</div> +</td> +</tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> @@ -230,6 +259,42 @@ implements <a href="../../../../../org/a <!-- --> </a> <h3>Method Detail</h3> +<a name="getPriority()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPriority</h4> +<pre>public int getPriority()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html#getPriority()">ConditionalFormattingRule</a></code></strong></div> +<div class="block">HSSF just returns 0, XSSF uses the value stored in the model if present, + otherwise uses 0. + <p/> + If priority is 0, just use definition order, as that's how HSSF rules are evaluated. + <p/> + If a rule is created but not yet added to a sheet, this value may not be valid.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html#getPriority()">getPriority</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html" title="interface in org.apache.poi.ss.usermodel">ConditionalFormattingRule</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>rule priority</dd></dl> +</li> +</ul> +<a name="getStopIfTrue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStopIfTrue</h4> +<pre>public boolean getStopIfTrue()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html#getStopIfTrue()">ConditionalFormattingRule</a></code></strong></div> +<div class="block">Always true for HSSF rules, optional flag for XSSF rules. + See Excel help for more.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html#getStopIfTrue()">getStopIfTrue</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html" title="interface in org.apache.poi.ss.usermodel">ConditionalFormattingRule</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>true if conditional formatting rule processing stops when this one is true, false if not</dd><dt><span class="strong">See Also:</span></dt><dd><a href="https://support.office.com/en-us/article/Manage-conditional-formatting-rule-precedence-063cde21-516e-45ca-83f5-8e8126076249";>Microsoft Excel help</a></dd></dl> +</li> +</ul> <a name="createBorderFormatting()"> <!-- --> </a> @@ -394,6 +459,41 @@ implements <a href="../../../../../org/a <dt><span class="strong">Returns:</span></dt><dd>the type of condition</dd></dl> </li> </ul> +<a name="getConditionFilterType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConditionFilterType</h4> +<pre>public <a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html" title="enum in org.apache.poi.ss.usermodel">ConditionFilterType</a> getConditionFilterType()</pre> +<div class="block">Will return null if <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFConditionalFormattingRule.html#getConditionType()"><code>getConditionType()</code></a> != <a href="../../../../../org/apache/poi/ss/usermodel/ConditionType.html#FILTER"><code>ConditionType.FILTER</code></a></div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html#getConditionFilterType()">getConditionFilterType</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html" title="interface in org.apache.poi.ss.usermodel">ConditionalFormattingRule</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>filter type for filter rules, or null if not a filter rule.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html#getConditionFilterType()"><code>ConditionalFormattingRule.getConditionFilterType()</code></a></dd></dl> +</li> +</ul> +<a name="getFilterConfiguration()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilterConfiguration</h4> +<pre>public <a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html" title="interface in org.apache.poi.ss.usermodel">ConditionFilterData</a> getFilterConfiguration()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html#getFilterConfiguration()">ConditionalFormattingRule</a></code></strong></div> +<div class="block">This is null if + <p/> + <code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html#getConditionFilterType()"><code>ConditionalFormattingRule.getConditionFilterType()</code></a> == null</code> + <p/> + This means it is always null for HSSF, which does not define the extended condition types. + <p/> + This object contains the additional configuration information for XSSF filter conditions.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html#getFilterConfiguration()">getFilterConfiguration</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html" title="interface in org.apache.poi.ss.usermodel">ConditionalFormattingRule</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the Filter Configuration Data, or null if there isn't any</dd></dl> +</li> +</ul> <a name="getComparisonOperation()"> <!-- --> </a> Modified: poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFConditionalFormattingThreshold.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFConditionalFormattingThreshold.html?rev=1782942&r1=1782941&r2=1782942&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFConditionalFormattingThreshold.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFConditionalFormattingThreshold.html Tue Feb 14 09:47:17 2017 @@ -39,7 +39,7 @@ <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFConditionalFormattingRule.html" title="class in org.apache.poi.xssf.usermodel"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFConnector.html" title="class in org.apache.poi.xssf.usermodel"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFConditionFilterData.html" title="class in org.apache.poi.xssf.usermodel"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/poi/xssf/usermodel/XSSFConditionalFormattingThreshold.html" target="_top">Frames</a></li> @@ -379,7 +379,7 @@ implements <a href="../../../../../org/a <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFConditionalFormattingRule.html" title="class in org.apache.poi.xssf.usermodel"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFConnector.html" title="class in org.apache.poi.xssf.usermodel"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFConditionFilterData.html" title="class in org.apache.poi.xssf.usermodel"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/poi/xssf/usermodel/XSSFConditionalFormattingThreshold.html" target="_top">Frames</a></li> Modified: poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFConnector.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFConnector.html?rev=1782942&r1=1782941&r2=1782942&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFConnector.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFConnector.html Tue Feb 14 09:47:17 2017 @@ -38,7 +38,7 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFConditionalFormattingThreshold.html" title="class in org.apache.poi.xssf.usermodel"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFConditionFilterData.html" title="class in org.apache.poi.xssf.usermodel"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFCreationHelper.html" title="class in org.apache.poi.xssf.usermodel"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> @@ -342,7 +342,7 @@ public org.openxmlformats.schemas.d </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFConditionalFormattingThreshold.html" title="class in org.apache.poi.xssf.usermodel"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFConditionFilterData.html" title="class in org.apache.poi.xssf.usermodel"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFCreationHelper.html" title="class in org.apache.poi.xssf.usermodel"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> Added: poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/class-use/XSSFConditionFilterData.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/class-use/XSSFConditionFilterData.html?rev=1782942&view=auto ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/class-use/XSSFConditionFilterData.html (added) +++ poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/class-use/XSSFConditionFilterData.html Tue Feb 14 09:47:17 2017 @@ -0,0 +1,121 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<title>Uses of Class org.apache.poi.xssf.usermodel.XSSFConditionFilterData (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.xssf.usermodel.XSSFConditionFilterData (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/xssf/usermodel/XSSFConditionFilterData.html" title="class in org.apache.poi.xssf.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/xssf/usermodel/class-use/XSSFConditionFilterData.html" target="_top">Frames</a></li> +<li><a href="XSSFConditionFilterData.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class org.apache.poi.xssf.usermodel.XSSFConditionFilterData" class="title">Uses of Class<br>org.apache.poi.xssf.usermodel.XSSFConditionFilterData</h2> +</div> +<div class="classUseContainer">No usage of org.apache.poi.xssf.usermodel.XSSFConditionFilterData</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../org/apache/poi/xssf/usermodel/XSSFConditionFilterData.html" title="class in org.apache.poi.xssf.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/xssf/usermodel/class-use/XSSFConditionFilterData.html" target="_top">Frames</a></li> +<li><a href="XSSFConditionFilterData.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/xssf/usermodel/package-frame.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/package-frame.html?rev=1782942&r1=1782941&r2=1782942&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/package-frame.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/package-frame.html Tue Feb 14 09:47:17 2017 @@ -31,6 +31,7 @@ <li><a href="XSSFConditionalFormatting.html" title="class in org.apache.poi.xssf.usermodel" target="classFrame">XSSFConditionalFormatting</a></li> <li><a href="XSSFConditionalFormattingRule.html" title="class in org.apache.poi.xssf.usermodel" target="classFrame">XSSFConditionalFormattingRule</a></li> <li><a href="XSSFConditionalFormattingThreshold.html" title="class in org.apache.poi.xssf.usermodel" target="classFrame">XSSFConditionalFormattingThreshold</a></li> +<li><a href="XSSFConditionFilterData.html" title="class in org.apache.poi.xssf.usermodel" target="classFrame">XSSFConditionFilterData</a></li> <li><a href="XSSFConnector.html" title="class in org.apache.poi.xssf.usermodel" target="classFrame">XSSFConnector</a></li> <li><a href="XSSFCreationHelper.html" title="class in org.apache.poi.xssf.usermodel" target="classFrame">XSSFCreationHelper</a></li> <li><a href="XSSFDataBarFormatting.html" title="class in org.apache.poi.xssf.usermodel" target="classFrame">XSSFDataBarFormatting</a></li> --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@poi.apache.org For additional commands, e-mail: commits-h...@poi.apache.org
