Added: poi/site/publish/apidocs/org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.html?rev=1782942&view=auto ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.html (added) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.html Tue Feb 14 09:47:17 2017 @@ -0,0 +1,480 @@ +<!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.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="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 class="navBarCell1Rev">Class</li> +<li><a href="class-use/DataValidationEvaluator.ValidationEnum.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.OperatorEnum.html" title="enum 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> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/poi/ss/formula/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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </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>Field | </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.ValidationEnum" class="title">Enum DataValidationEvaluator.ValidationEnum</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.ValidationEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.ValidationEnum</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.poi.ss.formula.DataValidationEvaluator.ValidationEnum</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.ValidationEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.ValidationEnum</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.ValidationEnum</span> +extends java.lang.Enum<<a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.ValidationEnum</a>></pre> +<div class="block">Not calling it ValidationType to avoid confusion for now with DataValidationConstraint.ValidationType. + 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.ValidationEnum.html#ANY">ANY</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.html#DATE">DATE</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.html#DECIMAL">DECIMAL</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.html#FORMULA">FORMULA</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.html#INTEGER">INTEGER</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.html#LIST">LIST</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.html#TEXT_LENGTH">TEXT_LENGTH</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.html#TIME">TIME</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>static boolean</code></td> +<td class="colLast"><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="rowColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><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="altColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><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="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><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> +<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"><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"><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> +</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="ANY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ANY</h4> +<pre>public static final <a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.ValidationEnum</a> ANY</pre> +</li> +</ul> +<a name="INTEGER"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>INTEGER</h4> +<pre>public static final <a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.ValidationEnum</a> INTEGER</pre> +</li> +</ul> +<a name="DECIMAL"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DECIMAL</h4> +<pre>public static final <a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.ValidationEnum</a> DECIMAL</pre> +</li> +</ul> +<a name="LIST"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LIST</h4> +<pre>public static final <a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.ValidationEnum</a> LIST</pre> +</li> +</ul> +<a name="DATE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DATE</h4> +<pre>public static final <a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.ValidationEnum</a> DATE</pre> +</li> +</ul> +<a name="TIME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TIME</h4> +<pre>public static final <a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.ValidationEnum</a> TIME</pre> +</li> +</ul> +<a name="TEXT_LENGTH"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TEXT_LENGTH</h4> +<pre>public static final <a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.ValidationEnum</a> TEXT_LENGTH</pre> +</li> +</ul> +<a name="FORMULA"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FORMULA</h4> +<pre>public static final <a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.ValidationEnum</a> FORMULA</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.ValidationEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.ValidationEnum</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.ValidationEnum c : DataValidationEvaluator.ValidationEnum.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.ValidationEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.ValidationEnum</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="isValidValue(org.apache.poi.ss.usermodel.Cell, org.apache.poi.ss.formula.DataValidationEvaluator.DataValidationContext)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isValidValue</h4> +<pre>public boolean isValidValue(<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)</pre> +</li> +</ul> +<a name="isValidNumericCell(org.apache.poi.ss.usermodel.Cell, org.apache.poi.ss.formula.DataValidationEvaluator.DataValidationContext)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isValidNumericCell</h4> +<pre>protected boolean isValidNumericCell(<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)</pre> +<div class="block">Uses the cell value, which may be the cached formula result value. + We won't re-evaluate cells here. This validation would be after the cell value was updated externally. + Excel allows invalid values through methods like copy/paste, and only validates them when the user + interactively edits the cell.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>if the cell is a valid numeric cell for the validation or not</dd></dl> +</li> +</ul> +<a name="isValidNumericValue(java.lang.Double, org.apache.poi.ss.formula.DataValidationEvaluator.DataValidationContext)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isValidNumericValue</h4> +<pre>protected boolean isValidNumericValue(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)</pre> +<div class="block">Is the number a valid option for the validation?</div> +</li> +</ul> +<a name="isValid(org.apache.poi.ss.usermodel.Cell, org.apache.poi.ss.formula.DataValidationEvaluator.DataValidationContext)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isValid</h4> +<pre>public static boolean isValid(<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)</pre> +<div class="block">Validates against the type defined in context, as an index of the enum values array.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cell</code> - Cell to check validity of</dd><dd><code>context</code> - The Data Validation to check against</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if validation passes</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.ArrayIndexOutOfBoundsException</code> - if the constraint type is an invalid index</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/DataValidationEvaluator.ValidationEnum.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.OperatorEnum.html" title="enum 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> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/poi/ss/formula/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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </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>Field | </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.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/DataValidationEvaluator.html?rev=1782942&view=auto ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/DataValidationEvaluator.html (added) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/DataValidationEvaluator.html Tue Feb 14 09:47:17 2017 @@ -0,0 +1,446 @@ +<!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 (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 (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.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/ConditionalFormattingEvaluator.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.DataValidationContext.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/DataValidationEvaluator.html" target="_top">Frames</a></li> +<li><a href="DataValidationEvaluator.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 DataValidationEvaluator" class="title">Class DataValidationEvaluator</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.poi.ss.formula.DataValidationEvaluator</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">DataValidationEvaluator</span> +extends java.lang.Object</pre> +<div class="block">Evaluates Data Validation constraints.<p/> + + For performance reasons, this class keeps a cache of all previously retrieved <a href="../../../../../org/apache/poi/ss/usermodel/DataValidation.html" title="interface in org.apache.poi.ss.usermodel"><code>DataValidation</code></a> instances. + Be sure to call <a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.html#clearAllCachedValues()"><code>clearAllCachedValues()</code></a> if any workbook validation definitions are + added, modified, or deleted. + <p/> + Changing cell values should be fine, as long as the corresponding <a href="../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html#clearAllCachedResultValues()"><code>WorkbookEvaluator.clearAllCachedResultValues()</code></a> + is called as well.</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/DataValidationEvaluator.DataValidationContext.html" title="class in org.apache.poi.ss.formula">DataValidationEvaluator.DataValidationContext</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.OperatorEnum</a></strong></code> +<div class="block">Not calling it OperatorType to avoid confusion for now with DataValidationConstraint.OperatorType.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.ValidationEnum.html" title="enum in org.apache.poi.ss.formula">DataValidationEvaluator.ValidationEnum</a></strong></code> +<div class="block">Not calling it ValidationType to avoid confusion for now with DataValidationConstraint.ValidationType.</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/DataValidationEvaluator.html#DataValidationEvaluator(org.apache.poi.ss.usermodel.Workbook,%20org.apache.poi.ss.formula.WorkbookEvaluatorProvider)">DataValidationEvaluator</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/DataValidationEvaluator.html#clearAllCachedValues()">clearAllCachedValues</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.DataValidationContext.html" title="class in org.apache.poi.ss.formula">DataValidationEvaluator.DataValidationContext</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.html#getValidationContextForCell(org.apache.poi.ss.util.CellReference)">getValidationContextForCell</a></strong>(<a href="../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a> cell)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/DataValidation.html" title="interface in org.apache.poi.ss.usermodel">DataValidation</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.html#getValidationForCell(org.apache.poi.ss.util.CellReference)">getValidationForCell</a></strong>(<a href="../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a> cell)</code> +<div class="block">Finds and returns the <a href="../../../../../org/apache/poi/ss/usermodel/DataValidation.html" title="interface in org.apache.poi.ss.usermodel"><code>DataValidation</code></a> for the cell, if there is + one.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../../org/apache/poi/ss/formula/eval/ValueEval.html" title="interface in org.apache.poi.ss.formula.eval">ValueEval</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.html#getValidationValuesForCell(org.apache.poi.ss.util.CellReference)">getValidationValuesForCell</a></strong>(<a href="../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a> cell)</code> +<div class="block">If <a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.html#getValidationForCell(org.apache.poi.ss.util.CellReference)"><code>getValidationForCell(CellReference)</code></a> returns an instance, and the + <a href="../../../../../org/apache/poi/ss/usermodel/DataValidationConstraint.ValidationType.html" title="class in org.apache.poi.ss.usermodel"><code>DataValidationConstraint.ValidationType</code></a> is <a href="../../../../../org/apache/poi/ss/usermodel/DataValidationConstraint.ValidationType.html#LIST"><code>DataValidationConstraint.ValidationType.LIST</code></a>, return the valid + values, whether they are from a static list or cell range.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>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"><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>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/DataValidationEvaluator.html#getWorkbookEvaluator()">getWorkbookEvaluator</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.html#isType(org.apache.poi.ss.usermodel.Cell,%20org.apache.poi.ss.usermodel.CellType)">isType</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell, + <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a> type)</code> +<div class="block">Note that this assumes the cell cached value is up to date and in sync with data edits</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/DataValidationEvaluator.html#isValidCell(org.apache.poi.ss.util.CellReference)">isValidCell</a></strong>(<a href="../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a> cellRef)</code> +<div class="block">Use the validation returned by <a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.html#getValidationForCell(org.apache.poi.ss.util.CellReference)"><code>getValidationForCell(CellReference)</code></a> if you + want the error display details.</div> +</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(org.apache.poi.ss.usermodel.Workbook, org.apache.poi.ss.formula.WorkbookEvaluatorProvider)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DataValidationEvaluator</h4> +<pre>public DataValidationEvaluator(<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="clearAllCachedValues()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clearAllCachedValues</h4> +<pre>public void clearAllCachedValues()</pre> +</li> +</ul> +<a name="getValidationForCell(org.apache.poi.ss.util.CellReference)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getValidationForCell</h4> +<pre>public <a href="../../../../../org/apache/poi/ss/usermodel/DataValidation.html" title="interface in org.apache.poi.ss.usermodel">DataValidation</a> getValidationForCell(<a href="../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a> cell)</pre> +<div class="block">Finds and returns the <a href="../../../../../org/apache/poi/ss/usermodel/DataValidation.html" title="interface in org.apache.poi.ss.usermodel"><code>DataValidation</code></a> for the cell, if there is + one. Lookup is based on the first match from + <a href="../../../../../org/apache/poi/ss/usermodel/DataValidation.html#getRegions()"><code>DataValidation.getRegions()</code></a> for the cell's sheet. DataValidation + regions must be in the same sheet as the DataValidation. Allowed values + expressions may reference other sheets, however.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cell</code> - reference to check - use this in case the cell does not actually exist yet</dd> +<dt><span class="strong">Returns:</span></dt><dd>the DataValidation applicable to the given cell, or null if no + validation applies</dd></dl> +</li> +</ul> +<a name="getValidationContextForCell(org.apache.poi.ss.util.CellReference)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getValidationContextForCell</h4> +<pre>public <a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.DataValidationContext.html" title="class in org.apache.poi.ss.formula">DataValidationEvaluator.DataValidationContext</a> getValidationContextForCell(<a href="../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a> cell)</pre> +</li> +</ul> +<a name="getValidationValuesForCell(org.apache.poi.ss.util.CellReference)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getValidationValuesForCell</h4> +<pre>public java.util.List<<a href="../../../../../org/apache/poi/ss/formula/eval/ValueEval.html" title="interface in org.apache.poi.ss.formula.eval">ValueEval</a>> getValidationValuesForCell(<a href="../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a> cell)</pre> +<div class="block">If <a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.html#getValidationForCell(org.apache.poi.ss.util.CellReference)"><code>getValidationForCell(CellReference)</code></a> returns an instance, and the + <a href="../../../../../org/apache/poi/ss/usermodel/DataValidationConstraint.ValidationType.html" title="class in org.apache.poi.ss.usermodel"><code>DataValidationConstraint.ValidationType</code></a> is <a href="../../../../../org/apache/poi/ss/usermodel/DataValidationConstraint.ValidationType.html#LIST"><code>DataValidationConstraint.ValidationType.LIST</code></a>, return the valid + values, whether they are from a static list or cell range. + <p/> + For all other validation types, or no validation at all, this method + returns null. + <p/> + This method could throw an exception if the validation type is not LIST, + but since this method is mostly useful in UI contexts, null seems the + easier path.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cell</code> - reference to check - use this in case the cell does not actually exist yet</dd> +<dt><span class="strong">Returns:</span></dt><dd>returns an unmodifiable <code>List</code> of <a href="../../../../../org/apache/poi/ss/formula/eval/ValueEval.html" title="interface in org.apache.poi.ss.formula.eval"><code>ValueEval</code></a>s if applicable, or + null</dd></dl> +</li> +</ul> +<a name="getValidationValuesForConstraint(org.apache.poi.ss.formula.DataValidationEvaluator.DataValidationContext)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getValidationValuesForConstraint</h4> +<pre>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>> getValidationValuesForConstraint(<a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.DataValidationContext.html" title="class in org.apache.poi.ss.formula">DataValidationEvaluator.DataValidationContext</a> context)</pre> +<div class="block">static so enums can reference it without creating a whole instance</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>returns an unmodifiable <code>List</code> of <a href="../../../../../org/apache/poi/ss/formula/eval/ValueEval.html" title="interface in org.apache.poi.ss.formula.eval"><code>ValueEval</code></a>s, which may be empty</dd></dl> +</li> +</ul> +<a name="isValidCell(org.apache.poi.ss.util.CellReference)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isValidCell</h4> +<pre>public boolean isValidCell(<a href="../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a> cellRef)</pre> +<div class="block">Use the validation returned by <a href="../../../../../org/apache/poi/ss/formula/DataValidationEvaluator.html#getValidationForCell(org.apache.poi.ss.util.CellReference)"><code>getValidationForCell(CellReference)</code></a> if you + want the error display details. This is the validation checked by this + method, which attempts to replicate Excel's data validation rules. + <p/> + Note that to properly apply some validations, care must be taken to + offset the base validation formula by the relative position of the + current cell, or the wrong value is checked.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cellRef</code> - The reference of the cell to evaluate</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if the cell has no validation or the cell value passes the + defined validation, false if it fails</dd></dl> +</li> +</ul> +<a name="isType(org.apache.poi.ss.usermodel.Cell, org.apache.poi.ss.usermodel.CellType)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isType</h4> +<pre>public static boolean isType(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell, + <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a> type)</pre> +<div class="block">Note that this assumes the cell cached value is up to date and in sync with data edits</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cell</code> - </dd><dd><code>type</code> - </dd> +<dt><span class="strong">Returns:</span></dt><dd>true if the cell or cached cell formula result type match the given type</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.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/ConditionalFormattingEvaluator.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.DataValidationContext.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/DataValidationEvaluator.html" target="_top">Frames</a></li> +<li><a href="DataValidationEvaluator.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/EvaluationCell.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/EvaluationCell.html?rev=1782942&r1=1782941&r2=1782942&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/EvaluationCell.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/EvaluationCell.html Tue Feb 14 09:47:17 2017 @@ -38,8 +38,8 @@ </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/EvaluationName.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/DataValidationEvaluator.ValidationEnum.html" title="enum in org.apache.poi.ss.formula"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.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/EvaluationCell.html" target="_top">Frames</a></li> @@ -348,8 +348,8 @@ </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/EvaluationName.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/DataValidationEvaluator.ValidationEnum.html" title="enum in org.apache.poi.ss.formula"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.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/EvaluationCell.html" target="_top">Frames</a></li> Added: poi/site/publish/apidocs/org/apache/poi/ss/formula/EvaluationConditionalFormatRule.OperatorEnum.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/EvaluationConditionalFormatRule.OperatorEnum.html?rev=1782942&view=auto ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/EvaluationConditionalFormatRule.OperatorEnum.html (added) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/EvaluationConditionalFormatRule.OperatorEnum.html Tue Feb 14 09:47:17 2017 @@ -0,0 +1,441 @@ +<!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.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="EvaluationConditionalFormatRule.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/EvaluationConditionalFormatRule.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/EvaluationConditionalFormatRule.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/EvaluationConditionalFormatRule.ValueAndFormat.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/EvaluationConditionalFormatRule.OperatorEnum.html" target="_top">Frames</a></li> +<li><a href="EvaluationConditionalFormatRule.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>Field | </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>Field | </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 EvaluationConditionalFormatRule.OperatorEnum" class="title">Enum EvaluationConditionalFormatRule.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/EvaluationConditionalFormatRule.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">EvaluationConditionalFormatRule.OperatorEnum</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.poi.ss.formula.EvaluationConditionalFormatRule.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/EvaluationConditionalFormatRule.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">EvaluationConditionalFormatRule.OperatorEnum</a>></dd> +</dl> +<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>public static enum <span class="strong">EvaluationConditionalFormatRule.OperatorEnum</span> +extends java.lang.Enum<<a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">EvaluationConditionalFormatRule.OperatorEnum</a>></pre> +<div class="block">Not calling it OperatorType to avoid confusion for now with other classes. + Definition order matches OOXML type ID indexes. + Note that this has NO_COMPARISON as the first item, unlike the similar + DataValidation operator enum. Thanks, Microsoft.</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/EvaluationConditionalFormatRule.OperatorEnum.html#BETWEEN">BETWEEN</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.OperatorEnum.html#EQUAL">EQUAL</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.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/EvaluationConditionalFormatRule.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/EvaluationConditionalFormatRule.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/EvaluationConditionalFormatRule.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/EvaluationConditionalFormatRule.OperatorEnum.html#NO_COMPARISON">NO_COMPARISON</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.OperatorEnum.html#NOT_BETWEEN">NOT_BETWEEN</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.OperatorEnum.html#NOT_EQUAL">NOT_EQUAL</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 <C extends java.lang.Comparable<C>> <br>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.OperatorEnum.html#isValid(C,%20C,%20C)">isValid</a></strong>(C cellValue, + C v1, + C 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/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.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/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.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="NO_COMPARISON"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NO_COMPARISON</h4> +<pre>public static final <a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">EvaluationConditionalFormatRule.OperatorEnum</a> NO_COMPARISON</pre> +</li> +</ul> +<a name="BETWEEN"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>BETWEEN</h4> +<pre>public static final <a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">EvaluationConditionalFormatRule.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/EvaluationConditionalFormatRule.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">EvaluationConditionalFormatRule.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/EvaluationConditionalFormatRule.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">EvaluationConditionalFormatRule.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/EvaluationConditionalFormatRule.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">EvaluationConditionalFormatRule.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/EvaluationConditionalFormatRule.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">EvaluationConditionalFormatRule.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/EvaluationConditionalFormatRule.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">EvaluationConditionalFormatRule.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/EvaluationConditionalFormatRule.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">EvaluationConditionalFormatRule.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/EvaluationConditionalFormatRule.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">EvaluationConditionalFormatRule.OperatorEnum</a> LESS_OR_EQUAL</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/EvaluationConditionalFormatRule.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">EvaluationConditionalFormatRule.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 (EvaluationConditionalFormatRule.OperatorEnum c : EvaluationConditionalFormatRule.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/EvaluationConditionalFormatRule.OperatorEnum.html" title="enum in org.apache.poi.ss.formula">EvaluationConditionalFormatRule.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.Comparable,java.lang.Comparable,java.lang.Comparable)"> +<!-- --> +</a><a name="isValid(C, C, C)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isValid</h4> +<pre>public abstract <C extends java.lang.Comparable<C>> boolean isValid(C cellValue, + C v1, + C 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/EvaluationConditionalFormatRule.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/EvaluationConditionalFormatRule.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/EvaluationConditionalFormatRule.ValueAndFormat.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/EvaluationConditionalFormatRule.OperatorEnum.html" target="_top">Frames</a></li> +<li><a href="EvaluationConditionalFormatRule.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>Field | </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>Field | </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.ValueAndFormat.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/EvaluationConditionalFormatRule.ValueAndFormat.html?rev=1782942&view=auto ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/EvaluationConditionalFormatRule.ValueAndFormat.html (added) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/EvaluationConditionalFormatRule.ValueAndFormat.html Tue Feb 14 09:47:17 2017 @@ -0,0 +1,356 @@ +<!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.ValueAndFormat (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.ValueAndFormat (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.ValueAndFormat.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.OperatorEnum.html" title="enum 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">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/poi/ss/formula/EvaluationConditionalFormatRule.ValueAndFormat.html" target="_top">Frames</a></li> +<li><a href="EvaluationConditionalFormatRule.ValueAndFormat.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 EvaluationConditionalFormatRule.ValueAndFormat" class="title">Class EvaluationConditionalFormatRule.ValueAndFormat</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.poi.ss.formula.EvaluationConditionalFormatRule.ValueAndFormat</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.ValueAndFormat.html" title="class in org.apache.poi.ss.formula">EvaluationConditionalFormatRule.ValueAndFormat</a>></dd> +</dl> +<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 class <span class="strong">EvaluationConditionalFormatRule.ValueAndFormat</span> +extends java.lang.Object +implements java.lang.Comparable<<a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.ValueAndFormat.html" title="class in org.apache.poi.ss.formula">EvaluationConditionalFormatRule.ValueAndFormat</a>></pre> +<div class="block">Note: this class has a natural ordering that is inconsistent with equals.</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/EvaluationConditionalFormatRule.ValueAndFormat.html#EvaluationConditionalFormatRule.ValueAndFormat(java.lang.Double,%20java.lang.String)">EvaluationConditionalFormatRule.ValueAndFormat</a></strong>(java.lang.Double value, + java.lang.String format)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.ValueAndFormat.html#EvaluationConditionalFormatRule.ValueAndFormat(java.lang.String,%20java.lang.String)">EvaluationConditionalFormatRule.ValueAndFormat</a></strong>(java.lang.String value, + java.lang.String format)</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.ValueAndFormat.html#compareTo(org.apache.poi.ss.formula.EvaluationConditionalFormatRule.ValueAndFormat)">compareTo</a></strong>(<a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.ValueAndFormat.html" title="class in org.apache.poi.ss.formula">EvaluationConditionalFormatRule.ValueAndFormat</a> o)</code> +<div class="block">Note: this class has a natural ordering that is inconsistent with equals.</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.ValueAndFormat.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Double</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.ValueAndFormat.html#getValue()">getValue</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.ValueAndFormat.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.ValueAndFormat.html#isNumber()">isNumber</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.ValueAndFormat(java.lang.Double, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EvaluationConditionalFormatRule.ValueAndFormat</h4> +<pre>public EvaluationConditionalFormatRule.ValueAndFormat(java.lang.Double value, + java.lang.String format)</pre> +</li> +</ul> +<a name="EvaluationConditionalFormatRule.ValueAndFormat(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>EvaluationConditionalFormatRule.ValueAndFormat</h4> +<pre>public EvaluationConditionalFormatRule.ValueAndFormat(java.lang.String value, + java.lang.String format)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="isNumber()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isNumber</h4> +<pre>public boolean isNumber()</pre> +</li> +</ul> +<a name="getValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getValue</h4> +<pre>public java.lang.Double getValue()</pre> +</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> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="compareTo(org.apache.poi.ss.formula.EvaluationConditionalFormatRule.ValueAndFormat)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compareTo</h4> +<pre>public int compareTo(<a href="../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.ValueAndFormat.html" title="class in org.apache.poi.ss.formula">EvaluationConditionalFormatRule.ValueAndFormat</a> o)</pre> +<div class="block">Note: this class has a natural ordering that is inconsistent with equals.</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.ValueAndFormat.html" title="class in org.apache.poi.ss.formula">EvaluationConditionalFormatRule.ValueAndFormat</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>o</code> - </dd> +<dt><span class="strong">Returns:</span></dt><dd>value comparison</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.ValueAndFormat.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.OperatorEnum.html" title="enum 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">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/poi/ss/formula/EvaluationConditionalFormatRule.ValueAndFormat.html" target="_top">Frames</a></li> +<li><a href="EvaluationConditionalFormatRule.ValueAndFormat.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> --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
