1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
/* ====================================================================
Copyright 2002-2004 Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
==================================================================== */
package org.apache.poi.hssf.util;
import org.apache.poi.hssf.record.MergeCellsRecord.MergedRegion;
/**
* 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.
*
* @author Andrew C. Oliver acoliver at apache dot org
*/
public class Region
implements Comparable
{
private int rowFrom;
private short colFrom;
private int rowTo;
private short colTo;
/**
* Creates a new instance of Region (0,0 - 0,0)
*/
public Region()
{
}
public Region(int rowFrom, short colFrom, int rowTo, short colTo)
{
this.rowFrom = rowFrom;
this.rowTo = rowTo;
this.colFrom = colFrom;
this.colTo = colTo;
}
/**
* 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.
*/
public Region(MergedRegion region)
{
this(region.row_from, region.col_from, region.row_to, region.col_to);
}
/**
* get the upper left hand corner column number
*
* @return column number for the upper left hand corner
*/
public short getColumnFrom()
{
return colFrom;
}
/**
* get the upper left hand corner row number
*
* @return row number for the upper left hand corner
*/
public int getRowFrom()
{
return rowFrom;
}
/**
* get the lower right hand corner column number
*
* @return column number for the lower right hand corner
*/
public short getColumnTo()
{
return colTo;
}
/**
* get the lower right hand corner row number
*
* @return row number for the lower right hand corner
*/
public int getRowTo()
{
return rowTo;
}
/**
* set the upper left hand corner column number
*
* @param colFrom column number for the upper left hand corner
*/
public void setColumnFrom(short colFrom)
{
this.colFrom = colFrom;
}
/**
* set the upper left hand corner row number
*
* @param rowFrom row number for the upper left hand corner
*/
public void setRowFrom(int rowFrom)
{
this.rowFrom = rowFrom;
}
/**
* set the lower right hand corner column number
*
* @param colTo column number for the lower right hand corner
*/
public void setColumnTo(short colTo)
{
this.colTo = colTo;
}
/**
* get the lower right hand corner row number
*
* @param rowTo row number for the lower right hand corner
*/
public void setRowTo(int rowTo)
{
this.rowTo = rowTo;
}
/**
* Answers: "is the row/column inside this range?"
*
* @return true if the cell is in the range and false if it is not
*/
public boolean contains(int row, short col)
{
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(Region r)
{
return (compareTo(r) == 0);
}
/**
* 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)
*/
public int compareTo(Region r)
{
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(Object o)
{
return compareTo(( Region ) o);
}
/**
* @return the area contained by this region (number of cells)
*/
public int getArea()
{
return ((1 + (getRowTo() - getRowFrom()))
* (1 + (getColumnTo() - getColumnFrom())));
}
}
|
