Modified: poi/site/publish/apidocs/org/apache/poi/hssf/usermodel/HSSFConditionalFormattingRule.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hssf/usermodel/HSSFConditionalFormattingRule.html?rev=1782942&r1=1782941&r2=1782942&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/hssf/usermodel/HSSFConditionalFormattingRule.html (original) +++ poi/site/publish/apidocs/org/apache/poi/hssf/usermodel/HSSFConditionalFormattingRule.html Tue Feb 14 09:47:17 2017 @@ -184,15 +184,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/hssf/usermodel/HSSFConditionalFormattingRule.html#getConditionFilterType()">getConditionFilterType</a></strong>()</code> +<div class="block">always null (not a filter condition) or <a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html#FILTER"><code>ConditionFilterType.FILTER</code></a> if it is.</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/hssf/usermodel/HSSFConditionalFormattingRule.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/hssf/usermodel/HSSFDataBarFormatting.html" title="class in org.apache.poi.hssf.usermodel">HSSFDataBarFormatting</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFConditionalFormattingRule.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/hssf/usermodel/HSSFConditionalFormattingRule.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/hssf/usermodel/HSSFFontFormatting.html" title="class in org.apache.poi.hssf.usermodel">HSSFFontFormatting</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFConditionalFormattingRule.html#getFontFormatting()">getFontFormatting</a></strong>()</code> </td> @@ -220,6 +236,18 @@ implements <a href="../../../../../org/a <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFConditionalFormattingRule.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/hssf/usermodel/HSSFConditionalFormattingRule.html#getPriority()">getPriority</a></strong>()</code> +<div class="block">we don't know priority for these, other than definition/model order, which appears to be what Excel uses.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFConditionalFormattingRule.html#getStopIfTrue()">getStopIfTrue</a></strong>()</code> +<div class="block">Always true for HSSF files, per Microsoft Excel documentation</div> +</td> +</tr> +<tr class="altColor"> <td class="colFirst"><code>protected java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFConditionalFormattingRule.html#toFormulaString(org.apache.poi.ss.formula.ptg.Ptg[])">toFormulaString</a></strong>(<a href="../../../../../org/apache/poi/ss/formula/ptg/Ptg.html" title="class in org.apache.poi.ss.formula.ptg">Ptg</a>[] parsedExpression)</code> </td> </tr> @@ -250,6 +278,34 @@ 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">we don't know priority for these, other than definition/model order, which appears to be what Excel uses.</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><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html#getPriority()"><code>ConditionalFormattingRule.getPriority()</code></a></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">Always true for HSSF files, per Microsoft Excel documentation</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="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html#getStopIfTrue()"><code>ConditionalFormattingRule.getStopIfTrue()</code></a></dd></dl> +</li> +</ul> <a name="getFontFormatting()"> <!-- --> </a> @@ -421,6 +477,41 @@ implements <a href="../../../../../org/a <dt><span class="strong">Returns:</span></dt><dd>- the conditiontype for the cfrule</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">always null (not a filter condition) or <a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html#FILTER"><code>ConditionFilterType.FILTER</code></a> if it is.</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/hssf/usermodel/HSSFEvaluationWorkbook.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hssf/usermodel/HSSFEvaluationWorkbook.html?rev=1782942&r1=1782941&r2=1782942&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/hssf/usermodel/HSSFEvaluationWorkbook.html (original) +++ poi/site/publish/apidocs/org/apache/poi/hssf/usermodel/HSSFEvaluationWorkbook.html Tue Feb 14 09:47:17 2017 @@ -696,6 +696,8 @@ implements <a href="../../../../../org/a 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> Modified: poi/site/publish/apidocs/org/apache/poi/hssf/util/CellRangeAddress8Bit.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hssf/util/CellRangeAddress8Bit.html?rev=1782942&r1=1782941&r2=1782942&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/hssf/util/CellRangeAddress8Bit.html (original) +++ poi/site/publish/apidocs/org/apache/poi/hssf/util/CellRangeAddress8Bit.html Tue Feb 14 09:47:17 2017 @@ -186,7 +186,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/class-use/SpreadsheetVersion.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/class-use/SpreadsheetVersion.html?rev=1782942&r1=1782941&r2=1782942&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/class-use/SpreadsheetVersion.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/class-use/SpreadsheetVersion.html Tue Feb 14 09:47:17 2017 @@ -183,6 +183,10 @@ the order they are declared.</div> max column and row numbers, max arguments to a function, etc.)</div> </td> </tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/SpreadsheetVersion.html" title="enum in org.apache.poi.ss">SpreadsheetVersion</a></code></td> +<td class="colLast"><span class="strong">EvaluationWorkbook.</span><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html#getSpreadsheetVersion()">getSpreadsheetVersion</a></strong>()</code> </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/formula/CollaboratingWorkbooksEnvironment.WorkbookNotFoundException.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/CollaboratingWorkbooksEnvironment.WorkbookNotFoundException.html?rev=1782942&r1=1782941&r2=1782942&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/CollaboratingWorkbooksEnvironment.WorkbookNotFoundException.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/CollaboratingWorkbooksEnvironment.WorkbookNotFoundException.html Tue Feb 14 09:47:17 2017 @@ -39,7 +39,7 @@ <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/poi/ss/formula/CollaboratingWorkbooksEnvironment.html" title="class in org.apache.poi.ss.formula"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/poi/ss/formula/EvaluationCell.html" title="interface in org.apache.poi.ss.formula"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html" title="class in org.apache.poi.ss.formula"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/poi/ss/formula/CollaboratingWorkbooksEnvironment.WorkbookNotFoundException.html" target="_top">Frames</a></li> @@ -172,7 +172,7 @@ extends java.lang.Exception</pre> <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/poi/ss/formula/CollaboratingWorkbooksEnvironment.html" title="class in org.apache.poi.ss.formula"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/poi/ss/formula/EvaluationCell.html" title="interface in org.apache.poi.ss.formula"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html" title="class in org.apache.poi.ss.formula"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/poi/ss/formula/CollaboratingWorkbooksEnvironment.WorkbookNotFoundException.html" target="_top">Frames</a></li> Added: poi/site/publish/apidocs/org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html?rev=1782942&view=auto ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html (added) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html Tue Feb 14 09:47:17 2017 @@ -0,0 +1,471 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<title>ConditionalFormattingEvaluator (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="ConditionalFormattingEvaluator (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/ConditionalFormattingEvaluator.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/formula/CollaboratingWorkbooksEnvironment.WorkbookNotFoundException.html" title="class in org.apache.poi.ss.formula"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.html" title="class in org.apache.poi.ss.formula"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html" target="_top">Frames</a></li> +<li><a href="ConditionalFormattingEvaluator.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.formula</div> +<h2 title="Class ConditionalFormattingEvaluator" class="title">Class ConditionalFormattingEvaluator</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.poi.ss.formula.ConditionalFormattingEvaluator</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">ConditionalFormattingEvaluator</span> +extends java.lang.Object</pre> +<div class="block">Evaluates Conditional Formatting constraints.<p/> + + For performance reasons, this class keeps a cache of all previously evaluated rules and cells. + Be sure to call <a href="../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html#clearAllCachedFormats()"><code>clearAllCachedFormats()</code></a> if any conditional formats are modified, added, or deleted, + and <a href="../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html#clearAllCachedValues()"><code>clearAllCachedValues()</code></a> whenever cell values change. + <p/></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/formula/ConditionalFormattingEvaluator.html#ConditionalFormattingEvaluator(org.apache.poi.ss.usermodel.Workbook,%20org.apache.poi.ss.formula.WorkbookEvaluatorProvider)">ConditionalFormattingEvaluator</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a> wb, + <a href="../../../../../org/apache/poi/ss/formula/WorkbookEvaluatorProvider.html" title="interface in org.apache.poi.ss.formula">WorkbookEvaluatorProvider</a> provider)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html#clearAllCachedFormats()">clearAllCachedFormats</a></strong>()</code> +<div class="block">Call this whenever rules are added, reordered, or removed, or a rule formula is changed + (not the formula inputs but the formula expression itself)</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html#clearAllCachedValues()">clearAllCachedValues</a></strong>()</code> +<div class="block">Call this whenever cell values change in the workbook, so condional formats are re-evaluated + for all cells.</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"><code><strong><a href="../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html#getConditionalFormattingForCell(org.apache.poi.ss.usermodel.Cell)">getConditionalFormattingForCell</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">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>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"><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="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"><code><strong><a href="../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html#getFormatRulesForSheet(org.apache.poi.ss.usermodel.Sheet)">getFormatRulesForSheet</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Sheet.html" title="interface in org.apache.poi.ss.usermodel">Sheet</a> sheet)</code> </td> +</tr> +<tr class="rowColor"> +<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"><code><strong><a href="../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html#getFormatRulesForSheet(java.lang.String)">getFormatRulesForSheet</a></strong>(java.lang.String sheetName)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<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/formula/ConditionalFormattingEvaluator.html#getMatchingCells(org.apache.poi.ss.formula.EvaluationConditionalFormatRule)">getMatchingCells</a></strong>(<a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html" title="class in org.apache.poi.ss.formula">EvaluationConditionalFormatRule</a> rule)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<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/formula/ConditionalFormattingEvaluator.html#getMatchingCells(org.apache.poi.ss.usermodel.Sheet,%20int,%20int)">getMatchingCells</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Sheet.html" title="interface in org.apache.poi.ss.usermodel">Sheet</a> sheet, + int conditionalFormattingIndex, + int ruleIndex)</code> +<div class="block">Conditional formatting rules can apply only to cells in the sheet to which they are attached.</div> +</td> +</tr> +<tr class="altColor"> +<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"><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="rowColor"> +<td class="colFirst"><code>protected 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"><code><strong><a href="../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html#getRules(org.apache.poi.ss.usermodel.Sheet)">getRules</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Sheet.html" title="interface in org.apache.poi.ss.usermodel">Sheet</a> sheet)</code> +<div class="block">lazy load by sheet since reading can be expensive</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html" title="class in org.apache.poi.ss.formula">WorkbookEvaluator</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html#getWorkbookEvaluator()">getWorkbookEvaluator</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="ConditionalFormattingEvaluator(org.apache.poi.ss.usermodel.Workbook, org.apache.poi.ss.formula.WorkbookEvaluatorProvider)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ConditionalFormattingEvaluator</h4> +<pre>public ConditionalFormattingEvaluator(<a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a> wb, + <a href="../../../../../org/apache/poi/ss/formula/WorkbookEvaluatorProvider.html" title="interface in org.apache.poi.ss.formula">WorkbookEvaluatorProvider</a> provider)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getWorkbookEvaluator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWorkbookEvaluator</h4> +<pre>protected <a href="../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html" title="class in org.apache.poi.ss.formula">WorkbookEvaluator</a> getWorkbookEvaluator()</pre> +</li> +</ul> +<a name="clearAllCachedFormats()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clearAllCachedFormats</h4> +<pre>public void clearAllCachedFormats()</pre> +<div class="block">Call this whenever rules are added, reordered, or removed, or a rule formula is changed + (not the formula inputs but the formula expression itself)</div> +</li> +</ul> +<a name="clearAllCachedValues()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clearAllCachedValues</h4> +<pre>public void clearAllCachedValues()</pre> +<div class="block">Call this whenever cell values change in the workbook, so condional formats are re-evaluated + for all cells. + <p/> + TODO: eventually this should work like <code>EvaluationCache.notifyUpdateCell(int, int, EvaluationCell)</code> + and only clear values that need recalculation based on the formula dependency tree.</div> +</li> +</ul> +<a name="getRules(org.apache.poi.ss.usermodel.Sheet)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRules</h4> +<pre>protected java.util.List<<a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html" title="class in org.apache.poi.ss.formula">EvaluationConditionalFormatRule</a>> getRules(<a href="../../../../../org/apache/poi/ss/usermodel/Sheet.html" title="interface in org.apache.poi.ss.usermodel">Sheet</a> sheet)</pre> +<div class="block">lazy load by sheet since reading can be expensive</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sheet</code> - </dd> +<dt><span class="strong">Returns:</span></dt><dd>unmodifiable list of rules</dd></dl> +</li> +</ul> +<a name="getConditionalFormattingForCell(org.apache.poi.ss.util.CellReference)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConditionalFormattingForCell</h4> +<pre>public java.util.List<<a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html" title="class in org.apache.poi.ss.formula">EvaluationConditionalFormatRule</a>> getConditionalFormattingForCell(<a href="../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a> cellRef)</pre> +<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. This is a property currently + not exposed from <code>CTCfRule</code> in <code>XSSFConditionalFormattingRule</code>. + <p/> + Most cells will have zero or one applied rule, but it is possible to define multiple rules + that apply at the same time to the same cell, thus the List result. + <p/> + Note that to properly apply conditional rules, care must be taken to offset the base + formula by the relative position of the current cell, or the wrong value is checked. + This is handled by <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)"><code>WorkbookEvaluator.evaluate(String, CellReference, CellRangeAddressBase)</code></a>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cellRef</code> - NOTE: if no sheet name is specified, this uses the workbook active sheet</dd> +<dt><span class="strong">Returns:</span></dt><dd>Unmodifiable List of <a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html" title="class in org.apache.poi.ss.formula"><code>EvaluationConditionalFormatRule</code></a>s that apply to the current cell value, + in priority order, as evaluated by Excel (smallest priority # for XSSF, definition order for HSSF), + or null if none apply</dd></dl> +</li> +</ul> +<a name="getConditionalFormattingForCell(org.apache.poi.ss.usermodel.Cell)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConditionalFormattingForCell</h4> +<pre>public java.util.List<<a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html" title="class in org.apache.poi.ss.formula">EvaluationConditionalFormatRule</a>> getConditionalFormattingForCell(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</pre> +<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. This is a property currently + not exposed from <code>CTCfRule</code> in <code>XSSFConditionalFormattingRule</code>. + <p/> + Most cells will have zero or one applied rule, but it is possible to define multiple rules + that apply at the same time to the same cell, thus the List result. + <p/> + Note that to properly apply conditional rules, care must be taken to offset the base + formula by the relative position of the current cell, or the wrong value is checked. + This is handled by <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)"><code>WorkbookEvaluator.evaluate(String, CellReference, CellRangeAddressBase)</code></a>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cell</code> - </dd> +<dt><span class="strong">Returns:</span></dt><dd>Unmodifiable List of <a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html" title="class in org.apache.poi.ss.formula"><code>EvaluationConditionalFormatRule</code></a>s that apply to the current cell value, + in priority order, as evaluated by Excel (smallest priority # for XSSF, definition order for HSSF), + or null if none apply</dd></dl> +</li> +</ul> +<a name="getRef(org.apache.poi.ss.usermodel.Cell)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRef</h4> +<pre>public static <a href="../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a> getRef(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</pre> +</li> +</ul> +<a name="getFormatRulesForSheet(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFormatRulesForSheet</h4> +<pre>public java.util.List<<a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html" title="class in org.apache.poi.ss.formula">EvaluationConditionalFormatRule</a>> getFormatRulesForSheet(java.lang.String sheetName)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sheetName</code> - </dd> +<dt><span class="strong">Returns:</span></dt><dd>unmodifiable list of all Conditional format rules for the given sheet, if any</dd></dl> +</li> +</ul> +<a name="getFormatRulesForSheet(org.apache.poi.ss.usermodel.Sheet)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFormatRulesForSheet</h4> +<pre>public java.util.List<<a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html" title="class in org.apache.poi.ss.formula">EvaluationConditionalFormatRule</a>> getFormatRulesForSheet(<a href="../../../../../org/apache/poi/ss/usermodel/Sheet.html" title="interface in org.apache.poi.ss.usermodel">Sheet</a> sheet)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sheet</code> - </dd> +<dt><span class="strong">Returns:</span></dt><dd>unmodifiable list of all Conditional format rules for the given sheet, if any</dd></dl> +</li> +</ul> +<a name="getMatchingCells(org.apache.poi.ss.usermodel.Sheet, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMatchingCells</h4> +<pre>public java.util.List<<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a>> getMatchingCells(<a href="../../../../../org/apache/poi/ss/usermodel/Sheet.html" title="interface in org.apache.poi.ss.usermodel">Sheet</a> sheet, + int conditionalFormattingIndex, + int ruleIndex)</pre> +<div class="block">Conditional formatting rules can apply only to cells in the sheet to which they are attached. + The POI data model does not have a back-reference to the owning sheet, so it must be passed in separately. + <p/> + We could overload this with convenience methods taking a sheet name and sheet index as well. + <p/></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sheet</code> - containing the rule</dd><dd><code>conditionalFormattingIndex</code> - of the <a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormatting.html" title="interface in org.apache.poi.ss.usermodel"><code>ConditionalFormatting</code></a> instance in the sheet's array</dd><dd><code>ruleIndex</code> - of the <a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html" title="interface in org.apache.poi.ss.usermodel"><code>ConditionalFormattingRule</code></a> instance within the <a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormatting.html" title="interface in org.apache.poi.ss.usermodel"><code>ConditionalFormatting</code></a></dd> +<dt><span class="strong">Returns:</span></dt><dd>unmodifiable List of all cells in the rule's region matching the rule's condition</dd></dl> +</li> +</ul> +<a name="getMatchingCells(org.apache.poi.ss.formula.EvaluationConditionalFormatRule)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getMatchingCells</h4> +<pre>public java.util.List<<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a>> getMatchingCells(<a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html" title="class in org.apache.poi.ss.formula">EvaluationConditionalFormatRule</a> rule)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rule</code> - </dd> +<dt><span class="strong">Returns:</span></dt><dd>unmodifiable List of all cells in the rule's region matching the rule's condition</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/ConditionalFormattingEvaluator.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/formula/CollaboratingWorkbooksEnvironment.WorkbookNotFoundException.html" title="class in org.apache.poi.ss.formula"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.html" title="class in org.apache.poi.ss.formula"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html" target="_top">Frames</a></li> +<li><a href="ConditionalFormattingEvaluator.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> Added: poi/site/publish/apidocs/org/apache/poi/ss/formula/DataValidationEvaluator.DataValidationContext.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/DataValidationEvaluator.DataValidationContext.html?rev=1782942&view=auto ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/DataValidationEvaluator.DataValidationContext.html (added) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/DataValidationEvaluator.DataValidationContext.html Tue Feb 14 09:47:17 2017 @@ -0,0 +1,394 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<title>DataValidationEvaluator.DataValidationContext (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="DataValidationEvaluator.DataValidationContext (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/DataValidationEvaluator.DataValidationContext.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/formula/DataValidationEvaluator.html" title="class in org.apache.poi.ss.formula"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html" title="enum in org.apache.poi.ss.formula"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/poi/ss/formula/DataValidationEvaluator.DataValidationContext.html" target="_top">Frames</a></li> +<li><a href="DataValidationEvaluator.DataValidationContext.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.formula</div> +<h2 title="Class DataValidationEvaluator.DataValidationContext" class="title">Class DataValidationEvaluator.DataValidationContext</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.poi.ss.formula.DataValidationEvaluator.DataValidationContext</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.html" title="class in org.apache.poi.ss.formula">DataValidationEvaluator</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="strong">DataValidationEvaluator.DataValidationContext</span> +extends java.lang.Object</pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/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> +</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><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.html" title="class in org.apache.poi.ss.formula">DataValidationEvaluator</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.DataValidationContext.html#getEvaluator()">getEvaluator</a></strong>()</code> </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/formula/DataValidationEvaluator.DataValidationContext.html#getFormula1()">getFormula1</a></strong>()</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/formula/DataValidationEvaluator.DataValidationContext.html#getFormula2()">getFormula2</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/formula/DataValidationEvaluator.DataValidationContext.html#getOffsetColumns()">getOffsetColumns</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/ss/formula/DataValidationEvaluator.DataValidationContext.html#getOffsetRows()">getOffsetRows</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/formula/DataValidationEvaluator.DataValidationContext.html#getOperator()">getOperator</a></strong>()</code> </td> +</tr> +<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"><code><strong><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.DataValidationContext.html#getRegion()">getRegion</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/formula/DataValidationEvaluator.DataValidationContext.html#getSheetIndex()">getSheetIndex</a></strong>()</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"><code><strong><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.DataValidationContext.html#getTarget()">getTarget</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<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"><code><strong><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.DataValidationContext.html#getValidation()">getValidation</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="DataValidationEvaluator.DataValidationContext(org.apache.poi.ss.usermodel.DataValidation, org.apache.poi.ss.formula.DataValidationEvaluator, org.apache.poi.ss.util.CellRangeAddressBase, org.apache.poi.ss.util.CellReference)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DataValidationEvaluator.DataValidationContext</h4> +<pre>public DataValidationEvaluator.DataValidationContext(<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)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dv</code> - </dd><dd><code>dve</code> - </dd><dd><code>region</code> - </dd><dd><code>target</code> - </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="getValidation()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getValidation</h4> +<pre>public <a href="../../../../../org/apache/poi/ss/usermodel/DataValidation.html" title="interface in org.apache.poi.ss.usermodel">DataValidation</a> getValidation()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the dv</dd></dl> +</li> +</ul> +<a name="getEvaluator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEvaluator</h4> +<pre>public <a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.html" title="class in org.apache.poi.ss.formula">DataValidationEvaluator</a> getEvaluator()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the dve</dd></dl> +</li> +</ul> +<a name="getRegion()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRegion</h4> +<pre>public <a href="../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html" title="class in org.apache.poi.ss.util">CellRangeAddressBase</a> getRegion()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the region</dd></dl> +</li> +</ul> +<a name="getTarget()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTarget</h4> +<pre>public <a href="../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a> getTarget()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the target</dd></dl> +</li> +</ul> +<a name="getOffsetColumns()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOffsetColumns</h4> +<pre>public int getOffsetColumns()</pre> +</li> +</ul> +<a name="getOffsetRows()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOffsetRows</h4> +<pre>public int getOffsetRows()</pre> +</li> +</ul> +<a name="getSheetIndex()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSheetIndex</h4> +<pre>public int getSheetIndex()</pre> +</li> +</ul> +<a name="getFormula1()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFormula1</h4> +<pre>public java.lang.String getFormula1()</pre> +</li> +</ul> +<a name="getFormula2()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFormula2</h4> +<pre>public java.lang.String getFormula2()</pre> +</li> +</ul> +<a name="getOperator()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getOperator</h4> +<pre>public int getOperator()</pre> +</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/DataValidationEvaluator.DataValidationContext.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/formula/DataValidationEvaluator.html" title="class in org.apache.poi.ss.formula"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html" title="enum in org.apache.poi.ss.formula"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/poi/ss/formula/DataValidationEvaluator.DataValidationContext.html" target="_top">Frames</a></li> +<li><a href="DataValidationEvaluator.DataValidationContext.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> Added: poi/site/publish/apidocs/org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html?rev=1782942&view=auto ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html (added) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html Tue Feb 14 09:47:17 2017 @@ -0,0 +1,461 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<title>DataValidationEvaluator.OperatorEnum (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="DataValidationEvaluator.OperatorEnum (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/DataValidationEvaluator.OperatorEnum.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/formula/DataValidationEvaluator.DataValidationContext.html" title="class in org.apache.poi.ss.formula"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.html" title="enum in org.apache.poi.ss.formula"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html" target="_top">Frames</a></li> +<li><a href="DataValidationEvaluator.OperatorEnum.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><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li><a href="#field_detail">Field</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.formula</div> +<h2 title="Enum DataValidationEvaluator.OperatorEnum" class="title">Enum DataValidationEvaluator.OperatorEnum</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Enum<<a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.OperatorEnum</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.poi.ss.formula.DataValidationEvaluator.OperatorEnum</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.OperatorEnum</a>></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.html" title="class in org.apache.poi.ss.formula">DataValidationEvaluator</a></dd> +</dl> +<hr> +<br> +<pre>public static enum <span class="strong">DataValidationEvaluator.OperatorEnum</span> +extends java.lang.Enum<<a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.OperatorEnum</a>></pre> +<div class="block">Not calling it OperatorType to avoid confusion for now with DataValidationConstraint.OperatorType. + Definition order matches OOXML type ID indexes</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html#BETWEEN">BETWEEN</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html#EQUAL">EQUAL</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html#GREATER_OR_EQUAL">GREATER_OR_EQUAL</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html#GREATER_THAN">GREATER_THAN</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html#LESS_OR_EQUAL">LESS_OR_EQUAL</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html#LESS_THAN">LESS_THAN</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html#NOT_BETWEEN">NOT_BETWEEN</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html#NOT_EQUAL">NOT_EQUAL</a></strong></code> </td> +</tr> +</table> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.OperatorEnum</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html#IGNORED">IGNORED</a></strong></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html#isValid(java.lang.Double,%20java.lang.Double,%20java.lang.Double)">isValid</a></strong>(java.lang.Double cellValue, + java.lang.Double v1, + java.lang.Double v2)</code> +<div class="block">Evaluates comparison using operator instance rules</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.OperatorEnum</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.OperatorEnum</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Enum</h3> +<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li> +</ul> +<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>getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="BETWEEN"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>BETWEEN</h4> +<pre>public static final <a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.OperatorEnum</a> BETWEEN</pre> +</li> +</ul> +<a name="NOT_BETWEEN"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NOT_BETWEEN</h4> +<pre>public static final <a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.OperatorEnum</a> NOT_BETWEEN</pre> +</li> +</ul> +<a name="EQUAL"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EQUAL</h4> +<pre>public static final <a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.OperatorEnum</a> EQUAL</pre> +</li> +</ul> +<a name="NOT_EQUAL"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NOT_EQUAL</h4> +<pre>public static final <a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.OperatorEnum</a> NOT_EQUAL</pre> +</li> +</ul> +<a name="GREATER_THAN"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>GREATER_THAN</h4> +<pre>public static final <a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.OperatorEnum</a> GREATER_THAN</pre> +</li> +</ul> +<a name="LESS_THAN"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LESS_THAN</h4> +<pre>public static final <a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.OperatorEnum</a> LESS_THAN</pre> +</li> +</ul> +<a name="GREATER_OR_EQUAL"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>GREATER_OR_EQUAL</h4> +<pre>public static final <a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.OperatorEnum</a> GREATER_OR_EQUAL</pre> +</li> +</ul> +<a name="LESS_OR_EQUAL"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>LESS_OR_EQUAL</h4> +<pre>public static final <a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.OperatorEnum</a> LESS_OR_EQUAL</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="IGNORED"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>IGNORED</h4> +<pre>public static final <a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.OperatorEnum</a> IGNORED</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.OperatorEnum</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (DataValidationEvaluator.OperatorEnum c : DataValidationEvaluator.OperatorEnum.values()) + System.out.println(c); +</pre></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in the order they are declared</dd></dl> +</li> +</ul> +<a name="valueOf(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.OperatorEnum</a> valueOf(java.lang.String name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd> +<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd></dl> +</li> +</ul> +<a name="isValid(java.lang.Double, java.lang.Double, java.lang.Double)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isValid</h4> +<pre>public abstract boolean isValid(java.lang.Double cellValue, + java.lang.Double v1, + java.lang.Double v2)</pre> +<div class="block">Evaluates comparison using operator instance rules</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cellValue</code> - won't be null, assumption is previous checks handled that</dd><dd><code>v1</code> - if null, value assumed invalid, anything passes, per Excel behavior</dd><dd><code>v2</code> - null if not needed. If null when needed, assume anything passes, per Excel behavior</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if the comparison is valid</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/DataValidationEvaluator.OperatorEnum.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/formula/DataValidationEvaluator.DataValidationContext.html" title="class in org.apache.poi.ss.formula"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.html" title="enum in org.apache.poi.ss.formula"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html" target="_top">Frames</a></li> +<li><a href="DataValidationEvaluator.OperatorEnum.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><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li><a href="#field_detail">Field</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> --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
