File	Doc	Category	Size	Date	Package
Region.java	API Doc	Apache Poi 3.0.1	5735	Mon Jan 01 12:39:36 GMT 2007	org.apache.poi.hssf.util

Region

• java.lang.Object

Fields Summary
private int	rowFrom
private short	colFrom
private int	rowTo
private short	colTo

Constructors Summary
public Region() Creates a new instance of Region (0,0 - 0,0)
public Region(int rowFrom, short colFrom, int rowTo, short colTo) this.rowFrom = rowFrom; this.rowTo = rowTo; this.colFrom = colFrom; this.colTo = colTo;
public Region(org.apache.poi.hssf.record.MergeCellsRecord.MergedRegion region) special constructor (I know this is bad but it is so wrong that its right okay) that makes a region from a mergedcells's region subrecord. this(region.row_from, region.col_from, region.row_to, region.col_to);

Methods Summary
public int	compareTo(org.apache.poi.hssf.util.Region r) 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. param r region see #compareTo(Object) if ((this.getRowFrom() == r.getRowFrom()) && (this.getColumnFrom() == r.getColumnFrom()) && (this.getRowTo() == r.getRowTo()) && (this.getColumnTo() == r.getColumnTo())) { return 0; } if ((this.getRowFrom() < r.getRowFrom()) || (this.getColumnFrom() < r.getColumnFrom()) || (this.getRowTo() < r.getRowTo()) || (this.getColumnTo() < r.getColumnTo())) { return 1; } return -1;
public int	compareTo(java.lang.Object o) return compareTo(( Region ) o);
public boolean	contains(int row, short col) Answers: "is the row/column inside this range?" return true if the cell is in the range and false if it is not if ((this.rowFrom <= row) && (this.rowTo >= row) && (this.colFrom <= col) && (this.colTo >= col)) { // System.out.println("Region ("+rowFrom+","+colFrom+","+rowTo+","+ // colTo+") does contain "+row+","+col); return true; } return false;
public boolean	equals(org.apache.poi.hssf.util.Region r) return (compareTo(r) == 0);
public int	getArea() return the area contained by this region (number of cells) return ((1 + (getRowTo() - getRowFrom())) * (1 + (getColumnTo() - getColumnFrom())));
public short	getColumnFrom() get the upper left hand corner column number return column number for the upper left hand corner return colFrom;
public short	getColumnTo() get the lower right hand corner column number return column number for the lower right hand corner return colTo;
public int	getRowFrom() get the upper left hand corner row number return row number for the upper left hand corner return rowFrom;
public int	getRowTo() get the lower right hand corner row number return row number for the lower right hand corner return rowTo;
public void	setColumnFrom(short colFrom) set the upper left hand corner column number param colFrom column number for the upper left hand corner this.colFrom = colFrom;
public void	setColumnTo(short colTo) set the lower right hand corner column number param colTo column number for the lower right hand corner this.colTo = colTo;
public void	setRowFrom(int rowFrom) set the upper left hand corner row number param rowFrom row number for the upper left hand corner this.rowFrom = rowFrom;
public void	setRowTo(int rowTo) get the lower right hand corner row number param rowTo row number for the lower right hand corner this.rowTo = rowTo;