<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_19) on Fri Oct 29 16:39:34 MSD 2010 -->
<TITLE>
Region (POI API Documentation)
</TITLE>
<META NAME="date" CONTENT="2010-10-29">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Region (POI API Documentation)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Region.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../org/apache/poi/ss/util/NumberToTextConverter.html" title="class in org.apache.poi.ss.util"><B>PREV CLASS</B></A>
<A HREF="../../../../../org/apache/poi/ss/util/RegionUtil.html" title="class in org.apache.poi.ss.util"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/poi/ss/util/Region.html" target="_top"><B>FRAMES</B></A>
<A HREF="Region.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.poi.ss.util</FONT>
<BR>
Class Region</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.poi.ss.util.Region</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD>java.lang.Comparable<<A HREF="../../../../../org/apache/poi/ss/util/Region.html" title="class in org.apache.poi.ss.util">Region</A>></DD>
</DL>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/apache/poi/hssf/util/Region.html" title="class in org.apache.poi.hssf.util">Region</A></DD>
</DL>
<HR>
<B>Deprecated.</B> <I>(Aug-2008) use <A HREF="../../../../../org/apache/poi/ss/util/CellRangeAddress.html" title="class in org.apache.poi.ss.util"><CODE>CellRangeAddress</CODE></A></I>
<P>
<DL>
<DT><PRE>public class <B>Region</B><DT>extends java.lang.Object<DT>implements java.lang.Comparable<<A HREF="../../../../../org/apache/poi/ss/util/Region.html" title="class in org.apache.poi.ss.util">Region</A>></DL>
</PRE>
<P>
Represents a from/to row/col square. This is a object primitive
that can be used to represent row,col - row,col just as one would use String
to represent a string of characters. Its really only useful for HSSF though.
<P>
<P>
<DL>
<DT><B>Author:</B></DT>
<DD>Andrew C. Oliver acoliver at apache dot org</DD>
</DL>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../org/apache/poi/ss/util/Region.html#Region()">Region</A></B>()</CODE>
<BR>
<B>Deprecated.</B> Creates a new instance of Region (0,0 - 0,0)</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../org/apache/poi/ss/util/Region.html#Region(int, short, int, short)">Region</A></B>(int rowFrom,
short colFrom,
int rowTo,
short colTo)</CODE>
<BR>
<B>Deprecated.</B> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../org/apache/poi/ss/util/Region.html#Region(java.lang.String)">Region</A></B>(java.lang.String ref)</CODE>
<BR>
<B>Deprecated.</B> </TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/poi/ss/util/Region.html#compareTo(org.apache.poi.ss.util.Region)">compareTo</A></B>(<A HREF="../../../../../org/apache/poi/ss/util/Region.html" title="class in org.apache.poi.ss.util">Region</A> r)</CODE>
<BR>
<B>Deprecated.</B> Compares that the given region is the same less than or greater than this
region.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/poi/ss/util/Region.html#contains(int, short)">contains</A></B>(int row,
short col)</CODE>
<BR>
<B>Deprecated.</B> Answers: "is the row/column inside this range?"</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../../../../../org/apache/poi/ss/util/Region.html" title="class in org.apache.poi.ss.util">Region</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/poi/ss/util/Region.html#convertCellRangesToRegions(org.apache.poi.ss.util.CellRangeAddress[])">convertCellRangesToRegions</A></B>(<A HREF="../../../../../org/apache/poi/ss/util/CellRangeAddress.html" title="class in org.apache.poi.ss.util">CellRangeAddress</A>[] cellRanges)</CODE>
<BR>
<B>Deprecated.</B> Convert a List of CellRange objects to an array of regions</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../../../../../org/apache/poi/ss/util/CellRangeAddress.html" title="class in org.apache.poi.ss.util">CellRangeAddress</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/poi/ss/util/Region.html#convertRegionsToCellRanges(org.apache.poi.ss.util.Region[])">convertRegionsToCellRanges</A></B>(<A HREF="../../../../../org/apache/poi/ss/util/Region.html" title="class in org.apache.poi.ss.util">Region</A>[] regions)</CODE>
<BR>
<B>Deprecated.</B> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../../../../../org/apache/poi/ss/util/CellRangeAddress.html" title="class in org.apache.poi.ss.util">CellRangeAddress</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/poi/ss/util/Region.html#convertToCellRangeAddress(org.apache.poi.ss.util.Region)">convertToCellRangeAddress</A></B>(<A HREF="../../../../../org/apache/poi/ss/util/Region.html" title="class in org.apache.poi.ss.util">Region</A> r)</CODE>
<BR>
<B>Deprecated.</B> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/poi/ss/util/Region.html#equals(org.apache.poi.ss.util.Region)">equals</A></B>(<A HREF="../../../../../org/apache/poi/ss/util/Region.html" title="class in org.apache.poi.ss.util">Region</A> r)</CODE>
<BR>
<B>Deprecated.</B> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/poi/ss/util/Region.html#getArea()">getArea</A></B>()</CODE>
<BR>
<B>Deprecated.</B> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> short</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/poi/ss/util/Region.html#getColumnFrom()">getColumnFrom</A></B>()</CODE>
<BR>
<B>Deprecated.</B> get the upper left hand corner column number</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> short</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/poi/ss/util/Region.html#getColumnTo()">getColumnTo</A></B>()</CODE>
<BR>
<B>Deprecated.</B> get the lower right hand corner column number</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/poi/ss/util/Region.html#getRegionRef()">getRegionRef</A></B>()</CODE>
<BR>
<B>Deprecated.</B> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/poi/ss/util/Region.html#getRowFrom()">getRowFrom</A></B>()</CODE>
<BR>
<B>Deprecated.</B> get the upper left hand corner row number</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/poi/ss/util/Region.html#getRowTo()">getRowTo</A></B>()</CODE>
<BR>
<B>Deprecated.</B> get the lower right hand corner row number</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/poi/ss/util/Region.html#setColumnFrom(short)">setColumnFrom</A></B>(short colFrom)</CODE>
<BR>
<B>Deprecated.</B> set the upper left hand corner column number</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/poi/ss/util/Region.html#setColumnTo(short)">setColumnTo</A></B>(short colTo)</CODE>
<BR>
<B>Deprecated.</B> set the lower right hand corner column number</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/poi/ss/util/Region.html#setRowFrom(int)">setRowFrom</A></B>(int rowFrom)</CODE>
<BR>
<B>Deprecated.</B> set the upper left hand corner row number</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/poi/ss/util/Region.html#setRowTo(int)">setRowTo</A></B>(int rowTo)</CODE>
<BR>
<B>Deprecated.</B> get the lower right hand corner row number</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="Region()"><!-- --></A><H3>
Region</H3>
<PRE>
public <B>Region</B>()</PRE>
<DL>
<DD><B>Deprecated.</B> <DD>Creates a new instance of Region (0,0 - 0,0)
<P>
</DL>
<HR>
<A NAME="Region(int, short, int, short)"><!-- --></A><H3>
Region</H3>
<PRE>
public <B>Region</B>(int rowFrom,
short colFrom,
int rowTo,
short colTo)</PRE>
<DL>
<DD><B>Deprecated.</B> </DL>
<HR>
<A NAME="Region(java.lang.String)"><!-- --></A><H3>
Region</H3>
<PRE>
public <B>Region</B>(java.lang.String ref)</PRE>
<DL>
<DD><B>Deprecated.</B> </DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getColumnFrom()"><!-- --></A><H3>
getColumnFrom</H3>
<PRE>
public short <B>getColumnFrom</B>()</PRE>
<DL>
<DD><B>Deprecated.</B> <DD>get the upper left hand corner column number
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>column number for the upper left hand corner</DL>
</DD>
</DL>
<HR>
<A NAME="getRowFrom()"><!-- --></A><H3>
getRowFrom</H3>
<PRE>
public int <B>getRowFrom</B>()</PRE>
<DL>
<DD><B>Deprecated.</B> <DD>get the upper left hand corner row number
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>row number for the upper left hand corner</DL>
</DD>
</DL>
<HR>
<A NAME="getColumnTo()"><!-- --></A><H3>
getColumnTo</H3>
<PRE>
public short <B>getColumnTo</B>()</PRE>
<DL>
<DD><B>Deprecated.</B> <DD>get the lower right hand corner column number
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>column number for the lower right hand corner</DL>
</DD>
</DL>
<HR>
<A NAME="getRowTo()"><!-- --></A><H3>
getRowTo</H3>
<PRE>
public int <B>getRowTo</B>()</PRE>
<DL>
<DD><B>Deprecated.</B> <DD>get the lower right hand corner row number
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>row number for the lower right hand corner</DL>
</DD>
</DL>
<HR>
<A NAME="setColumnFrom(short)"><!-- --></A><H3>
setColumnFrom</H3>
<PRE>
public void <B>setColumnFrom</B>(short colFrom)</PRE>
<DL>
<DD><B>Deprecated.</B> <DD>set the upper left hand corner column number
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>colFrom</CODE> - column number for the upper left hand corner</DL>
</DD>
</DL>
<HR>
<A NAME="setRowFrom(int)"><!-- --></A><H3>
setRowFrom</H3>
<PRE>
public void <B>setRowFrom</B>(int rowFrom)</PRE>
<DL>
<DD><B>Deprecated.</B> <DD>set the upper left hand corner row number
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>rowFrom</CODE> - row number for the upper left hand corner</DL>
</DD>
</DL>
<HR>
<A NAME="setColumnTo(short)"><!-- --></A><H3>
setColumnTo</H3>
<PRE>
public void <B>setColumnTo</B>(short colTo)</PRE>
<DL>
<DD><B>Deprecated.</B> <DD>set the lower right hand corner column number
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>colTo</CODE> - column number for the lower right hand corner</DL>
</DD>
</DL>
<HR>
<A NAME="setRowTo(int)"><!-- --></A><H3>
setRowTo</H3>
<PRE>
public void <B>setRowTo</B>(int rowTo)</PRE>
<DL>
<DD><B>Deprecated.</B> <DD>get the lower right hand corner row number
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>rowTo</CODE> - row number for the lower right hand corner</DL>
</DD>
</DL>
<HR>
<A NAME="contains(int, short)"><!-- --></A><H3>
contains</H3>
<PRE>
public boolean <B>contains</B>(int row,
short col)</PRE>
<DL>
<DD><B>Deprecated.</B> <DD>Answers: "is the row/column inside this range?"
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD><code>true</code> if the cell is in the range and
<code>false</code> if it is not</DL>
</DD>
</DL>
<HR>
<A NAME="equals(org.apache.poi.ss.util.Region)"><!-- --></A><H3>
equals</H3>
<PRE>
public boolean <B>equals</B>(<A HREF="../../../../../org/apache/poi/ss/util/Region.html" title="class in org.apache.poi.ss.util">Region</A> r)</PRE>
<DL>
<DD><B>Deprecated.</B> <DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="compareTo(org.apache.poi.ss.util.Region)"><!-- --></A><H3>
compareTo</H3>
<PRE>
public int <B>compareTo</B>(<A HREF="../../../../../org/apache/poi/ss/util/Region.html" title="class in org.apache.poi.ss.util">Region</A> r)</PRE>
<DL>
<DD><B>Deprecated.</B> <DD>Compares that the given region is the same less than or greater than this
region. If any regional coordiant passed in is less than this regions
coordinants then a positive integer is returned. Otherwise a negative
integer is returned.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>compareTo</CODE> in interface <CODE>java.lang.Comparable<<A HREF="../../../../../org/apache/poi/ss/util/Region.html" title="class in org.apache.poi.ss.util">Region</A>></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>r</CODE> - region<DT><B>See Also:</B><DD><CODE>Comparable.compareTo(Object)</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getArea()"><!-- --></A><H3>
getArea</H3>
<PRE>
public int <B>getArea</B>()</PRE>
<DL>
<DD><B>Deprecated.</B> <DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the size of the region (number of cells in the area).</DL>
</DD>
</DL>
<HR>
<A NAME="convertCellRangesToRegions(org.apache.poi.ss.util.CellRangeAddress[])"><!-- --></A><H3>
convertCellRangesToRegions</H3>
<PRE>
public static <A HREF="../../../../../org/apache/poi/ss/util/Region.html" title="class in org.apache.poi.ss.util">Region</A>[] <B>convertCellRangesToRegions</B>(<A HREF="../../../../../org/apache/poi/ss/util/CellRangeAddress.html" title="class in org.apache.poi.ss.util">CellRangeAddress</A>[] cellRanges)</PRE>
<DL>
<DD><B>Deprecated.</B> <DD>Convert a List of CellRange objects to an array of regions
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cellRanges</CODE> - list of CellRange objects
<DT><B>Returns:</B><DD>regions</DL>
</DD>
</DL>
<HR>
<A NAME="convertRegionsToCellRanges(org.apache.poi.ss.util.Region[])"><!-- --></A><H3>
convertRegionsToCellRanges</H3>
<PRE>
public static <A HREF="../../../../../org/apache/poi/ss/util/CellRangeAddress.html" title="class in org.apache.poi.ss.util">CellRangeAddress</A>[] <B>convertRegionsToCellRanges</B>(<A HREF="../../../../../org/apache/poi/ss/util/Region.html" title="class in org.apache.poi.ss.util">Region</A>[] regions)</PRE>
<DL>
<DD><B>Deprecated.</B> <DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="convertToCellRangeAddress(org.apache.poi.ss.util.Region)"><!-- --></A><H3>
convertToCellRangeAddress</H3>
<PRE>
public static <A HREF="../../../../../org/apache/poi/ss/util/CellRangeAddress.html" title="class in org.apache.poi.ss.util">CellRangeAddress</A> <B>convertToCellRangeAddress</B>(<A HREF="../../../../../org/apache/poi/ss/util/Region.html" title="class in org.apache.poi.ss.util">Region</A> r)</PRE>
<DL>
<DD><B>Deprecated.</B> <DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getRegionRef()"><!-- --></A><H3>
getRegionRef</H3>
<PRE>
public java.lang.String <B>getRegionRef</B>()</PRE>
<DL>
<DD><B>Deprecated.</B> <DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the string reference for this region</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Region.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../org/apache/poi/ss/util/NumberToTextConverter.html" title="class in org.apache.poi.ss.util"><B>PREV CLASS</B></A>
<A HREF="../../../../../org/apache/poi/ss/util/RegionUtil.html" title="class in org.apache.poi.ss.util"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/poi/ss/util/Region.html" target="_top"><B>FRAMES</B></A>
<A HREF="Region.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<i>Copyright 2010 The Apache Software Foundation or
its licensors, as applicable.</i>
</BODY>
</HTML>