Added: poi/site/publish/apidocs/org/apache/poi/ss/formula/EvaluationConditionalFormatRule.ValueFunction.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/EvaluationConditionalFormatRule.ValueFunction.html?rev=1782942&view=auto ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/EvaluationConditionalFormatRule.ValueFunction.html (added) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/EvaluationConditionalFormatRule.ValueFunction.html Tue Feb 14 09:47:17 2017 @@ -0,0 +1,220 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<title>EvaluationConditionalFormatRule.ValueFunction (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="EvaluationConditionalFormatRule.ValueFunction (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/EvaluationConditionalFormatRule.ValueFunction.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/EvaluationConditionalFormatRule.ValueAndFormat.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/EvaluationName.html" title="interface 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/EvaluationConditionalFormatRule.ValueFunction.html" target="_top">Frames</a></li> +<li><a href="EvaluationConditionalFormatRule.ValueFunction.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.ss.formula</div> +<h2 title="Interface EvaluationConditionalFormatRule.ValueFunction" class="title">Interface EvaluationConditionalFormatRule.ValueFunction</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html" title="class in org.apache.poi.ss.formula">EvaluationConditionalFormatRule</a></dd> +</dl> +<hr> +<br> +<pre>protected static interface <span class="strong">EvaluationConditionalFormatRule.ValueFunction</span></pre> +<div class="block">instances evaluate the values for a region and return the positive matches for the function type. + TODO: when we get to use Java 8, this is obviously a Lambda Function.</div> +</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>java.util.Set<<a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.ValueAndFormat.html" title="class in org.apache.poi.ss.formula">EvaluationConditionalFormatRule.ValueAndFormat</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.ValueFunction.html#evaluate(java.util.List)">evaluate</a></strong>(java.util.List<<a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.ValueAndFormat.html" title="class in org.apache.poi.ss.formula">EvaluationConditionalFormatRule.ValueAndFormat</a>> values)</code> </td> +</tr> +</table> +</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="evaluate(java.util.List)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>evaluate</h4> +<pre>java.util.Set<<a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.ValueAndFormat.html" title="class in org.apache.poi.ss.formula">EvaluationConditionalFormatRule.ValueAndFormat</a>> evaluate(java.util.List<<a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.ValueAndFormat.html" title="class in org.apache.poi.ss.formula">EvaluationConditionalFormatRule.ValueAndFormat</a>> values)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - </dd> +<dt><span class="strong">Returns:</span></dt><dd>the desired values for the rules implemented by the current instance</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/EvaluationConditionalFormatRule.ValueFunction.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/EvaluationConditionalFormatRule.ValueAndFormat.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/EvaluationName.html" title="interface 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/EvaluationConditionalFormatRule.ValueFunction.html" target="_top">Frames</a></li> +<li><a href="EvaluationConditionalFormatRule.ValueFunction.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>
Added: poi/site/publish/apidocs/org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html?rev=1782942&view=auto ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html (added) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html Tue Feb 14 09:47:17 2017 @@ -0,0 +1,526 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<title>EvaluationConditionalFormatRule (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="EvaluationConditionalFormatRule (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/EvaluationConditionalFormatRule.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/EvaluationCell.html" title="interface in org.apache.poi.ss.formula"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.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/EvaluationConditionalFormatRule.html" target="_top">Frames</a></li> +<li><a href="EvaluationConditionalFormatRule.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><a href="#nested_class_summary">Nested</a> | </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 EvaluationConditionalFormatRule" class="title">Class EvaluationConditionalFormatRule</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.poi.ss.formula.EvaluationConditionalFormatRule</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.lang.Comparable<<a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html" title="class in org.apache.poi.ss.formula">EvaluationConditionalFormatRule</a>></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">EvaluationConditionalFormatRule</span> +extends java.lang.Object +implements java.lang.Comparable<<a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html" title="class in org.apache.poi.ss.formula">EvaluationConditionalFormatRule</a>></pre> +<div class="block">Abstracted and cached version of a Conditional Format rule for use with a + <a href="../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html" title="class in org.apache.poi.ss.formula"><code>ConditionalFormattingEvaluator</code></a>. This references a rule, its owning + <a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormatting.html" title="interface in org.apache.poi.ss.usermodel"><code>ConditionalFormatting</code></a>, its priority order (lower index = higher priority in Excel), + and the information needed to evaluate the rule for a given cell. + <p/> + Having this all combined and cached avoids repeated access calls to the + underlying structural objects, XSSF CT* objects and HSSF raw byte structures. + Those objects can be referenced from here. This object will be out of sync if + anything modifies the referenced structures' evaluation properties. + <p/> + The assumption is that consuming applications will read the display properties once and + create whatever style objects they need, caching those at the application level. + Thus this class only caches values needed for evaluation, not display.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">EvaluationConditionalFormatRule.OperatorEnum</a></strong></code> +<div class="block">Not calling it OperatorType to avoid confusion for now with other classes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected class </code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.ValueAndFormat.html" title="class in org.apache.poi.ss.formula">EvaluationConditionalFormatRule.ValueAndFormat</a></strong></code> +<div class="block">Note: this class has a natural ordering that is inconsistent with equals.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected static interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.ValueFunction.html" title="interface in org.apache.poi.ss.formula">EvaluationConditionalFormatRule.ValueFunction</a></strong></code> +<div class="block">instances evaluate the values for a region and return the positive matches for the function type.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ======== 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/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> +</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>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html#compareTo(org.apache.poi.ss.formula.EvaluationConditionalFormatRule)">compareTo</a></strong>(<a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html" title="class in org.apache.poi.ss.formula">EvaluationConditionalFormatRule</a> o)</code> +<div class="block">Per Excel Help, XSSF rule priority is sheet-wide, not just within the owning ConditionalFormatting object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> +<div class="block">Defined as equal sheet name and formatting and rule indexes</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormatting.html" title="interface in org.apache.poi.ss.usermodel">ConditionalFormatting</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html#getFormatting()">getFormatting</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/EvaluationConditionalFormatRule.html#getFormattingIndex()">getFormattingIndex</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/EvaluationConditionalFormatRule.html#getFormula1()">getFormula1</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/EvaluationConditionalFormatRule.html#getFormula2()">getFormula2</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">EvaluationConditionalFormatRule.OperatorEnum</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html#getOperator()">getOperator</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html#getPriority()">getPriority</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/util/CellRangeAddress.html" title="class in org.apache.poi.ss.util">CellRangeAddress</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html#getRegions()">getRegions</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html" title="interface in org.apache.poi.ss.usermodel">ConditionalFormattingRule</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html#getRule()">getRule</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html#getRuleIndex()">getRuleIndex</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/Sheet.html" title="interface in org.apache.poi.ss.usermodel">Sheet</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html#getSheet()">getSheet</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionType.html" title="class in org.apache.poi.ss.usermodel">ConditionType</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html#getType()">getType</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +</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, finalize, getClass, 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="EvaluationConditionalFormatRule(org.apache.poi.ss.formula.WorkbookEvaluator, org.apache.poi.ss.usermodel.Sheet, org.apache.poi.ss.usermodel.ConditionalFormatting, int, org.apache.poi.ss.usermodel.ConditionalFormattingRule, int, org.apache.poi.ss.util.CellRangeAddress[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>EvaluationConditionalFormatRule</h4> +<pre>public EvaluationConditionalFormatRule(<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)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>workbookEvaluator</code> - </dd><dd><code>sheet</code> - </dd><dd><code>formatting</code> - </dd><dd><code>formattingIndex</code> - for priority, zero based</dd><dd><code>rule</code> - </dd><dd><code>ruleIndex</code> - for priority, zero based, if this is an HSSF rule. Unused for XSSF rules</dd><dd><code>regions</code> - could be read from formatting, but every call creates new objects in a new array. + this allows calling it once per formatting instance, and re-using the array.</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="getSheet()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSheet</h4> +<pre>public <a href="../../../../../org/apache/poi/ss/usermodel/Sheet.html" title="interface in org.apache.poi.ss.usermodel">Sheet</a> getSheet()</pre> +</li> +</ul> +<a name="getFormatting()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFormatting</h4> +<pre>public <a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormatting.html" title="interface in org.apache.poi.ss.usermodel">ConditionalFormatting</a> getFormatting()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the formatting</dd></dl> +</li> +</ul> +<a name="getFormattingIndex()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFormattingIndex</h4> +<pre>public int getFormattingIndex()</pre> +</li> +</ul> +<a name="getRule()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRule</h4> +<pre>public <a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html" title="interface in org.apache.poi.ss.usermodel">ConditionalFormattingRule</a> getRule()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the rule</dd></dl> +</li> +</ul> +<a name="getRuleIndex()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRuleIndex</h4> +<pre>public int getRuleIndex()</pre> +</li> +</ul> +<a name="getRegions()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRegions</h4> +<pre>public <a href="../../../../../org/apache/poi/ss/util/CellRangeAddress.html" title="class in org.apache.poi.ss.util">CellRangeAddress</a>[] getRegions()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the regions</dd></dl> +</li> +</ul> +<a name="getPriority()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPriority</h4> +<pre>public int getPriority()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the priority</dd></dl> +</li> +</ul> +<a name="getFormula1()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFormula1</h4> +<pre>public java.lang.String getFormula1()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the formula1</dd></dl> +</li> +</ul> +<a name="getFormula2()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFormula2</h4> +<pre>public java.lang.String getFormula2()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the formula2</dd></dl> +</li> +</ul> +<a name="getOperator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOperator</h4> +<pre>public <a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">EvaluationConditionalFormatRule.OperatorEnum</a> getOperator()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the operator</dd></dl> +</li> +</ul> +<a name="getType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getType</h4> +<pre>public <a href="../../../../../org/apache/poi/ss/usermodel/ConditionType.html" title="class in org.apache.poi.ss.usermodel">ConditionType</a> getType()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the type</dd></dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<div class="block">Defined as equal sheet name and formatting and rule indexes</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +<dt><span class="strong">See Also:</span></dt><dd><code>Object.equals(java.lang.Object)</code></dd></dl> +</li> +</ul> +<a name="compareTo(org.apache.poi.ss.formula.EvaluationConditionalFormatRule)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compareTo</h4> +<pre>public int compareTo(<a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html" title="class in org.apache.poi.ss.formula">EvaluationConditionalFormatRule</a> o)</pre> +<div class="block">Per Excel Help, XSSF rule priority is sheet-wide, not just within the owning ConditionalFormatting object. + This can be seen by creating 4 rules applying to two different ranges and examining the XML. + <p/> + HSSF priority is based on definition/persistence order.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>compareTo</code> in interface <code>java.lang.Comparable<<a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html" title="class in org.apache.poi.ss.formula">EvaluationConditionalFormatRule</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>o</code> - </dd> +<dt><span class="strong">Returns:</span></dt><dd>comparison based on sheet name, formatting index, and rule priority</dd></dl> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></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/EvaluationConditionalFormatRule.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/EvaluationCell.html" title="interface in org.apache.poi.ss.formula"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.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/EvaluationConditionalFormatRule.html" target="_top">Frames</a></li> +<li><a href="EvaluationConditionalFormatRule.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><a href="#nested_class_summary">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small> + <i>Copyright 2017 The Apache Software Foundation or + its licensors, as applicable.</i> + </small></p> +</body> +</html> Modified: poi/site/publish/apidocs/org/apache/poi/ss/formula/EvaluationName.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/EvaluationName.html?rev=1782942&r1=1782941&r2=1782942&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/EvaluationName.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/EvaluationName.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/ss/formula/EvaluationCell.html" title="interface in org.apache.poi.ss.formula"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.ValueFunction.html" title="interface in org.apache.poi.ss.formula"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/poi/ss/formula/EvaluationSheet.html" title="interface in org.apache.poi.ss.formula"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> @@ -233,7 +233,7 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/poi/ss/formula/EvaluationCell.html" title="interface in org.apache.poi.ss.formula"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.ValueFunction.html" title="interface in org.apache.poi.ss.formula"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/poi/ss/formula/EvaluationSheet.html" title="interface in org.apache.poi.ss.formula"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> Modified: poi/site/publish/apidocs/org/apache/poi/ss/formula/EvaluationWorkbook.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/EvaluationWorkbook.html?rev=1782942&r1=1782941&r2=1782942&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/EvaluationWorkbook.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/EvaluationWorkbook.html Tue Feb 14 09:47:17 2017 @@ -220,10 +220,14 @@ public interface <span class="strong">Ev <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html#getSheetName(int)">getSheetName</a></strong>(int sheetIndex)</code> </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"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html#getSpreadsheetVersion()">getSpreadsheetVersion</a></strong>()</code> </td> +</tr> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/formula/udf/UDFFinder.html" title="interface in org.apache.poi.ss.formula.udf">UDFFinder</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html#getUDFFinder()">getUDFFinder</a></strong>()</code> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html#resolveNameXText(org.apache.poi.ss.formula.ptg.NameXPtg)">resolveNameXText</a></strong>(<a href="../../../../../org/apache/poi/ss/formula/ptg/NameXPtg.html" title="class in org.apache.poi.ss.formula.ptg">NameXPtg</a> ptg)</code> </td> </tr> @@ -385,6 +389,15 @@ public interface <span class="strong">Ev <pre><a href="../../../../../org/apache/poi/ss/formula/udf/UDFFinder.html" title="interface in org.apache.poi.ss.formula.udf">UDFFinder</a> getUDFFinder()</pre> </li> </ul> +<a name="getSpreadsheetVersion()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSpreadsheetVersion</h4> +<pre><a href="../../../../../org/apache/poi/ss/SpreadsheetVersion.html" title="enum in org.apache.poi.ss">SpreadsheetVersion</a> getSpreadsheetVersion()</pre> +</li> +</ul> <a name="clearAllCachedResultValues()"> <!-- --> </a> Modified: poi/site/publish/apidocs/org/apache/poi/ss/formula/WorkbookEvaluator.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/WorkbookEvaluator.html?rev=1782942&r1=1782941&r2=1782942&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/WorkbookEvaluator.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/WorkbookEvaluator.html Tue Feb 14 09:47:17 2017 @@ -148,6 +148,22 @@ extends java.lang.Object</pre> <th class="colLast" scope="col">Method and Description</th> </tr> <tr class="altColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><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>protected boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html#adjustRegionRelativeReference(org.apache.poi.ss.formula.ptg.Ptg[],%20int,%20int)">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, + int deltaRow, + int deltaColumn)</code> +<div class="block">Adjust the formula relative cell references by a given delta</div> +</td> +</tr> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html#clearAllCachedResultValues()">clearAllCachedResultValues</a></strong>()</code> <div class="block">Should be called whenever there are changes to input cells in the evaluated workbook.</div> @@ -167,6 +183,23 @@ extends java.lang.Object</pre> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html#evaluate(org.apache.poi.ss.formula.EvaluationCell)">evaluate</a></strong>(<a href="../../../../../org/apache/poi/ss/formula/EvaluationCell.html" title="interface in org.apache.poi.ss.formula">EvaluationCell</a> srcCell)</code> </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"><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"><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/functions/FreeRefFunction.html" title="interface in org.apache.poi.ss.formula.functions">FreeRefFunction</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html#findUserDefinedFunction(java.lang.String)">findUserDefinedFunction</a></strong>(java.lang.String functionName)</code> </td> </tr> @@ -340,6 +373,75 @@ extends java.lang.Object</pre> <pre>public <a href="../../../../../org/apache/poi/ss/formula/functions/FreeRefFunction.html" title="interface in org.apache.poi.ss.formula.functions">FreeRefFunction</a> findUserDefinedFunction(java.lang.String functionName)</pre> </li> </ul> +<a name="evaluate(java.lang.String, org.apache.poi.ss.util.CellReference)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>evaluate</h4> +<pre>public <a href="../../../../../org/apache/poi/ss/formula/eval/ValueEval.html" title="interface in org.apache.poi.ss.formula.eval">ValueEval</a> evaluate(java.lang.String formula, + <a href="../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a> ref)</pre> +<div class="block">Evaluate a formula outside a cell value, e.g. conditional format rules or data validation expressions</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>formula</code> - to evaluate</dd><dd><code>ref</code> - defines the sheet and optionally row/column base for the formula, if it is relative</dd> +<dt><span class="strong">Returns:</span></dt><dd>value</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if ref does not define a sheet name to evaluate the formula on.</dd></dl> +</li> +</ul> +<a name="evaluate(java.lang.String, org.apache.poi.ss.util.CellReference, org.apache.poi.ss.util.CellRangeAddressBase)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>evaluate</h4> +<pre>public <a href="../../../../../org/apache/poi/ss/formula/eval/ValueEval.html" title="interface in org.apache.poi.ss.formula.eval">ValueEval</a> evaluate(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)</pre> +<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. When a relative formula is used, it must be evaluated by shifting by the target + offset position relative to the top left of the range.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>formula</code> - </dd><dd><code>target</code> - cell context for the operation</dd><dd><code>region</code> - containing the cell</dd> +<dt><span class="strong">Returns:</span></dt><dd>value</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if target does not define a sheet name to evaluate the formula on.</dd></dl> +</li> +</ul> +<a name="adjustRegionRelativeReference(org.apache.poi.ss.formula.ptg.Ptg[], org.apache.poi.ss.util.CellReference, org.apache.poi.ss.util.CellRangeAddressBase)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adjustRegionRelativeReference</h4> +<pre>protected boolean adjustRegionRelativeReference(<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)</pre> +<div class="block">Adjust formula relative references by the offset between the start of the given region and the given target cell.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ptgs</code> - </dd><dd><code>target</code> - cell within the region to use.</dd><dd><code>region</code> - containing the cell</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if any Ptg references were shifted</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IndexOutOfBoundsException</code> - if the resulting shifted row/column indexes are over the document format limits</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if target is not within region.</dd></dl> +</li> +</ul> +<a name="adjustRegionRelativeReference(org.apache.poi.ss.formula.ptg.Ptg[], int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adjustRegionRelativeReference</h4> +<pre>protected boolean adjustRegionRelativeReference(<a href="../../../../../org/apache/poi/ss/formula/ptg/Ptg.html" title="class in org.apache.poi.ss.formula.ptg">Ptg</a>[] ptgs, + int deltaRow, + int deltaColumn)</pre> +<div class="block">Adjust the formula relative cell references by a given delta</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ptgs</code> - </dd><dd><code>deltaRow</code> - target row offset from the top left cell of a region</dd><dd><code>deltaColumn</code> - target column offset from the top left cell of a region</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if any Ptg references were shifted</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IndexOutOfBoundsException</code> - if the resulting shifted row/column indexes are over the document format limits</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if either of the deltas are negative, as the assumption is we are shifting formulas + relative to the top left cell of a region.</dd></dl> +</li> +</ul> <a name="setIgnoreMissingWorkbooks(boolean)"> <!-- --> </a> Added: poi/site/publish/apidocs/org/apache/poi/ss/formula/class-use/ConditionalFormattingEvaluator.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/class-use/ConditionalFormattingEvaluator.html?rev=1782942&view=auto ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/class-use/ConditionalFormattingEvaluator.html (added) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/class-use/ConditionalFormattingEvaluator.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.ss.formula.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="Uses of Class org.apache.poi.ss.formula.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><a href="../../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html" title="class in org.apache.poi.ss.formula">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/poi/ss/formula/class-use/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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class org.apache.poi.ss.formula.ConditionalFormattingEvaluator" class="title">Uses of Class<br>org.apache.poi.ss.formula.ConditionalFormattingEvaluator</h2> +</div> +<div class="classUseContainer">No usage of org.apache.poi.ss.formula.ConditionalFormattingEvaluator</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html" title="class in org.apache.poi.ss.formula">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/poi/ss/formula/class-use/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> +<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/class-use/DataValidationEvaluator.DataValidationContext.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/class-use/DataValidationEvaluator.DataValidationContext.html?rev=1782942&view=auto ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/class-use/DataValidationEvaluator.DataValidationContext.html (added) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/class-use/DataValidationEvaluator.DataValidationContext.html Tue Feb 14 09:47:17 2017 @@ -0,0 +1,204 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<title>Uses of Class org.apache.poi.ss.formula.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="Uses of Class org.apache.poi.ss.formula.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><a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.DataValidationContext.html" title="class in org.apache.poi.ss.formula">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/poi/ss/formula/class-use/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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class org.apache.poi.ss.formula.DataValidationEvaluator.DataValidationContext" class="title">Uses of Class<br>org.apache.poi.ss.formula.DataValidationEvaluator.DataValidationContext</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.DataValidationContext.html" title="class in org.apache.poi.ss.formula">DataValidationEvaluator.DataValidationContext</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#org.apache.poi.ss.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> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="org.apache.poi.ss.formula"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.DataValidationContext.html" title="class in org.apache.poi.ss.formula">DataValidationEvaluator.DataValidationContext</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/formula/DataValidationEvaluator.DataValidationContext.html" title="class in org.apache.poi.ss.formula">DataValidationEvaluator.DataValidationContext</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/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> +</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/formula/DataValidationEvaluator.DataValidationContext.html" title="class in org.apache.poi.ss.formula">DataValidationEvaluator.DataValidationContext</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 static 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#getValidationValuesForConstraint(org.apache.poi.ss.formula.DataValidationEvaluator.DataValidationContext)">getValidationValuesForConstraint</a></strong>(<a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.DataValidationContext.html" title="class in org.apache.poi.ss.formula">DataValidationEvaluator.DataValidationContext</a> context)</code> +<div class="block">static so enums can reference it without creating a whole instance</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><span class="strong">DataValidationEvaluator.ValidationEnum.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.html#isValid(org.apache.poi.ss.usermodel.Cell,%20org.apache.poi.ss.formula.DataValidationEvaluator.DataValidationContext)">isValid</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell, + <a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.DataValidationContext.html" title="class in org.apache.poi.ss.formula">DataValidationEvaluator.DataValidationContext</a> context)</code> +<div class="block">Validates against the type defined in context, as an index of the enum values array.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><span class="strong">DataValidationEvaluator.ValidationEnum.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.html#isValidNumericCell(org.apache.poi.ss.usermodel.Cell,%20org.apache.poi.ss.formula.DataValidationEvaluator.DataValidationContext)">isValidNumericCell</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell, + <a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.DataValidationContext.html" title="class in org.apache.poi.ss.formula">DataValidationEvaluator.DataValidationContext</a> context)</code> +<div class="block">Uses the cell value, which may be the cached formula result value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><span class="strong">DataValidationEvaluator.ValidationEnum.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.html#isValidNumericValue(java.lang.Double,%20org.apache.poi.ss.formula.DataValidationEvaluator.DataValidationContext)">isValidNumericValue</a></strong>(java.lang.Double value, + <a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.DataValidationContext.html" title="class in org.apache.poi.ss.formula">DataValidationEvaluator.DataValidationContext</a> context)</code> +<div class="block">Is the number a valid option for the validation?</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">DataValidationEvaluator.ValidationEnum.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.html#isValidValue(org.apache.poi.ss.usermodel.Cell,%20org.apache.poi.ss.formula.DataValidationEvaluator.DataValidationContext)">isValidValue</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell, + <a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.DataValidationContext.html" title="class in org.apache.poi.ss.formula">DataValidationEvaluator.DataValidationContext</a> context)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.DataValidationContext.html" title="class in org.apache.poi.ss.formula">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/poi/ss/formula/class-use/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> +<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/class-use/DataValidationEvaluator.OperatorEnum.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/class-use/DataValidationEvaluator.OperatorEnum.html?rev=1782942&view=auto ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/class-use/DataValidationEvaluator.OperatorEnum.html (added) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/class-use/DataValidationEvaluator.OperatorEnum.html Tue Feb 14 09:47:17 2017 @@ -0,0 +1,185 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<title>Uses of Class org.apache.poi.ss.formula.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="Uses of Class org.apache.poi.ss.formula.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><a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/poi/ss/formula/class-use/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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class org.apache.poi.ss.formula.DataValidationEvaluator.OperatorEnum" class="title">Uses of Class<br>org.apache.poi.ss.formula.DataValidationEvaluator.OperatorEnum</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.OperatorEnum</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#org.apache.poi.ss.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> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="org.apache.poi.ss.formula"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.OperatorEnum</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 fields, and an explanation"> +<caption><span>Fields in <a href="../../../../../../org/apache/poi/ss/formula/package-summary.html">org.apache.poi.ss.formula</a> declared as <a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.OperatorEnum</a></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> +<tbody> +<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"><span class="strong">DataValidationEvaluator.OperatorEnum.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html#IGNORED">IGNORED</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> that return <a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.OperatorEnum</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.OperatorEnum</a></code></td> +<td class="colLast"><span class="strong">DataValidationEvaluator.OperatorEnum.</span><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="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"><span class="strong">DataValidationEvaluator.OperatorEnum.</span><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> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/poi/ss/formula/class-use/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> +<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/class-use/DataValidationEvaluator.ValidationEnum.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/class-use/DataValidationEvaluator.ValidationEnum.html?rev=1782942&view=auto ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/class-use/DataValidationEvaluator.ValidationEnum.html (added) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/class-use/DataValidationEvaluator.ValidationEnum.html Tue Feb 14 09:47:17 2017 @@ -0,0 +1,172 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<title>Uses of Class org.apache.poi.ss.formula.DataValidationEvaluator.ValidationEnum (POI API Documentation)</title> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Uses of Class org.apache.poi.ss.formula.DataValidationEvaluator.ValidationEnum (POI API Documentation)"; + } + } + catch(err) { + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.html" title="enum in org.apache.poi.ss.formula">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/poi/ss/formula/class-use/DataValidationEvaluator.ValidationEnum.html" target="_top">Frames</a></li> +<li><a href="DataValidationEvaluator.ValidationEnum.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class org.apache.poi.ss.formula.DataValidationEvaluator.ValidationEnum" class="title">Uses of Class<br>org.apache.poi.ss.formula.DataValidationEvaluator.ValidationEnum</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.ValidationEnum</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#org.apache.poi.ss.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> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="org.apache.poi.ss.formula"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.ValidationEnum</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/formula/DataValidationEvaluator.ValidationEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.ValidationEnum</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.ValidationEnum</a></code></td> +<td class="colLast"><span class="strong">DataValidationEvaluator.ValidationEnum.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.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="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.ValidationEnum</a>[]</code></td> +<td class="colLast"><span class="strong">DataValidationEvaluator.ValidationEnum.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.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> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.html" title="enum in org.apache.poi.ss.formula">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/poi/ss/formula/class-use/DataValidationEvaluator.ValidationEnum.html" target="_top">Frames</a></li> +<li><a href="DataValidationEvaluator.ValidationEnum.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> --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
