Modified: poi/site/publish/apidocs/org/apache/poi/ss/formula/package-use.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/package-use.html?rev=1782942&r1=1782941&r2=1782942&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/package-use.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/package-use.html Tue Feb 14 09:47:17 2017 @@ -361,89 +361,125 @@ <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/CollaboratingWorkbooksEnvironment.WorkbookNotFoundException.html#org.apache.poi.ss.formula">CollaboratingWorkbooksEnvironment.WorkbookNotFoundException</a> </td> </tr> <tr class="rowColor"> +<td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/DataValidationEvaluator.html#org.apache.poi.ss.formula">DataValidationEvaluator</a> +<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.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/DataValidationEvaluator.DataValidationContext.html#org.apache.poi.ss.formula">DataValidationEvaluator.DataValidationContext</a> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/DataValidationEvaluator.OperatorEnum.html#org.apache.poi.ss.formula">DataValidationEvaluator.OperatorEnum</a> +<div class="block">Not calling it OperatorType to avoid confusion for now with DataValidationConstraint.OperatorType.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/DataValidationEvaluator.ValidationEnum.html#org.apache.poi.ss.formula">DataValidationEvaluator.ValidationEnum</a> +<div class="block">Not calling it ValidationType to avoid confusion for now with DataValidationConstraint.ValidationType.</div> +</td> +</tr> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/EvaluationCell.html#org.apache.poi.ss.formula">EvaluationCell</a> <div class="block">Abstracts a cell for the purpose of formula evaluation.</div> </td> </tr> <tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/EvaluationConditionalFormatRule.html#org.apache.poi.ss.formula">EvaluationConditionalFormatRule</a> +<div class="block">Abstracted and cached version of a Conditional Format rule for use with a + <a href="../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html" title="class in org.apache.poi.ss.formula"><code>ConditionalFormattingEvaluator</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/EvaluationConditionalFormatRule.OperatorEnum.html#org.apache.poi.ss.formula">EvaluationConditionalFormatRule.OperatorEnum</a> +<div class="block">Not calling it OperatorType to avoid confusion for now with other classes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/EvaluationConditionalFormatRule.ValueAndFormat.html#org.apache.poi.ss.formula">EvaluationConditionalFormatRule.ValueAndFormat</a> +<div class="block">Note: this class has a natural ordering that is inconsistent with equals.</div> +</td> +</tr> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/EvaluationName.html#org.apache.poi.ss.formula">EvaluationName</a> <div class="block">Abstracts a name record for formula evaluation.<br/> For POI internal use only</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/EvaluationSheet.html#org.apache.poi.ss.formula">EvaluationSheet</a> <div class="block">Abstracts a sheet for the purpose of formula evaluation.<br/> For POI internal use only</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/EvaluationWorkbook.html#org.apache.poi.ss.formula">EvaluationWorkbook</a> <div class="block">Abstracts a workbook for the purpose of formula evaluation.<br/> For POI internal use only</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/EvaluationWorkbook.ExternalName.html#org.apache.poi.ss.formula">EvaluationWorkbook.ExternalName</a> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/EvaluationWorkbook.ExternalSheet.html#org.apache.poi.ss.formula">EvaluationWorkbook.ExternalSheet</a> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/Formula.html#org.apache.poi.ss.formula">Formula</a> <div class="block">Encapsulates an encoded formula token array.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/FormulaParsingWorkbook.html#org.apache.poi.ss.formula">FormulaParsingWorkbook</a> <div class="block">Abstracts a workbook for the purpose of formula parsing.<br/> For POI internal use only</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/FormulaRenderingWorkbook.html#org.apache.poi.ss.formula">FormulaRenderingWorkbook</a> <div class="block">Abstracts a workbook for the purpose of converting formula to text.<br/> For POI internal use only</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/FormulaShifter.html#org.apache.poi.ss.formula">FormulaShifter</a> <div class="block">Updates Formulas as rows or sheets are shifted</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/FormulaType.html#org.apache.poi.ss.formula">FormulaType</a> <div class="block">Enumeration of various formula types.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/IStabilityClassifier.html#org.apache.poi.ss.formula">IStabilityClassifier</a> <div class="block">Used to help optimise cell evaluation result caching by allowing applications to specify which parts of a workbook are <em>final</em>.<br/> The term <b>final</b> is introduced here to denote immutability or 'having constant definition'.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/NameIdentifier.html#org.apache.poi.ss.formula">NameIdentifier</a> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/SheetIdentifier.html#org.apache.poi.ss.formula">SheetIdentifier</a> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/SheetRange.html#org.apache.poi.ss.formula">SheetRange</a> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/TwoDEval.html#org.apache.poi.ss.formula">TwoDEval</a> <div class="block">Common interface of <a href="../../../../../org/apache/poi/ss/formula/eval/AreaEval.html" title="interface in org.apache.poi.ss.formula.eval"><code>AreaEval</code></a> and <a href="../../../../../org/apache/poi/ss/formula/eval/AreaEvalBase.html" title="class in org.apache.poi.ss.formula.eval"><code>AreaEvalBase</code></a>, for 2D (row+column) evaluations</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/WorkbookEvaluator.html#org.apache.poi.ss.formula">WorkbookEvaluator</a> <div class="block">Evaluates formula cells.<p/> @@ -451,7 +487,7 @@ cell values.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/WorkbookEvaluatorProvider.html#org.apache.poi.ss.formula">WorkbookEvaluatorProvider</a> <div class="block">Provides access to a <a href="../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html" title="class in org.apache.poi.ss.formula"><code>WorkbookEvaluator</code></a>, eg for use with <a href="../../../../../org/apache/poi/ss/formula/CollaboratingWorkbooksEnvironment.html" title="class in org.apache.poi.ss.formula"><code>CollaboratingWorkbooksEnvironment</code></a></div>
Modified: poi/site/publish/apidocs/org/apache/poi/ss/formula/ptg/class-use/Ptg.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/ptg/class-use/Ptg.html?rev=1782942&r1=1782941&r2=1782942&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/ptg/class-use/Ptg.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/ptg/class-use/Ptg.html Tue Feb 14 09:47:17 2017 @@ -624,6 +624,22 @@ int currentExternSheetIx)</code> </td> </tr> <tr class="rowColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><span class="strong">WorkbookEvaluator.</span><code><strong><a href="../../../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html#adjustRegionRelativeReference(org.apache.poi.ss.formula.ptg.Ptg[],%20org.apache.poi.ss.util.CellReference,%20org.apache.poi.ss.util.CellRangeAddressBase)">adjustRegionRelativeReference</a></strong>(<a href="../../../../../../../org/apache/poi/ss/formula/ptg/Ptg.html" title="class in org.apache.poi.ss.formula.ptg">Ptg</a>[] ptgs, + <a href="../../../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a> target, + <a href="../../../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html" title="class in org.apache.poi.ss.util">CellRangeAddressBase</a> region)</code> +<div class="block">Adjust formula relative references by the offset between the start of the given region and the given target cell.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><span class="strong">WorkbookEvaluator.</span><code><strong><a href="../../../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html#adjustRegionRelativeReference(org.apache.poi.ss.formula.ptg.Ptg[],%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="rowColor"> <td class="colFirst"><code><a href="../../../../../../../org/apache/poi/ss/formula/ptg/Ptg.html" title="class in org.apache.poi.ss.formula.ptg">Ptg</a>[]</code></td> <td class="colLast"><span class="strong">SharedFormula.</span><code><strong><a href="../../../../../../../org/apache/poi/ss/formula/SharedFormula.html#convertSharedFormulas(org.apache.poi.ss.formula.ptg.Ptg[],%20int,%20int)">convertSharedFormulas</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 formulaRow, Added: poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ConditionFilterData.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ConditionFilterData.html?rev=1782942&view=auto ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ConditionFilterData.html (added) +++ poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ConditionFilterData.html Tue Feb 14 09:47:17 2017 @@ -0,0 +1,288 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<title>ConditionFilterData (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="ConditionFilterData (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/ConditionFilterData.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingThreshold.RangeType.html" title="enum in org.apache.poi.ss.usermodel"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html" title="enum in org.apache.poi.ss.usermodel"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/poi/ss/usermodel/ConditionFilterData.html" target="_top">Frames</a></li> +<li><a href="ConditionFilterData.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.usermodel</div> +<h2 title="Interface ConditionFilterData" class="title">Interface ConditionFilterData</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFConditionFilterData.html" title="class in org.apache.poi.xssf.usermodel">XSSFConditionFilterData</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">ConditionFilterData</span></pre> +<div class="block">These values are needed by various conditional formatting evaluation filter types</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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html#getAboveAverage()">getAboveAverage</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html#getBottom()">getBottom</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html#getEqualAverage()">getEqualAverage</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html#getPercent()">getPercent</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html#getRank()">getRank</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html#getStdDev()">getStdDev</a></strong>()</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="getAboveAverage()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAboveAverage</h4> +<pre>boolean getAboveAverage()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if the flag is missing or set to true</dd></dl> +</li> +</ul> +<a name="getBottom()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBottom</h4> +<pre>boolean getBottom()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if the flag is set</dd></dl> +</li> +</ul> +<a name="getEqualAverage()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEqualAverage</h4> +<pre>boolean getEqualAverage()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if the flag is set</dd></dl> +</li> +</ul> +<a name="getPercent()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPercent</h4> +<pre>boolean getPercent()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if the flag is set</dd></dl> +</li> +</ul> +<a name="getRank()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRank</h4> +<pre>long getRank()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>value, or 0 if not used/defined</dd></dl> +</li> +</ul> +<a name="getStdDev()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getStdDev</h4> +<pre>int getStdDev()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>value, or 0 if not used/defined</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ConditionFilterData.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingThreshold.RangeType.html" title="enum in org.apache.poi.ss.usermodel"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html" title="enum in org.apache.poi.ss.usermodel"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/poi/ss/usermodel/ConditionFilterData.html" target="_top">Frames</a></li> +<li><a href="ConditionFilterData.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/usermodel/ConditionFilterType.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ConditionFilterType.html?rev=1782942&view=auto ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ConditionFilterType.html (added) +++ poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ConditionFilterType.html Tue Feb 14 09:47:17 2017 @@ -0,0 +1,477 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<title>ConditionFilterType (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="ConditionFilterType (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/ConditionFilterType.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html" title="interface in org.apache.poi.ss.usermodel"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/poi/ss/usermodel/ConditionType.html" title="class in org.apache.poi.ss.usermodel"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/poi/ss/usermodel/ConditionFilterType.html" target="_top">Frames</a></li> +<li><a href="ConditionFilterType.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.usermodel</div> +<h2 title="Enum ConditionFilterType" class="title">Enum ConditionFilterType</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/usermodel/ConditionFilterType.html" title="enum in org.apache.poi.ss.usermodel">ConditionFilterType</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.poi.ss.usermodel.ConditionFilterType</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/usermodel/ConditionFilterType.html" title="enum in org.apache.poi.ss.usermodel">ConditionFilterType</a>></dd> +</dl> +<hr> +<br> +<pre>public enum <span class="strong">ConditionFilterType</span> +extends java.lang.Enum<<a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html" title="enum in org.apache.poi.ss.usermodel">ConditionFilterType</a>></pre> +<div class="block">Used primarily for XSSF conditions, which defines a multitude of additional "filter" types + for conditional formatting. HSSF rules will always be null (not a filter type) or #FILTER. + XSSF conditions will be null (not a filter type) or any value other than #FILTER. + <p/> + Instance names match the constants from <code>STCfType</code> for convenience.</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/usermodel/ConditionFilterType.html#ABOVE_AVERAGE">ABOVE_AVERAGE</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html#BEGINS_WITH">BEGINS_WITH</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html#CONTAINS_BLANKS">CONTAINS_BLANKS</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html#CONTAINS_ERRORS">CONTAINS_ERRORS</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html#CONTAINS_TEXT">CONTAINS_TEXT</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html#DUPLICATE_VALUES">DUPLICATE_VALUES</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html#ENDS_WITH">ENDS_WITH</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html#FILTER">FILTER</a></strong></code> +<div class="block">This is the only value valid for HSSF rules</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html#NOT_CONTAINS_BLANKS">NOT_CONTAINS_BLANKS</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html#NOT_CONTAINS_ERRORS">NOT_CONTAINS_ERRORS</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html#NOT_CONTAINS_TEXT">NOT_CONTAINS_TEXT</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html#TIME_PERIOD">TIME_PERIOD</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html#TOP_10">TOP_10</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html#UNIQUE_VALUES">UNIQUE_VALUES</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 <a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html" title="enum in org.apache.poi.ss.usermodel">ConditionFilterType</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.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/usermodel/ConditionFilterType.html" title="enum in org.apache.poi.ss.usermodel">ConditionFilterType</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.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="FILTER"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FILTER</h4> +<pre>public static final <a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html" title="enum in org.apache.poi.ss.usermodel">ConditionFilterType</a> FILTER</pre> +<div class="block">This is the only value valid for HSSF rules</div> +</li> +</ul> +<a name="TOP_10"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TOP_10</h4> +<pre>public static final <a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html" title="enum in org.apache.poi.ss.usermodel">ConditionFilterType</a> TOP_10</pre> +</li> +</ul> +<a name="UNIQUE_VALUES"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>UNIQUE_VALUES</h4> +<pre>public static final <a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html" title="enum in org.apache.poi.ss.usermodel">ConditionFilterType</a> UNIQUE_VALUES</pre> +</li> +</ul> +<a name="DUPLICATE_VALUES"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DUPLICATE_VALUES</h4> +<pre>public static final <a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html" title="enum in org.apache.poi.ss.usermodel">ConditionFilterType</a> DUPLICATE_VALUES</pre> +</li> +</ul> +<a name="CONTAINS_TEXT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CONTAINS_TEXT</h4> +<pre>public static final <a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html" title="enum in org.apache.poi.ss.usermodel">ConditionFilterType</a> CONTAINS_TEXT</pre> +</li> +</ul> +<a name="NOT_CONTAINS_TEXT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NOT_CONTAINS_TEXT</h4> +<pre>public static final <a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html" title="enum in org.apache.poi.ss.usermodel">ConditionFilterType</a> NOT_CONTAINS_TEXT</pre> +</li> +</ul> +<a name="BEGINS_WITH"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>BEGINS_WITH</h4> +<pre>public static final <a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html" title="enum in org.apache.poi.ss.usermodel">ConditionFilterType</a> BEGINS_WITH</pre> +</li> +</ul> +<a name="ENDS_WITH"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ENDS_WITH</h4> +<pre>public static final <a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html" title="enum in org.apache.poi.ss.usermodel">ConditionFilterType</a> ENDS_WITH</pre> +</li> +</ul> +<a name="CONTAINS_BLANKS"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CONTAINS_BLANKS</h4> +<pre>public static final <a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html" title="enum in org.apache.poi.ss.usermodel">ConditionFilterType</a> CONTAINS_BLANKS</pre> +</li> +</ul> +<a name="NOT_CONTAINS_BLANKS"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NOT_CONTAINS_BLANKS</h4> +<pre>public static final <a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html" title="enum in org.apache.poi.ss.usermodel">ConditionFilterType</a> NOT_CONTAINS_BLANKS</pre> +</li> +</ul> +<a name="CONTAINS_ERRORS"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CONTAINS_ERRORS</h4> +<pre>public static final <a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html" title="enum in org.apache.poi.ss.usermodel">ConditionFilterType</a> CONTAINS_ERRORS</pre> +</li> +</ul> +<a name="NOT_CONTAINS_ERRORS"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NOT_CONTAINS_ERRORS</h4> +<pre>public static final <a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html" title="enum in org.apache.poi.ss.usermodel">ConditionFilterType</a> NOT_CONTAINS_ERRORS</pre> +</li> +</ul> +<a name="TIME_PERIOD"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TIME_PERIOD</h4> +<pre>public static final <a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html" title="enum in org.apache.poi.ss.usermodel">ConditionFilterType</a> TIME_PERIOD</pre> +</li> +</ul> +<a name="ABOVE_AVERAGE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ABOVE_AVERAGE</h4> +<pre>public static final <a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html" title="enum in org.apache.poi.ss.usermodel">ConditionFilterType</a> ABOVE_AVERAGE</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/usermodel/ConditionFilterType.html" title="enum in org.apache.poi.ss.usermodel">ConditionFilterType</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 (ConditionFilterType c : ConditionFilterType.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="blockListLast"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html" title="enum in org.apache.poi.ss.usermodel">ConditionFilterType</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> +</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/ConditionFilterType.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html" title="interface in org.apache.poi.ss.usermodel"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/poi/ss/usermodel/ConditionType.html" title="class in org.apache.poi.ss.usermodel"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/poi/ss/usermodel/ConditionFilterType.html" target="_top">Frames</a></li> +<li><a href="ConditionFilterType.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> Modified: poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ConditionType.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ConditionType.html?rev=1782942&r1=1782941&r2=1782942&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ConditionType.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ConditionType.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/usermodel/ConditionalFormattingThreshold.RangeType.html" title="enum in org.apache.poi.ss.usermodel"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html" title="enum in org.apache.poi.ss.usermodel"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/poi/ss/usermodel/CreationHelper.html" title="interface in org.apache.poi.ss.usermodel"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> @@ -364,7 +364,7 @@ extends java.lang.Object</pre> </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingThreshold.RangeType.html" title="enum in org.apache.poi.ss.usermodel"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html" title="enum in org.apache.poi.ss.usermodel"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/poi/ss/usermodel/CreationHelper.html" title="interface in org.apache.poi.ss.usermodel"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> Modified: poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ConditionalFormattingRule.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ConditionalFormattingRule.html?rev=1782942&r1=1782941&r2=1782942&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ConditionalFormattingRule.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ConditionalFormattingRule.html Tue Feb 14 09:47:17 2017 @@ -151,15 +151,35 @@ </td> </tr> <tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html" title="enum in org.apache.poi.ss.usermodel">ConditionFilterType</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html#getConditionFilterType()">getConditionFilterType</a></strong>()</code> +<div class="block">This is null if + <p/> + <code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html#getConditionType()"><code>getConditionType()</code></a> != <a href="../../../../../org/apache/poi/ss/usermodel/ConditionType.html#FILTER"><code>ConditionType.FILTER</code></a></code> + <p/> + This is always <a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html#FILTER"><code>ConditionFilterType.FILTER</code></a> for HSSF rules of type <a href="../../../../../org/apache/poi/ss/usermodel/ConditionType.html#FILTER"><code>ConditionType.FILTER</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionType.html" title="class in org.apache.poi.ss.usermodel">ConditionType</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html#getConditionType()">getConditionType</a></strong>()</code> <div class="block">Type of conditional formatting rule.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/DataBarFormatting.html" title="interface in org.apache.poi.ss.usermodel">DataBarFormatting</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html#getDataBarFormatting()">getDataBarFormatting</a></strong>()</code> </td> </tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html" title="interface in org.apache.poi.ss.usermodel">ConditionFilterData</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html#getFilterConfiguration()">getFilterConfiguration</a></strong>()</code> +<div class="block">This is null if + <p/> + <code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html#getConditionFilterType()"><code>getConditionFilterType()</code></a> == null</code> + <p/> + This means it is always null for HSSF, which does not define the extended condition types.</div> +</td> +</tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/FontFormatting.html" title="interface in org.apache.poi.ss.usermodel">FontFormatting</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html#getFontFormatting()">getFontFormatting</a></strong>()</code> </td> @@ -186,6 +206,19 @@ <td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/PatternFormatting.html" title="interface in org.apache.poi.ss.usermodel">PatternFormatting</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html#getPatternFormatting()">getPatternFormatting</a></strong>()</code> </td> </tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html#getPriority()">getPriority</a></strong>()</code> +<div class="block">HSSF just returns 0, XSSF uses the value stored in the model if present, + otherwise uses 0.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html#getStopIfTrue()">getStopIfTrue</a></strong>()</code> +<div class="block">Always true for HSSF rules, optional flag for XSSF rules.</div> +</td> +</tr> </table> </li> </ul> @@ -308,6 +341,40 @@ <dl><dt><span class="strong">Returns:</span></dt><dd>the type of condition</dd></dl> </li> </ul> +<a name="getConditionFilterType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConditionFilterType</h4> +<pre><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html" title="enum in org.apache.poi.ss.usermodel">ConditionFilterType</a> getConditionFilterType()</pre> +<div class="block">This is null if + <p/> + <code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html#getConditionType()"><code>getConditionType()</code></a> != <a href="../../../../../org/apache/poi/ss/usermodel/ConditionType.html#FILTER"><code>ConditionType.FILTER</code></a></code> + <p/> + This is always <a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterType.html#FILTER"><code>ConditionFilterType.FILTER</code></a> for HSSF rules of type <a href="../../../../../org/apache/poi/ss/usermodel/ConditionType.html#FILTER"><code>ConditionType.FILTER</code></a>. + <p/> + For XSSF filter rules, this will indicate the specific type of filter.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>filter type for filter rules, or null if not a filter rule.</dd></dl> +</li> +</ul> +<a name="getFilterConfiguration()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilterConfiguration</h4> +<pre><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html" title="interface in org.apache.poi.ss.usermodel">ConditionFilterData</a> getFilterConfiguration()</pre> +<div class="block">This is null if + <p/> + <code><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html#getConditionFilterType()"><code>getConditionFilterType()</code></a> == null</code> + <p/> + This means it is always null for HSSF, which does not define the extended condition types. + <p/> + This object contains the additional configuration information for XSSF filter conditions.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the Filter Configuration Data, or null if there isn't any</dd></dl> +</li> +</ul> <a name="getComparisonOperation()"> <!-- --> </a> @@ -346,7 +413,7 @@ <a name="getFormula2()"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>getFormula2</h4> <pre>java.lang.String getFormula2()</pre> @@ -356,6 +423,34 @@ <dl><dt><span class="strong">Returns:</span></dt><dd>the second formula</dd></dl> </li> </ul> +<a name="getPriority()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPriority</h4> +<pre>int getPriority()</pre> +<div class="block">HSSF just returns 0, XSSF uses the value stored in the model if present, + otherwise uses 0. + <p/> + If priority is 0, just use definition order, as that's how HSSF rules are evaluated. + <p/> + If a rule is created but not yet added to a sheet, this value may not be valid.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>rule priority</dd></dl> +</li> +</ul> +<a name="getStopIfTrue()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getStopIfTrue</h4> +<pre>boolean getStopIfTrue()</pre> +<div class="block">Always true for HSSF rules, optional flag for XSSF rules. + See Excel help for more.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if conditional formatting rule processing stops when this one is true, false if not</dd><dt><span class="strong">See Also:</span></dt><dd><a href="https://support.office.com/en-us/article/Manage-conditional-formatting-rule-precedence-063cde21-516e-45ca-83f5-8e8126076249">Microsoft Excel help</a></dd></dl> +</li> +</ul> </li> </ul> </li> Modified: poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ConditionalFormattingThreshold.RangeType.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ConditionalFormattingThreshold.RangeType.html?rev=1782942&r1=1782941&r2=1782942&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ConditionalFormattingThreshold.RangeType.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/usermodel/ConditionalFormattingThreshold.RangeType.html Tue Feb 14 09:47:17 2017 @@ -39,7 +39,7 @@ <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingThreshold.html" title="interface in org.apache.poi.ss.usermodel"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/poi/ss/usermodel/ConditionType.html" title="class in org.apache.poi.ss.usermodel"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html" title="interface in org.apache.poi.ss.usermodel"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/poi/ss/usermodel/ConditionalFormattingThreshold.RangeType.html" target="_top">Frames</a></li> @@ -457,7 +457,7 @@ not permitted.)</div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingThreshold.html" title="interface in org.apache.poi.ss.usermodel"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/poi/ss/usermodel/ConditionType.html" title="class in org.apache.poi.ss.usermodel"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html" title="interface in org.apache.poi.ss.usermodel"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/poi/ss/usermodel/ConditionalFormattingThreshold.RangeType.html" target="_top">Frames</a></li> Modified: poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/Cell.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/Cell.html?rev=1782942&r1=1782941&r2=1782942&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/Cell.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/Cell.html Tue Feb 14 09:47:17 2017 @@ -272,6 +272,27 @@ </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 types with arguments of type <a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a>></code></td> +<td class="colLast"><span class="strong">ConditionalFormattingEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html#getMatchingCells(org.apache.poi.ss.formula.EvaluationConditionalFormatRule)">getMatchingCells</a></strong>(<a href="../../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html" title="class in org.apache.poi.ss.formula">EvaluationConditionalFormatRule</a> rule)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a>></code></td> +<td class="colLast"><span class="strong">ConditionalFormattingEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html#getMatchingCells(org.apache.poi.ss.usermodel.Sheet,%20int,%20int)">getMatchingCells</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Sheet.html" title="interface in org.apache.poi.ss.usermodel">Sheet</a> sheet, + int conditionalFormattingIndex, + int ruleIndex)</code> +<div class="block">Conditional formatting rules can apply only to cells in the sheet to which they are attached.</div> +</td> +</tr> +</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/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a></span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> @@ -314,6 +335,43 @@ </td> </tr> <tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../../../org/apache/poi/ss/formula/EvaluationConditionalFormatRule.html" title="class in org.apache.poi.ss.formula">EvaluationConditionalFormatRule</a>></code></td> +<td class="colLast"><span class="strong">ConditionalFormattingEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html#getConditionalFormattingForCell(org.apache.poi.ss.usermodel.Cell)">getConditionalFormattingForCell</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> +<div class="block">This checks all applicable <a href="../../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html" title="interface in org.apache.poi.ss.usermodel"><code>ConditionalFormattingRule</code></a>s for the cell's sheet, + in defined "priority" order, returning the matches if any.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a></code></td> +<td class="colLast"><span class="strong">ConditionalFormattingEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/ConditionalFormattingEvaluator.html#getRef(org.apache.poi.ss.usermodel.Cell)">getRef</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><span class="strong">DataValidationEvaluator.</span><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="altColor"> +<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="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#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>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> +<tr class="rowColor"> <td class="colFirst"><code>protected static void</code></td> <td class="colLast"><span class="strong">BaseFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#setCellType(org.apache.poi.ss.usermodel.Cell,%20org.apache.poi.ss.usermodel.CellValue)">setCellType</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/CellValue.html" title="class in org.apache.poi.ss.usermodel">CellValue</a> cv)</code> </td> @@ -619,10 +677,18 @@ </td> </tr> <tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a></code></td> +<td class="colLast"><span class="strong">SheetUtil.</span><code><strong><a href="../../../../../../org/apache/poi/ss/util/SheetUtil.html#getCell(org.apache.poi.ss.usermodel.Sheet,%20int,%20int)">getCell</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Sheet.html" title="interface in org.apache.poi.ss.usermodel">Sheet</a> sheet, + int rowIx, + int colIx)</code> +<div class="block">Return the cell, without taking account of merged regions.</div> +</td> +</tr> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../../../org/apache/poi/ss/util/SSCellRange.html" title="type parameter in SSCellRange">K</a>[][]</code></td> <td class="colLast"><span class="strong">SSCellRange.</span><code><strong><a href="../../../../../../org/apache/poi/ss/util/SSCellRange.html#getCells()">getCells</a></strong>()</code> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>static <a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a></code></td> <td class="colLast"><span class="strong">SheetUtil.</span><code><strong><a href="../../../../../../org/apache/poi/ss/util/SheetUtil.html#getCellWithMerges(org.apache.poi.ss.usermodel.Sheet,%20int,%20int)">getCellWithMerges</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Sheet.html" title="interface in org.apache.poi.ss.usermodel">Sheet</a> sheet, int rowIx, @@ -630,11 +696,11 @@ <div class="block">Return the cell, taking account of merged regions.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../../../org/apache/poi/ss/util/SSCellRange.html" title="type parameter in SSCellRange">K</a>[]</code></td> <td class="colLast"><span class="strong">SSCellRange.</span><code><strong><a href="../../../../../../org/apache/poi/ss/util/SSCellRange.html#getFlattenedCells()">getFlattenedCells</a></strong>()</code> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>static <a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a></code></td> <td class="colLast"><span class="strong">CellUtil.</span><code><strong><a href="../../../../../../org/apache/poi/ss/util/CellUtil.html#translateUnicodeValues(org.apache.poi.ss.usermodel.Cell)">translateUnicodeValues</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> <div class="block">Looks for text in the cell that should be unicode, like α and provides the @@ -660,13 +726,20 @@ </td> </tr> <tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">CellRangeAddressBase.</span><code><strong><a href="../../../../../../org/apache/poi/ss/util/CellRangeAddressBase.html#isInRange(org.apache.poi.ss.usermodel.Cell)">isInRange</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> +<div class="block">Determines if the given <a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel"><code>Cell</code></a> lies within the bounds + of this range.</div> +</td> +</tr> +<tr class="altColor"> <td class="colFirst"><code>static void</code></td> <td class="colLast"><span class="strong">CellUtil.</span><code><strong><a href="../../../../../../org/apache/poi/ss/util/CellUtil.html#setAlignment(org.apache.poi.ss.usermodel.Cell,%20org.apache.poi.ss.usermodel.HorizontalAlignment)">setAlignment</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/HorizontalAlignment.html" title="enum in org.apache.poi.ss.usermodel">HorizontalAlignment</a> align)</code> <div class="block">Take a cell, and align it.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>static void</code></td> <td class="colLast"><span class="strong">CellUtil.</span><code><strong><a href="../../../../../../org/apache/poi/ss/util/CellUtil.html#setAlignment(org.apache.poi.ss.usermodel.Cell,%20org.apache.poi.ss.usermodel.Workbook,%20short)">setAlignment</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/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a> workbook, @@ -676,7 +749,7 @@ </div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>static void</code></td> <td class="colLast"><span class="strong">CellUtil.</span><code><strong><a href="../../../../../../org/apache/poi/ss/util/CellUtil.html#setCellStyleProperties(org.apache.poi.ss.usermodel.Cell,%20java.util.Map)">setCellStyleProperties</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell, java.util.Map<java.lang.String,java.lang.Object> properties)</code> @@ -684,7 +757,7 @@ current style plus styles properties in <code>properties</code>.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>static void</code></td> <td class="colLast"><span class="strong">CellUtil.</span><code><strong><a href="../../../../../../org/apache/poi/ss/util/CellUtil.html#setCellStyleProperty(org.apache.poi.ss.usermodel.Cell,%20java.lang.String,%20java.lang.Object)">setCellStyleProperty</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell, java.lang.String propertyName, @@ -694,7 +767,7 @@ <code>propertyValue</code>.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>static void</code></td> <td class="colLast"><span class="strong">CellUtil.</span><code><strong><a href="../../../../../../org/apache/poi/ss/util/CellUtil.html#setCellStyleProperty(org.apache.poi.ss.usermodel.Cell,%20org.apache.poi.ss.usermodel.Workbook,%20java.lang.String,%20java.lang.Object)">setCellStyleProperty</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/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a> workbook, @@ -705,14 +778,14 @@ </div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>static void</code></td> <td class="colLast"><span class="strong">CellUtil.</span><code><strong><a href="../../../../../../org/apache/poi/ss/util/CellUtil.html#setFont(org.apache.poi.ss.usermodel.Cell,%20org.apache.poi.ss.usermodel.Font)">setFont</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/Font.html" title="interface in org.apache.poi.ss.usermodel">Font</a> font)</code> <div class="block">Take a cell, and apply a font to it</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>static void</code></td> <td class="colLast"><span class="strong">CellUtil.</span><code><strong><a href="../../../../../../org/apache/poi/ss/util/CellUtil.html#setFont(org.apache.poi.ss.usermodel.Cell,%20org.apache.poi.ss.usermodel.Workbook,%20org.apache.poi.ss.usermodel.Font)">setFont</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/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a> workbook, @@ -722,14 +795,14 @@ </div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>static void</code></td> <td class="colLast"><span class="strong">CellUtil.</span><code><strong><a href="../../../../../../org/apache/poi/ss/util/CellUtil.html#setVerticalAlignment(org.apache.poi.ss.usermodel.Cell,%20org.apache.poi.ss.usermodel.VerticalAlignment)">setVerticalAlignment</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/VerticalAlignment.html" title="enum in org.apache.poi.ss.usermodel">VerticalAlignment</a> align)</code> <div class="block">Take a cell, and vertically align it.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>static <a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a></code></td> <td class="colLast"><span class="strong">CellUtil.</span><code><strong><a href="../../../../../../org/apache/poi/ss/util/CellUtil.html#translateUnicodeValues(org.apache.poi.ss.usermodel.Cell)">translateUnicodeValues</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> <div class="block">Looks for text in the cell that should be unicode, like α and provides the Modified: poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/CellType.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/CellType.html?rev=1782942&r1=1782941&r2=1782942&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/CellType.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/CellType.html Tue Feb 14 09:47:17 2017 @@ -238,6 +238,22 @@ </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/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><span class="strong">DataValidationEvaluator.</span><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> +</tbody> +</table> </li> <li class="blockList"><a name="org.apache.poi.ss.usermodel"> <!-- --> Added: poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/ConditionFilterData.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/ConditionFilterData.html?rev=1782942&view=auto ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/ConditionFilterData.html (added) +++ poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/ConditionFilterData.html Tue Feb 14 09:47:17 2017 @@ -0,0 +1,226 @@ +<!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 Interface org.apache.poi.ss.usermodel.ConditionFilterData (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 Interface org.apache.poi.ss.usermodel.ConditionFilterData (POI API Documentation)"; + } + } + catch(err) { + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html" title="interface in org.apache.poi.ss.usermodel">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/poi/ss/usermodel/class-use/ConditionFilterData.html" target="_top">Frames</a></li> +<li><a href="ConditionFilterData.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 Interface org.apache.poi.ss.usermodel.ConditionFilterData" class="title">Uses of Interface<br>org.apache.poi.ss.usermodel.ConditionFilterData</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html" title="interface in org.apache.poi.ss.usermodel">ConditionFilterData</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#org.apache.poi.hssf.usermodel">org.apache.poi.hssf.usermodel</a></td> +<td class="colLast"> +<div class="block">usermodel package maps HSSF low level strutures to familiar workbook/sheet model</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#org.apache.poi.ss.usermodel">org.apache.poi.ss.usermodel</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#org.apache.poi.xssf.usermodel">org.apache.poi.xssf.usermodel</a></td> +<td class="colLast"> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="org.apache.poi.hssf.usermodel"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html" title="interface in org.apache.poi.ss.usermodel">ConditionFilterData</a> in <a href="../../../../../../org/apache/poi/hssf/usermodel/package-summary.html">org.apache.poi.hssf.usermodel</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../org/apache/poi/hssf/usermodel/package-summary.html">org.apache.poi.hssf.usermodel</a> that return <a href="../../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html" title="interface in org.apache.poi.ss.usermodel">ConditionFilterData</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html" title="interface in org.apache.poi.ss.usermodel">ConditionFilterData</a></code></td> +<td class="colLast"><span class="strong">HSSFConditionalFormattingRule.</span><code><strong><a href="../../../../../../org/apache/poi/hssf/usermodel/HSSFConditionalFormattingRule.html#getFilterConfiguration()">getFilterConfiguration</a></strong>()</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="org.apache.poi.ss.usermodel"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html" title="interface in org.apache.poi.ss.usermodel">ConditionFilterData</a> in <a href="../../../../../../org/apache/poi/ss/usermodel/package-summary.html">org.apache.poi.ss.usermodel</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../org/apache/poi/ss/usermodel/package-summary.html">org.apache.poi.ss.usermodel</a> that return <a href="../../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html" title="interface in org.apache.poi.ss.usermodel">ConditionFilterData</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html" title="interface in org.apache.poi.ss.usermodel">ConditionFilterData</a></code></td> +<td class="colLast"><span class="strong">ConditionalFormattingRule.</span><code><strong><a href="../../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html#getFilterConfiguration()">getFilterConfiguration</a></strong>()</code> +<div class="block">This is null if + <p/> + <code><a href="../../../../../../org/apache/poi/ss/usermodel/ConditionalFormattingRule.html#getConditionFilterType()"><code>ConditionalFormattingRule.getConditionFilterType()</code></a> == null</code> + <p/> + This means it is always null for HSSF, which does not define the extended condition types.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="org.apache.poi.xssf.usermodel"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html" title="interface in org.apache.poi.ss.usermodel">ConditionFilterData</a> in <a href="../../../../../../org/apache/poi/xssf/usermodel/package-summary.html">org.apache.poi.xssf.usermodel</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../../org/apache/poi/xssf/usermodel/package-summary.html">org.apache.poi.xssf.usermodel</a> that implement <a href="../../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html" title="interface in org.apache.poi.ss.usermodel">ConditionFilterData</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/xssf/usermodel/XSSFConditionFilterData.html" title="class in org.apache.poi.xssf.usermodel">XSSFConditionFilterData</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/xssf/usermodel/package-summary.html">org.apache.poi.xssf.usermodel</a> that return <a href="../../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html" title="interface in org.apache.poi.ss.usermodel">ConditionFilterData</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/poi/ss/usermodel/ConditionFilterData.html" title="interface in org.apache.poi.ss.usermodel">ConditionFilterData</a></code></td> +<td class="colLast"><span class="strong">XSSFConditionalFormattingRule.</span><code><strong><a href="../../../../../../org/apache/poi/xssf/usermodel/XSSFConditionalFormattingRule.html#getFilterConfiguration()">getFilterConfiguration</a></strong>()</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/usermodel/ConditionFilterData.html" title="interface in org.apache.poi.ss.usermodel">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/poi/ss/usermodel/class-use/ConditionFilterData.html" target="_top">Frames</a></li> +<li><a href="ConditionFilterData.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]
