Author: nick
Date: Sat Oct 18 19:58:05 2014
New Revision: 1632833
URL: http://svn.apache.org/r1632833
Log:
SheetUtil helper for finding the main cell of a merged region, if in one
Added:
poi/trunk/src/testcases/org/apache/poi/ss/util/TestSheetUtil.java
Modified:
poi/trunk/src/java/org/apache/poi/ss/util/SheetUtil.java
Modified: poi/trunk/src/java/org/apache/poi/ss/util/SheetUtil.java
URL:
http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/ss/util/SheetUtil.java?rev=1632833&r1=1632832&r2=1632833&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/ss/util/SheetUtil.java (original)
+++ poi/trunk/src/java/org/apache/poi/ss/util/SheetUtil.java Sat Oct 18
19:58:05 2014
@@ -293,4 +293,41 @@ public class SheetUtil {
return false;
}
+ /**
+ * Return the cell, taking account of merged regions. Allows you to find
the
+ * cell who's contents are shown in a given position in the sheet.
+ *
+ * <p>If the cell at the given co-ordinates is a merged cell, this will
+ * return the primary (top-left) most cell of the merged region.
+ * <p>If the cell at the given co-ordinates is not in a merged region,
+ * then will return the cell itself.
+ * <p>If there is no cell defined at the given co-ordinates, will return
+ * null.
+ */
+ public static Cell getCellWithMerges(Sheet sheet, int rowIx, int colIx) {
+ Row r = sheet.getRow(rowIx);
+ if (r != null) {
+ Cell c = r.getCell(colIx);
+ if (c != null) {
+ // Normal, non-merged cell
+ return c;
+ }
+ }
+
+ for (int mr=0; mr<sheet.getNumMergedRegions(); mr++) {
+ CellRangeAddress mergedRegion = sheet.getMergedRegion(mr);
+ if (mergedRegion.isInRange(rowIx, colIx)) {
+ // The cell wanted is in this merged range
+ // Return the primary (top-left) cell for the range
+ r = sheet.getRow(mergedRegion.getFirstRow());
+ if (r != null) {
+ return r.getCell(mergedRegion.getFirstColumn());
+ }
+ }
+ }
+
+ // If we get here, then the cell isn't defined, and doesn't
+ // live within any merged regions
+ return null;
+ }
}
\ No newline at end of file
Added: poi/trunk/src/testcases/org/apache/poi/ss/util/TestSheetUtil.java
URL:
http://svn.apache.org/viewvc/poi/trunk/src/testcases/org/apache/poi/ss/util/TestSheetUtil.java?rev=1632833&view=auto
==============================================================================
--- poi/trunk/src/testcases/org/apache/poi/ss/util/TestSheetUtil.java (added)
+++ poi/trunk/src/testcases/org/apache/poi/ss/util/TestSheetUtil.java Sat Oct
18 19:58:05 2014
@@ -0,0 +1,65 @@
+/* ====================================================================
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.ss.util;
+
+import junit.framework.TestCase;
+
+import org.apache.poi.hssf.usermodel.HSSFWorkbook;
+import org.apache.poi.ss.usermodel.Row;
+import org.apache.poi.ss.usermodel.Sheet;
+import org.apache.poi.ss.usermodel.Workbook;
+
+/**
+ * Tests SheetUtil.
+ *
+ * @see org.apache.poi.ss.util.SheetUtil
+ */
+public final class TestSheetUtil extends TestCase {
+ public void testCellWithMerges() throws Exception {
+ Workbook wb = new HSSFWorkbook();
+ Sheet s = wb.createSheet();
+
+ // Create some test data
+ Row r2 = s.createRow(1);
+ r2.createCell(0).setCellValue(10);
+ r2.createCell(1).setCellValue(11);
+ Row r3 = s.createRow(2);
+ r3.createCell(0).setCellValue(20);
+ r3.createCell(1).setCellValue(21);
+
+ s.addMergedRegion(new CellRangeAddress(2, 3, 0, 0));
+ s.addMergedRegion(new CellRangeAddress(2, 2, 1, 4));
+
+ // With a cell that isn't defined, we'll get null
+ assertEquals(null, SheetUtil.getCellWithMerges(s, 0, 0));
+
+ // With a cell that's not in a merged region, we'll get that
+ assertEquals(10.0, SheetUtil.getCellWithMerges(s, 1,
0).getNumericCellValue());
+ assertEquals(11.0, SheetUtil.getCellWithMerges(s, 1,
1).getNumericCellValue());
+
+ // With a cell that's the primary one of a merged region, we get that
cell
+ assertEquals(20.0, SheetUtil.getCellWithMerges(s, 2,
0).getNumericCellValue());
+ assertEquals(21., SheetUtil.getCellWithMerges(s, 2,
1).getNumericCellValue());
+
+ // With a cell elsewhere in the merged region, get top-left
+ assertEquals(20.0, SheetUtil.getCellWithMerges(s, 3,
0).getNumericCellValue());
+ assertEquals(21.0, SheetUtil.getCellWithMerges(s, 2,
2).getNumericCellValue());
+ assertEquals(21.0, SheetUtil.getCellWithMerges(s, 2,
3).getNumericCellValue());
+ assertEquals(21.0, SheetUtil.getCellWithMerges(s, 2,
4).getNumericCellValue());
+ }
+}
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
