You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by on...@apache.org on 2015/11/23 10:39:47 UTC
svn commit: r1715746 - in /poi/site/publish/apidocs/org/apache/poi/ss/util:
CellAddress.html CellReference.html
Author: onealj
Date: Mon Nov 23 09:39:47 2015
New Revision: 1715746
URL: http://svn.apache.org/viewvc?rev=1715746&view=rev
Log:
update javadocs for r1715743 bug 58365
Added:
poi/site/publish/apidocs/org/apache/poi/ss/util/CellAddress.html (with props)
Modified:
poi/site/publish/apidocs/org/apache/poi/ss/util/CellReference.html
Added: poi/site/publish/apidocs/org/apache/poi/ss/util/CellAddress.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/util/CellAddress.html?rev=1715746&view=auto
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/ss/util/CellAddress.html (added)
+++ poi/site/publish/apidocs/org/apache/poi/ss/util/CellAddress.html Mon Nov 23 09:39:47 2015
@@ -0,0 +1,504 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc -->
+<title>CellAddress (POI API Documentation)</title>
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+<script type="text/javascript" src="../../../../../script.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="CellAddress (POI API Documentation)";
+ }
+ }
+ catch(err) {
+ }
+//-->
+var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
+var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
+var altColor = "altColor";
+var rowColor = "rowColor";
+var tableTab = "tableTab";
+var activeTableTab = "activeTableTab";
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar.top">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<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/CellAddress.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/util/AreaReference.html" title="class in org.apache.poi.ss.util"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/poi/ss/util/CellRangeAddress.html" title="class in org.apache.poi.ss.util"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/poi/ss/util/CellAddress.html" target="_top">Frames</a></li>
+<li><a href="CellAddress.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="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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.util</div>
+<h2 title="Class CellAddress" class="title">Class CellAddress</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li>org.apache.poi.ss.util.CellAddress</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/util/CellAddress.html" title="class in org.apache.poi.ss.util">CellAddress</a>></dd>
+</dl>
+<hr>
+<br>
+<pre>public class <span class="typeNameLabel">CellAddress</span>
+extends java.lang.Object
+implements java.lang.Comparable<<a href="../../../../../org/apache/poi/ss/util/CellAddress.html" title="class in org.apache.poi.ss.util">CellAddress</a>></pre>
+<div class="block"><p>This class is a container for POI usermodel row=0 column=0 cell references.
+ It is barely a container for these two coordinates. The implementation
+ of the Comparable interface sorts by "natural" order top left to bottom right.</p>
+
+ <p>Use <tt>CellAddress</tt> when you want to refer to the location of a cell in a sheet
+ when the concept of relative/absolute does not apply (such as the anchor location
+ of a cell comment). Use <a href="../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util"><code>CellReference</code></a> when the concept of
+ relative/absolute does apply (such as a cell reference in a formula).
+ <tt>CellAddress</tt>es do not have a concept of "sheet", while <tt>CellReference</tt>s do.</p></div>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- =========== FIELD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="field.summary">
+<!-- -->
+</a>
+<h3>Field Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
+<caption><span>Fields</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Field and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>static <a href="../../../../../org/apache/poi/ss/util/CellAddress.html" title="class in org.apache.poi.ss.util">CellAddress</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellAddress.html#A1">A1</a></span></code>
+<div class="block">A constant for references to the first cell in a sheet.</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="memberSummary" 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><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellAddress.html#CellAddress-org.apache.poi.ss.util.CellReference-">CellAddress</a></span>(<a href="../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a> reference)</code>
+<div class="block">Create a new CellAddress object.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellAddress.html#CellAddress-int-int-">CellAddress</a></span>(int row,
+ int column)</code>
+<div class="block">Create a new CellAddress object.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellAddress.html#CellAddress-java.lang.String-">CellAddress</a></span>(java.lang.String address)</code>
+<div class="block">Create a new CellAddress object.</div>
+</td>
+</tr>
+</table>
+</li>
+</ul>
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr id="i0" class="altColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellAddress.html#compareTo-org.apache.poi.ss.util.CellAddress-">compareTo</a></span>(<a href="../../../../../org/apache/poi/ss/util/CellAddress.html" title="class in org.apache.poi.ss.util">CellAddress</a> other)</code>
+<div class="block">Compare this CellAddress using the "natural" row-major, column-minor ordering.</div>
+</td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellAddress.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object o)</code> </td>
+</tr>
+<tr id="i2" class="altColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellAddress.html#formatAsString--">formatAsString</a></span>()</code>
+<div class="block">Same as <a href="../../../../../org/apache/poi/ss/util/CellAddress.html#toString--"><code>toString()</code></a></div>
+</td>
+</tr>
+<tr id="i3" class="rowColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellAddress.html#getColumn--">getColumn</a></span>()</code>
+<div class="block">Get the cell address column</div>
+</td>
+</tr>
+<tr id="i4" class="altColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellAddress.html#getRow--">getRow</a></span>()</code>
+<div class="block">Get the cell address row</div>
+</td>
+</tr>
+<tr id="i5" class="rowColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellAddress.html#hashCode--">hashCode</a></span>()</code> </td>
+</tr>
+<tr id="i6" class="altColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellAddress.html#toString--">toString</a></span>()</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, wait, wait, wait</code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ FIELD DETAIL =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="field.detail">
+<!-- -->
+</a>
+<h3>Field Detail</h3>
+<a name="A1">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>A1</h4>
+<pre>public static final <a href="../../../../../org/apache/poi/ss/util/CellAddress.html" title="class in org.apache.poi.ss.util">CellAddress</a> A1</pre>
+<div class="block">A constant for references to the first cell in a sheet.</div>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor.detail">
+<!-- -->
+</a>
+<h3>Constructor Detail</h3>
+<a name="CellAddress-int-int-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>CellAddress</h4>
+<pre>public CellAddress(int row,
+ int column)</pre>
+<div class="block">Create a new CellAddress object.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>row</code> - Row index (first row is 0)</dd>
+<dd><code>column</code> - Column index (first column is 0)</dd>
+</dl>
+</li>
+</ul>
+<a name="CellAddress-java.lang.String-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>CellAddress</h4>
+<pre>public CellAddress(java.lang.String address)</pre>
+<div class="block">Create a new CellAddress object.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>address</code> - a cell address in A1 format. Address may not contain sheet name or dollar signs.
+ (that is, address is not a cell reference. Use <a href="../../../../../org/apache/poi/ss/util/CellAddress.html#CellAddress-org.apache.poi.ss.util.CellReference-"><code>CellAddress(CellReference)</code></a> instead if
+ starting with a cell reference.)</dd>
+</dl>
+</li>
+</ul>
+<a name="CellAddress-org.apache.poi.ss.util.CellReference-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>CellAddress</h4>
+<pre>public CellAddress(<a href="../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a> reference)</pre>
+<div class="block">Create a new CellAddress object.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>reference</code> - a reference to a cell</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="getRow--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getRow</h4>
+<pre>public int getRow()</pre>
+<div class="block">Get the cell address row</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>row</dd>
+</dl>
+</li>
+</ul>
+<a name="getColumn--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getColumn</h4>
+<pre>public int getColumn()</pre>
+<div class="block">Get the cell address column</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>column</dd>
+</dl>
+</li>
+</ul>
+<a name="compareTo-org.apache.poi.ss.util.CellAddress-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>compareTo</h4>
+<pre>public int compareTo(<a href="../../../../../org/apache/poi/ss/util/CellAddress.html" title="class in org.apache.poi.ss.util">CellAddress</a> other)</pre>
+<div class="block">Compare this CellAddress using the "natural" row-major, column-minor ordering.
+ That is, top-left to bottom-right ordering.</div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code>compareTo</code> in interface <code>java.lang.Comparable<<a href="../../../../../org/apache/poi/ss/util/CellAddress.html" title="class in org.apache.poi.ss.util">CellAddress</a>></code></dd>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>other</code> - </dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd><ul>
+ <li>-1 if this CellAddress is before (above/left) of other</li>
+ <li>0 if addresses are the same</li>
+ <li>1 if this CellAddress is after (below/right) of other</li>
+ </ul></dd>
+</dl>
+</li>
+</ul>
+<a name="equals-java.lang.Object-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>equals</h4>
+<pre>public boolean equals(java.lang.Object o)</pre>
+<dl>
+<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
+<dd><code>equals</code> in class <code>java.lang.Object</code></dd>
+</dl>
+</li>
+</ul>
+<a name="hashCode--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>hashCode</h4>
+<pre>public int hashCode()</pre>
+<dl>
+<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
+<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd>
+</dl>
+</li>
+</ul>
+<a name="toString--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>toString</h4>
+<pre>public java.lang.String toString()</pre>
+<dl>
+<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
+<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
+</dl>
+</li>
+</ul>
+<a name="formatAsString--">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>formatAsString</h4>
+<pre>public java.lang.String formatAsString()</pre>
+<div class="block">Same as <a href="../../../../../org/apache/poi/ss/util/CellAddress.html#toString--"><code>toString()</code></a></div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>A1-style cell address string representation</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>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<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/CellAddress.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/util/AreaReference.html" title="class in org.apache.poi.ss.util"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/poi/ss/util/CellRangeAddress.html" title="class in org.apache.poi.ss.util"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/poi/ss/util/CellAddress.html" target="_top">Frames</a></li>
+<li><a href="CellAddress.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="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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 2015 The Apache Software Foundation or
+ its licensors, as applicable.</i>
+ </small></p>
+</body>
+</html>
Propchange: poi/site/publish/apidocs/org/apache/poi/ss/util/CellAddress.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: poi/site/publish/apidocs/org/apache/poi/ss/util/CellAddress.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Modified: poi/site/publish/apidocs/org/apache/poi/ss/util/CellReference.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/util/CellReference.html?rev=1715746&r1=1715745&r2=1715746&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/ss/util/CellReference.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/ss/util/CellReference.html Mon Nov 23 09:39:47 2015
@@ -2,23 +2,37 @@
<!-- NewPage -->
<html lang="en">
<head>
+<!-- Generated by javadoc -->
<title>CellReference (POI API Documentation)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="CellReference (POI API Documentation)";
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="CellReference (POI API Documentation)";
+ }
+ }
+ catch(err) {
}
//-->
+var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":9,"i13":9,"i14":10,"i15":9,"i16":10};
+var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
+var altColor = "altColor";
+var rowColor = "rowColor";
+var tableTab = "tableTab";
+var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
-<div class="topNav"><a name="navbar_top">
+<div class="topNav"><a name="navbar.top">
<!-- -->
-</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
@@ -34,15 +48,15 @@
</div>
<div class="subNav">
<ul class="navList">
-<li><a href="../../../../../org/apache/poi/ss/util/CellRangeAddressList.html" title="class in org.apache.poi.ss.util"><span class="strong">Prev Class</span></a></li>
-<li><a href="../../../../../org/apache/poi/ss/util/CellReference.NameType.html" title="enum in org.apache.poi.ss.util"><span class="strong">Next Class</span></a></li>
+<li><a href="../../../../../org/apache/poi/ss/util/CellRangeAddressList.html" title="class in org.apache.poi.ss.util"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/poi/ss/util/CellReference.NameType.html" title="enum in org.apache.poi.ss.util"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/poi/ss/util/CellReference.html" target="_top">Frames</a></li>
-<li><a href="CellReference.html" target="_top">No Frames</a></li>
+<li><a href="CellReference.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>
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
@@ -59,19 +73,19 @@
<div>
<ul class="subNavList">
<li>Summary: </li>
-<li><a href="#nested_class_summary">Nested</a> | </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>
+<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>
+<li><a href="#constructor.detail">Constr</a> | </li>
+<li><a href="#method.detail">Method</a></li>
</ul>
</div>
-<a name="skip-navbar_top">
+<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
@@ -98,12 +112,19 @@
</dl>
<hr>
<br>
-<pre>public class <span class="strong">CellReference</span>
+<pre>public class <span class="typeNameLabel">CellReference</span>
extends java.lang.Object</pre>
-<div class="block">Common conversion functions between Excel style A1, C27 style
+<div class="block"><p>Common conversion functions between Excel style A1, C27 style
cell references, and POI usermodel style row=0, column=0
style references. Handles sheet-based and sheet-free references
- as well, eg "Sheet1!A1" and "$B$72"</div>
+ as well, eg "Sheet1!A1" and "$B$72"</p>
+
+ <p>Use <tt>CellReference</tt> when the concept of
+ relative/absolute does apply (such as a cell reference in a formula).
+ Use <a href="../../../../../org/apache/poi/ss/util/CellAddress.html" title="class in org.apache.poi.ss.util"><code>CellAddress</code></a> when you want to refer to the location of a cell in a sheet
+ when the concept of relative/absolute does not apply (such as the anchor location
+ of a cell comment).
+ <tt>CellReference</tt>s have a concept of "sheet", while <tt>CellAddress</tt>es do not.</p></div>
</li>
</ul>
</div>
@@ -112,11 +133,11 @@ extends java.lang.Object</pre>
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
-<li class="blockList"><a name="nested_class_summary">
+<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">
+<table class="memberSummary" 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>
@@ -124,7 +145,7 @@ extends java.lang.Object</pre>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class </code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/CellReference.NameType.html" title="enum in org.apache.poi.ss.util">CellReference.NameType</a></strong></code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellReference.NameType.html" title="enum in org.apache.poi.ss.util">CellReference.NameType</a></span></code>
<div class="block">Used to classify identifiers found in formulas as cell references or not.</div>
</td>
</tr>
@@ -133,39 +154,39 @@ extends java.lang.Object</pre>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
-<li class="blockList"><a name="constructor_summary">
+<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">
+<table class="memberSummary" 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/util/CellReference.html#CellReference(org.apache.poi.ss.usermodel.Cell)">CellReference</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> </td>
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellReference.html#CellReference-org.apache.poi.ss.usermodel.Cell-">CellReference</a></span>(<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="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/util/CellReference.html#CellReference(int,%20int)">CellReference</a></strong>(int pRow,
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellReference.html#CellReference-int-int-">CellReference</a></span>(int pRow,
int pCol)</code> </td>
</tr>
<tr class="altColor">
-<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/util/CellReference.html#CellReference(int,%20int,%20boolean,%20boolean)">CellReference</a></strong>(int pRow,
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellReference.html#CellReference-int-int-boolean-boolean-">CellReference</a></span>(int pRow,
int pCol,
boolean pAbsRow,
boolean pAbsCol)</code> </td>
</tr>
<tr class="rowColor">
-<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/util/CellReference.html#CellReference(int,%20short)">CellReference</a></strong>(int pRow,
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellReference.html#CellReference-int-short-">CellReference</a></span>(int pRow,
short pCol)</code> </td>
</tr>
<tr class="altColor">
-<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/util/CellReference.html#CellReference(java.lang.String)">CellReference</a></strong>(java.lang.String cellRef)</code>
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellReference.html#CellReference-java.lang.String-">CellReference</a></span>(java.lang.String cellRef)</code>
<div class="block">Create an cell ref from a string representation.</div>
</td>
</tr>
<tr class="rowColor">
-<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/util/CellReference.html#CellReference(java.lang.String,%20int,%20int,%20boolean,%20boolean)">CellReference</a></strong>(java.lang.String pSheetName,
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellReference.html#CellReference-java.lang.String-int-int-boolean-boolean-">CellReference</a></span>(java.lang.String pSheetName,
int pRow,
int pCol,
boolean pAbsRow,
@@ -176,111 +197,111 @@ extends java.lang.Object</pre>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
-<li class="blockList"><a name="method_summary">
+<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>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></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">
+<tr id="i0" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/CellReference.html#cellReferenceIsWithinRange(java.lang.String,%20java.lang.String,%20org.apache.poi.ss.SpreadsheetVersion)">cellReferenceIsWithinRange</a></strong>(java.lang.String colStr,
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellReference.html#cellReferenceIsWithinRange-java.lang.String-java.lang.String-org.apache.poi.ss.SpreadsheetVersion-">cellReferenceIsWithinRange</a></span>(java.lang.String colStr,
java.lang.String rowStr,
<a href="../../../../../org/apache/poi/ss/SpreadsheetVersion.html" title="enum in org.apache.poi.ss">SpreadsheetVersion</a> ssVersion)</code>
<div class="block">Used to decide whether a name of the form "[A-Z]*[0-9]*" that appears in a formula can be
interpreted as a cell reference.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/poi/ss/util/CellReference.NameType.html" title="enum in org.apache.poi.ss.util">CellReference.NameType</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/CellReference.html#classifyCellReference(java.lang.String,%20org.apache.poi.ss.SpreadsheetVersion)">classifyCellReference</a></strong>(java.lang.String str,
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellReference.html#classifyCellReference-java.lang.String-org.apache.poi.ss.SpreadsheetVersion-">classifyCellReference</a></span>(java.lang.String str,
<a href="../../../../../org/apache/poi/ss/SpreadsheetVersion.html" title="enum in org.apache.poi.ss">SpreadsheetVersion</a> ssVersion)</code>
<div class="block">Classifies an identifier as either a simple (2D) cell reference or a named range name</div>
</td>
</tr>
-<tr class="altColor">
+<tr id="i2" class="altColor">
<td class="colFirst"><code>static int</code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/CellReference.html#convertColStringToIndex(java.lang.String)">convertColStringToIndex</a></strong>(java.lang.String ref)</code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellReference.html#convertColStringToIndex-java.lang.String-">convertColStringToIndex</a></span>(java.lang.String ref)</code>
<div class="block">takes in a column reference portion of a CellRef and converts it from
ALPHA-26 number format to 0-based base 10.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr id="i3" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/CellReference.html#convertNumToColString(int)">convertNumToColString</a></strong>(int col)</code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellReference.html#convertNumToColString-int-">convertNumToColString</a></span>(int col)</code>
<div class="block">Takes in a 0-based base-10 column and returns a ALPHA-26
representation.</div>
</td>
</tr>
-<tr class="altColor">
+<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/CellReference.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object o)</code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellReference.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object o)</code>
<div class="block">Checks whether this cell reference is equal to another object.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/CellReference.html#formatAsString()">formatAsString</a></strong>()</code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellReference.html#formatAsString--">formatAsString</a></span>()</code>
<div class="block">Returns a text representation of this cell reference.</div>
</td>
</tr>
-<tr class="altColor">
+<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/CellReference.html#getCellRefParts()">getCellRefParts</a></strong>()</code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellReference.html#getCellRefParts--">getCellRefParts</a></span>()</code>
<div class="block">Returns the three parts of the cell reference, the
Sheet name (or null if none supplied), the 1 based
row number, and the A based column letter.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr id="i7" class="rowColor">
<td class="colFirst"><code>short</code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/CellReference.html#getCol()">getCol</a></strong>()</code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellReference.html#getCol--">getCol</a></span>()</code> </td>
</tr>
-<tr class="altColor">
+<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/CellReference.html#getRow()">getRow</a></strong>()</code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellReference.html#getRow--">getRow</a></span>()</code> </td>
</tr>
-<tr class="rowColor">
+<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/CellReference.html#getSheetName()">getSheetName</a></strong>()</code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellReference.html#getSheetName--">getSheetName</a></span>()</code> </td>
</tr>
-<tr class="altColor">
+<tr id="i10" class="altColor">
<td class="colFirst"><code>int</code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/CellReference.html#hashCode()">hashCode</a></strong>()</code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellReference.html#hashCode--">hashCode</a></span>()</code> </td>
</tr>
-<tr class="rowColor">
+<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/CellReference.html#isColAbsolute()">isColAbsolute</a></strong>()</code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellReference.html#isColAbsolute--">isColAbsolute</a></span>()</code> </td>
</tr>
-<tr class="altColor">
+<tr id="i12" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/CellReference.html#isColumnWithnRange(java.lang.String,%20org.apache.poi.ss.SpreadsheetVersion)">isColumnWithnRange</a></strong>(java.lang.String colStr,
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellReference.html#isColumnWithnRange-java.lang.String-org.apache.poi.ss.SpreadsheetVersion-">isColumnWithnRange</a></span>(java.lang.String colStr,
<a href="../../../../../org/apache/poi/ss/SpreadsheetVersion.html" title="enum in org.apache.poi.ss">SpreadsheetVersion</a> ssVersion)</code> </td>
</tr>
-<tr class="rowColor">
+<tr id="i13" class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/CellReference.html#isPartAbsolute(java.lang.String)">isPartAbsolute</a></strong>(java.lang.String part)</code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellReference.html#isPartAbsolute-java.lang.String-">isPartAbsolute</a></span>(java.lang.String part)</code> </td>
</tr>
-<tr class="altColor">
+<tr id="i14" class="altColor">
<td class="colFirst"><code>boolean</code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/CellReference.html#isRowAbsolute()">isRowAbsolute</a></strong>()</code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellReference.html#isRowAbsolute--">isRowAbsolute</a></span>()</code> </td>
</tr>
-<tr class="rowColor">
+<tr id="i15" class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/CellReference.html#isRowWithnRange(java.lang.String,%20org.apache.poi.ss.SpreadsheetVersion)">isRowWithnRange</a></strong>(java.lang.String rowStr,
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellReference.html#isRowWithnRange-java.lang.String-org.apache.poi.ss.SpreadsheetVersion-">isRowWithnRange</a></span>(java.lang.String rowStr,
<a href="../../../../../org/apache/poi/ss/SpreadsheetVersion.html" title="enum in org.apache.poi.ss">SpreadsheetVersion</a> ssVersion)</code> </td>
</tr>
-<tr class="altColor">
+<tr id="i16" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/CellReference.html#toString()">toString</a></strong>()</code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/ss/util/CellReference.html#toString--">toString</a></span>()</code> </td>
</tr>
</table>
<ul class="blockList">
-<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
+<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
@@ -296,11 +317,11 @@ extends java.lang.Object</pre>
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
-<li class="blockList"><a name="constructor_detail">
+<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
-<a name="CellReference(java.lang.String)">
+<a name="CellReference-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
@@ -311,27 +332,27 @@ extends java.lang.Object</pre>
delimited and escaped as per normal syntax rules for formulas.</div>
</li>
</ul>
-<a name="CellReference(int, int)">
+<a name="CellReference-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CellReference</h4>
<pre>public CellReference(int pRow,
- int pCol)</pre>
+ int pCol)</pre>
</li>
</ul>
-<a name="CellReference(int, short)">
+<a name="CellReference-int-short-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CellReference</h4>
<pre>public CellReference(int pRow,
- short pCol)</pre>
+ short pCol)</pre>
</li>
</ul>
-<a name="CellReference(org.apache.poi.ss.usermodel.Cell)">
+<a name="CellReference-org.apache.poi.ss.usermodel.Cell-">
<!-- -->
</a>
<ul class="blockList">
@@ -340,40 +361,40 @@ extends java.lang.Object</pre>
<pre>public CellReference(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</pre>
</li>
</ul>
-<a name="CellReference(int, int, boolean, boolean)">
+<a name="CellReference-int-int-boolean-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CellReference</h4>
<pre>public CellReference(int pRow,
- int pCol,
- boolean pAbsRow,
- boolean pAbsCol)</pre>
+ int pCol,
+ boolean pAbsRow,
+ boolean pAbsCol)</pre>
</li>
</ul>
-<a name="CellReference(java.lang.String, int, int, boolean, boolean)">
+<a name="CellReference-java.lang.String-int-int-boolean-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CellReference</h4>
<pre>public CellReference(java.lang.String pSheetName,
- int pRow,
- int pCol,
- boolean pAbsRow,
- boolean pAbsCol)</pre>
+ int pRow,
+ int pCol,
+ boolean pAbsRow,
+ boolean pAbsCol)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
-<li class="blockList"><a name="method_detail">
+<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
-<a name="getRow()">
+<a name="getRow--">
<!-- -->
</a>
<ul class="blockList">
@@ -382,7 +403,7 @@ extends java.lang.Object</pre>
<pre>public int getRow()</pre>
</li>
</ul>
-<a name="getCol()">
+<a name="getCol--">
<!-- -->
</a>
<ul class="blockList">
@@ -391,7 +412,7 @@ extends java.lang.Object</pre>
<pre>public short getCol()</pre>
</li>
</ul>
-<a name="isRowAbsolute()">
+<a name="isRowAbsolute--">
<!-- -->
</a>
<ul class="blockList">
@@ -400,7 +421,7 @@ extends java.lang.Object</pre>
<pre>public boolean isRowAbsolute()</pre>
</li>
</ul>
-<a name="isColAbsolute()">
+<a name="isColAbsolute--">
<!-- -->
</a>
<ul class="blockList">
@@ -409,18 +430,21 @@ extends java.lang.Object</pre>
<pre>public boolean isColAbsolute()</pre>
</li>
</ul>
-<a name="getSheetName()">
+<a name="getSheetName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSheetName</h4>
<pre>public java.lang.String getSheetName()</pre>
-<dl><dt><span class="strong">Returns:</span></dt><dd>possibly <code>null</code> if this is a 2D reference. Special characters are not
- escaped or delimited</dd></dl>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>possibly <code>null</code> if this is a 2D reference. Special characters are not
+ escaped or delimited</dd>
+</dl>
</li>
</ul>
-<a name="isPartAbsolute(java.lang.String)">
+<a name="isPartAbsolute-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
@@ -429,7 +453,7 @@ extends java.lang.Object</pre>
<pre>public static boolean isPartAbsolute(java.lang.String part)</pre>
</li>
</ul>
-<a name="convertColStringToIndex(java.lang.String)">
+<a name="convertColStringToIndex-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
@@ -442,30 +466,36 @@ extends java.lang.Object</pre>
'Z' -> 25
'AA' -> 26
'IV' -> 255</div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>zero based column index</dd></dl>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>zero based column index</dd>
+</dl>
</li>
</ul>
-<a name="classifyCellReference(java.lang.String, org.apache.poi.ss.SpreadsheetVersion)">
+<a name="classifyCellReference-java.lang.String-org.apache.poi.ss.SpreadsheetVersion-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>classifyCellReference</h4>
<pre>public static <a href="../../../../../org/apache/poi/ss/util/CellReference.NameType.html" title="enum in org.apache.poi.ss.util">CellReference.NameType</a> classifyCellReference(java.lang.String str,
- <a href="../../../../../org/apache/poi/ss/SpreadsheetVersion.html" title="enum in org.apache.poi.ss">SpreadsheetVersion</a> ssVersion)</pre>
+ <a href="../../../../../org/apache/poi/ss/SpreadsheetVersion.html" title="enum in org.apache.poi.ss">SpreadsheetVersion</a> ssVersion)</pre>
<div class="block">Classifies an identifier as either a simple (2D) cell reference or a named range name</div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>one of the values from <tt>NameType</tt></dd></dl>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>one of the values from <tt>NameType</tt></dd>
+</dl>
</li>
</ul>
-<a name="cellReferenceIsWithinRange(java.lang.String, java.lang.String, org.apache.poi.ss.SpreadsheetVersion)">
+<a name="cellReferenceIsWithinRange-java.lang.String-java.lang.String-org.apache.poi.ss.SpreadsheetVersion-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cellReferenceIsWithinRange</h4>
<pre>public static boolean cellReferenceIsWithinRange(java.lang.String colStr,
- java.lang.String rowStr,
- <a href="../../../../../org/apache/poi/ss/SpreadsheetVersion.html" title="enum in org.apache.poi.ss">SpreadsheetVersion</a> ssVersion)</pre>
+ java.lang.String rowStr,
+ <a href="../../../../../org/apache/poi/ss/SpreadsheetVersion.html" title="enum in org.apache.poi.ss">SpreadsheetVersion</a> ssVersion)</pre>
<div class="block">Used to decide whether a name of the form "[A-Z]*[0-9]*" that appears in a formula can be
interpreted as a cell reference. Names of that form can be also used for sheets and/or
named ranges, and in those circumstances, the question of whether the potential cell
@@ -496,31 +526,36 @@ extends java.lang.Object</pre>
<tr><td>"a", "111"</td><td>true</td></tr>
<tr><td>"Sheet", "1"</td><td>false</td></tr>
</table></blockquote></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>colStr</code> - a string of only letter characters</dd><dd><code>rowStr</code> - a string of only digit characters</dd>
-<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the row and col parameters are within range of a BIFF8 spreadsheet.</dd></dl>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>colStr</code> - a string of only letter characters</dd>
+<dd><code>rowStr</code> - a string of only digit characters</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd><code>true</code> if the row and col parameters are within range of a BIFF8 spreadsheet.</dd>
+</dl>
</li>
</ul>
-<a name="isColumnWithnRange(java.lang.String, org.apache.poi.ss.SpreadsheetVersion)">
+<a name="isColumnWithnRange-java.lang.String-org.apache.poi.ss.SpreadsheetVersion-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isColumnWithnRange</h4>
<pre>public static boolean isColumnWithnRange(java.lang.String colStr,
- <a href="../../../../../org/apache/poi/ss/SpreadsheetVersion.html" title="enum in org.apache.poi.ss">SpreadsheetVersion</a> ssVersion)</pre>
+ <a href="../../../../../org/apache/poi/ss/SpreadsheetVersion.html" title="enum in org.apache.poi.ss">SpreadsheetVersion</a> ssVersion)</pre>
</li>
</ul>
-<a name="isRowWithnRange(java.lang.String, org.apache.poi.ss.SpreadsheetVersion)">
+<a name="isRowWithnRange-java.lang.String-org.apache.poi.ss.SpreadsheetVersion-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRowWithnRange</h4>
<pre>public static boolean isRowWithnRange(java.lang.String rowStr,
- <a href="../../../../../org/apache/poi/ss/SpreadsheetVersion.html" title="enum in org.apache.poi.ss">SpreadsheetVersion</a> ssVersion)</pre>
+ <a href="../../../../../org/apache/poi/ss/SpreadsheetVersion.html" title="enum in org.apache.poi.ss">SpreadsheetVersion</a> ssVersion)</pre>
</li>
</ul>
-<a name="convertNumToColString(int)">
+<a name="convertNumToColString-int-">
<!-- -->
</a>
<ul class="blockList">
@@ -532,7 +567,7 @@ extends java.lang.Object</pre>
eg column #3 -> D</div>
</li>
</ul>
-<a name="formatAsString()">
+<a name="formatAsString--">
<!-- -->
</a>
<ul class="blockList">
@@ -548,10 +583,13 @@ extends java.lang.Object</pre>
<tr><td>Sheet1!A1</td><td>Standard sheet name</td></tr>
<tr><td>'O''Brien''s Sales'!A1' </td><td>Sheet name with special characters</td></tr>
</table></div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>the text representation of this cell reference as it would appear in a formula.</dd></dl>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the text representation of this cell reference as it would appear in a formula.</dd>
+</dl>
</li>
</ul>
-<a name="toString()">
+<a name="toString--">
<!-- -->
</a>
<ul class="blockList">
@@ -559,12 +597,12 @@ extends java.lang.Object</pre>
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<dl>
-<dt><strong>Overrides:</strong></dt>
+<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
-<a name="getCellRefParts()">
+<a name="getCellRefParts--">
<!-- -->
</a>
<ul class="blockList">
@@ -575,12 +613,15 @@ extends java.lang.Object</pre>
Sheet name (or null if none supplied), the 1 based
row number, and the A based column letter.
This will not include any markers for absolute
- references, so use <a href="../../../../../org/apache/poi/ss/util/CellReference.html#formatAsString()"><code>formatAsString()</code></a>
+ references, so use <a href="../../../../../org/apache/poi/ss/util/CellReference.html#formatAsString--"><code>formatAsString()</code></a>
to properly turn references into strings.</div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>String array of { sheetName, rowString, colString }</dd></dl>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>String array of { sheetName, rowString, colString }</dd>
+</dl>
</li>
</ul>
-<a name="equals(java.lang.Object)">
+<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
@@ -590,15 +631,15 @@ extends java.lang.Object</pre>
<div class="block">Checks whether this cell reference is equal to another object.
<p>
Two cells references are assumed to be equal if their string representations
- (<a href="../../../../../org/apache/poi/ss/util/CellReference.html#formatAsString()"><code>formatAsString()</code></a> are equal.
+ (<a href="../../../../../org/apache/poi/ss/util/CellReference.html#formatAsString--"><code>formatAsString()</code></a> are equal.
</p></div>
<dl>
-<dt><strong>Overrides:</strong></dt>
+<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
-<a name="hashCode()">
+<a name="hashCode--">
<!-- -->
</a>
<ul class="blockListLast">
@@ -606,7 +647,7 @@ extends java.lang.Object</pre>
<h4>hashCode</h4>
<pre>public int hashCode()</pre>
<dl>
-<dt><strong>Overrides:</strong></dt>
+<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
@@ -619,9 +660,11 @@ extends java.lang.Object</pre>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
-<div class="bottomNav"><a name="navbar_bottom">
+<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
-</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
@@ -637,15 +680,15 @@ extends java.lang.Object</pre>
</div>
<div class="subNav">
<ul class="navList">
-<li><a href="../../../../../org/apache/poi/ss/util/CellRangeAddressList.html" title="class in org.apache.poi.ss.util"><span class="strong">Prev Class</span></a></li>
-<li><a href="../../../../../org/apache/poi/ss/util/CellReference.NameType.html" title="enum in org.apache.poi.ss.util"><span class="strong">Next Class</span></a></li>
+<li><a href="../../../../../org/apache/poi/ss/util/CellRangeAddressList.html" title="class in org.apache.poi.ss.util"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/poi/ss/util/CellReference.NameType.html" title="enum in org.apache.poi.ss.util"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/poi/ss/util/CellReference.html" target="_top">Frames</a></li>
-<li><a href="CellReference.html" target="_top">No Frames</a></li>
+<li><a href="CellReference.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>
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
@@ -662,19 +705,19 @@ extends java.lang.Object</pre>
<div>
<ul class="subNavList">
<li>Summary: </li>
-<li><a href="#nested_class_summary">Nested</a> | </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>
+<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>
+<li><a href="#constructor.detail">Constr</a> | </li>
+<li><a href="#method.detail">Method</a></li>
</ul>
</div>
-<a name="skip-navbar_bottom">
+<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org