Você não pode selecionar mais de 25 tópicos Os tópicos devem começar com uma letra ou um número, podem incluir traços ('-') e podem ter até 35 caracteres.

BaseTestSheet.java 55KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361
  1. /* ====================================================================
  2. Licensed to the Apache Software Foundation (ASF) under one or more
  3. contributor license agreements. See the NOTICE file distributed with
  4. this work for additional information regarding copyright ownership.
  5. The ASF licenses this file to You under the Apache License, Version 2.0
  6. (the "License"); you may not use this file except in compliance with
  7. the License. You may obtain a copy of the License at
  8. http://www.apache.org/licenses/LICENSE-2.0
  9. Unless required by applicable law or agreed to in writing, software
  10. distributed under the License is distributed on an "AS IS" BASIS,
  11. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. See the License for the specific language governing permissions and
  13. limitations under the License.
  14. ==================================================================== */
  15. package org.apache.poi.ss.usermodel;
  16. import static org.apache.poi.POITestCase.assertBetween;
  17. import static org.junit.jupiter.api.Assertions.assertEquals;
  18. import static org.junit.jupiter.api.Assertions.assertFalse;
  19. import static org.junit.jupiter.api.Assertions.assertNotEquals;
  20. import static org.junit.jupiter.api.Assertions.assertNotNull;
  21. import static org.junit.jupiter.api.Assertions.assertNull;
  22. import static org.junit.jupiter.api.Assertions.assertSame;
  23. import static org.junit.jupiter.api.Assertions.assertThrows;
  24. import static org.junit.jupiter.api.Assertions.assertTrue;
  25. import static org.junit.jupiter.api.Assumptions.assumeTrue;
  26. import java.io.IOException;
  27. import java.util.Arrays;
  28. import java.util.Collection;
  29. import java.util.HashMap;
  30. import java.util.HashSet;
  31. import java.util.Iterator;
  32. import java.util.Map;
  33. import java.util.Map.Entry;
  34. import java.util.Set;
  35. import org.apache.poi.common.usermodel.HyperlinkType;
  36. import org.apache.poi.ss.ITestDataProvider;
  37. import org.apache.poi.ss.SpreadsheetVersion;
  38. import org.apache.poi.ss.util.CellAddress;
  39. import org.apache.poi.ss.util.CellRangeAddress;
  40. import org.apache.poi.ss.util.PaneInformation;
  41. import org.junit.jupiter.api.Test;
  42. /**
  43. * Common superclass for testing {@link org.apache.poi.hssf.usermodel.HSSFCell},
  44. * {@link org.apache.poi.xssf.usermodel.XSSFCell} and
  45. * {@link org.apache.poi.xssf.streaming.SXSSFCell}
  46. */
  47. public abstract class BaseTestSheet {
  48. private static final int ROW_COUNT = 40000;
  49. protected final ITestDataProvider _testDataProvider;
  50. protected BaseTestSheet(ITestDataProvider testDataProvider) {
  51. _testDataProvider = testDataProvider;
  52. }
  53. protected void trackColumnsForAutoSizingIfSXSSF(Sheet sheet) {
  54. // do nothing for Sheet base class. This will be overridden for SXSSFSheets.
  55. }
  56. @Test
  57. public void createRow() throws IOException {
  58. try (Workbook workbook = _testDataProvider.createWorkbook()) {
  59. Sheet sheet = workbook.createSheet();
  60. assertEquals(0, sheet.getPhysicalNumberOfRows());
  61. //Test that we get null for undefined rownumber
  62. assertNull(sheet.getRow(1));
  63. // Test row creation with consecutive indexes
  64. Row row1 = sheet.createRow(0);
  65. Row row2 = sheet.createRow(1);
  66. assertEquals(0, row1.getRowNum());
  67. assertEquals(1, row2.getRowNum());
  68. Iterator<Row> it = sheet.rowIterator();
  69. assertTrue(it.hasNext());
  70. assertSame(row1, it.next());
  71. assertTrue(it.hasNext());
  72. assertSame(row2, it.next());
  73. assertEquals(1, sheet.getLastRowNum());
  74. // Test row creation with non consecutive index
  75. Row row101 = sheet.createRow(100);
  76. assertNotNull(row101);
  77. assertEquals(100, sheet.getLastRowNum());
  78. assertEquals(3, sheet.getPhysicalNumberOfRows());
  79. // Test overwriting an existing row
  80. Row row2_ovrewritten = sheet.createRow(1);
  81. Cell cell = row2_ovrewritten.createCell(0);
  82. cell.setCellValue(100);
  83. Iterator<Row> it2 = sheet.rowIterator();
  84. assertTrue(it2.hasNext());
  85. assertSame(row1, it2.next());
  86. assertTrue(it2.hasNext());
  87. Row row2_ovrewritten_ref = it2.next();
  88. assertSame(row2_ovrewritten, row2_ovrewritten_ref);
  89. assertEquals(100.0, row2_ovrewritten_ref.getCell(0).getNumericCellValue(), 0.0);
  90. }
  91. }
  92. @Test
  93. public void createRowBeforeFirstRow() throws IOException {
  94. try (Workbook workbook = _testDataProvider.createWorkbook()) {
  95. final Sheet sh = workbook.createSheet();
  96. sh.createRow(0);
  97. // Negative rows not allowed
  98. assertThrows(IllegalArgumentException.class, () -> sh.createRow(-1));
  99. }
  100. }
  101. @Test
  102. public void createRowAfterLastRow() throws IOException {
  103. final SpreadsheetVersion version = _testDataProvider.getSpreadsheetVersion();
  104. try (Workbook workbook = _testDataProvider.createWorkbook()) {
  105. final Sheet sh = workbook.createSheet();
  106. sh.createRow(version.getLastRowIndex());
  107. // Row number must be between 0 and last row
  108. assertThrows(IllegalArgumentException.class, () -> sh.createRow(version.getLastRowIndex() + 1));
  109. }
  110. }
  111. @Test
  112. public void removeRow() throws IOException {
  113. try (Workbook workbook = _testDataProvider.createWorkbook()) {
  114. Sheet sheet1 = workbook.createSheet();
  115. assertEquals(0, sheet1.getPhysicalNumberOfRows());
  116. assertEquals(-1, sheet1.getFirstRowNum());
  117. assertEquals(-1, sheet1.getLastRowNum());
  118. Row row0 = sheet1.createRow(0);
  119. assertEquals(1, sheet1.getPhysicalNumberOfRows());
  120. assertEquals(0, sheet1.getFirstRowNum());
  121. assertEquals(0, sheet1.getLastRowNum());
  122. sheet1.removeRow(row0);
  123. assertEquals(0, sheet1.getPhysicalNumberOfRows());
  124. assertEquals(-1, sheet1.getFirstRowNum());
  125. assertEquals(-1, sheet1.getLastRowNum());
  126. sheet1.createRow(1);
  127. Row row2 = sheet1.createRow(2);
  128. assertEquals(2, sheet1.getPhysicalNumberOfRows());
  129. assertEquals(1, sheet1.getFirstRowNum());
  130. assertEquals(2, sheet1.getLastRowNum());
  131. assertNotNull(sheet1.getRow(1));
  132. assertNotNull(sheet1.getRow(2));
  133. sheet1.removeRow(row2);
  134. assertNotNull(sheet1.getRow(1));
  135. assertNull(sheet1.getRow(2));
  136. assertEquals(1, sheet1.getPhysicalNumberOfRows());
  137. assertEquals(1, sheet1.getFirstRowNum());
  138. assertEquals(1, sheet1.getLastRowNum());
  139. Row row3 = sheet1.createRow(3);
  140. Sheet sheet2 = workbook.createSheet();
  141. IllegalArgumentException ex = assertThrows(
  142. IllegalArgumentException.class,
  143. () -> sheet2.removeRow(row3)
  144. );
  145. assertEquals("Specified row does not belong to this sheet", ex.getMessage());
  146. }
  147. }
  148. @Test
  149. public void cloneSheet() throws IOException {
  150. try (Workbook workbook = _testDataProvider.createWorkbook()) {
  151. CreationHelper factory = workbook.getCreationHelper();
  152. Sheet sheet = workbook.createSheet("Test Clone");
  153. Row row = sheet.createRow(0);
  154. Cell cell = row.createCell(0);
  155. Cell cell2 = row.createCell(1);
  156. cell.setCellValue(factory.createRichTextString("clone_test"));
  157. cell2.setCellFormula("SIN(1)");
  158. Sheet clonedSheet = workbook.cloneSheet(0);
  159. Row clonedRow = clonedSheet.getRow(0);
  160. //Check for a good clone
  161. assertEquals(clonedRow.getCell(0).getRichStringCellValue().getString(), "clone_test");
  162. //Check that the cells are not somehow linked
  163. cell.setCellValue(factory.createRichTextString("Difference Check"));
  164. cell2.setCellFormula("cos(2)");
  165. assertNotEquals("Difference Check", clonedRow.getCell(0).getRichStringCellValue().getString(),
  166. "string cell not properly cloned");
  167. assertNotEquals("COS(2)", clonedRow.getCell(1).getCellFormula(), "formula cell not properly cloned");
  168. assertEquals(clonedRow.getCell(0).getRichStringCellValue().getString(), "clone_test");
  169. assertEquals(clonedRow.getCell(1).getCellFormula(), "SIN(1)");
  170. }
  171. }
  172. /** tests that the sheet name for multiple clones of the same sheet is unique
  173. * BUG 37416
  174. */
  175. @Test
  176. public void cloneSheetMultipleTimes() throws IOException {
  177. try (Workbook workbook = _testDataProvider.createWorkbook()) {
  178. CreationHelper factory = workbook.getCreationHelper();
  179. Sheet sheet = workbook.createSheet("Test Clone");
  180. Row row = sheet.createRow(0);
  181. Cell cell = row.createCell(0);
  182. cell.setCellValue(factory.createRichTextString("clone_test"));
  183. //Clone the sheet multiple times
  184. workbook.cloneSheet(0);
  185. workbook.cloneSheet(0);
  186. assertNotNull(workbook.getSheet("Test Clone"));
  187. assertNotNull(workbook.getSheet("Test Clone (2)"));
  188. assertEquals("Test Clone (3)", workbook.getSheetName(2));
  189. assertNotNull(workbook.getSheet("Test Clone (3)"));
  190. workbook.removeSheetAt(0);
  191. workbook.removeSheetAt(0);
  192. workbook.removeSheetAt(0);
  193. workbook.createSheet("abc ( 123)");
  194. workbook.cloneSheet(0);
  195. assertEquals("abc (124)", workbook.getSheetName(1));
  196. }
  197. }
  198. /**
  199. * Setting landscape and portrait stuff on new sheets
  200. */
  201. @Test
  202. public void printSetupLandscapeNew() throws IOException {
  203. try (Workbook wb1 = _testDataProvider.createWorkbook()) {
  204. Sheet sheetL = wb1.createSheet("LandscapeS");
  205. Sheet sheetP = wb1.createSheet("LandscapeP");
  206. // Check two aspects of the print setup
  207. assertFalse(sheetL.getPrintSetup().getLandscape());
  208. assertFalse(sheetP.getPrintSetup().getLandscape());
  209. assertEquals(1, sheetL.getPrintSetup().getCopies());
  210. assertEquals(1, sheetP.getPrintSetup().getCopies());
  211. // Change one on each
  212. sheetL.getPrintSetup().setLandscape(true);
  213. sheetP.getPrintSetup().setCopies((short) 3);
  214. // Check taken
  215. assertTrue(sheetL.getPrintSetup().getLandscape());
  216. assertFalse(sheetP.getPrintSetup().getLandscape());
  217. assertEquals(1, sheetL.getPrintSetup().getCopies());
  218. assertEquals(3, sheetP.getPrintSetup().getCopies());
  219. // Save and re-load, and check still there
  220. try (Workbook wb2 = _testDataProvider.writeOutAndReadBack(wb1)) {
  221. sheetL = wb2.getSheet("LandscapeS");
  222. sheetP = wb2.getSheet("LandscapeP");
  223. assertTrue(sheetL.getPrintSetup().getLandscape());
  224. assertFalse(sheetP.getPrintSetup().getLandscape());
  225. assertEquals(1, sheetL.getPrintSetup().getCopies());
  226. assertEquals(3, sheetP.getPrintSetup().getCopies());
  227. }
  228. }
  229. }
  230. /**
  231. * Disallow creating wholly or partially overlapping merged regions
  232. * as this results in a corrupted workbook
  233. */
  234. @Test
  235. public void addOverlappingMergedRegions() throws IOException {
  236. try (final Workbook wb = _testDataProvider.createWorkbook()) {
  237. final Sheet sheet = wb.createSheet();
  238. final CellRangeAddress baseRegion = new CellRangeAddress(0, 1, 0, 1); //A1:B2
  239. assertEquals(0, sheet.addMergedRegion(baseRegion));
  240. final CellRangeAddress duplicateRegion = new CellRangeAddress(0, 1, 0, 1); //A1:B2
  241. assertThrows(
  242. IllegalStateException.class,
  243. () -> sheet.addMergedRegion(duplicateRegion),
  244. "Should not be able to add a merged region (" + duplicateRegion.formatAsString() + ") " +
  245. "if sheet already contains the same merged region (" + baseRegion.formatAsString() + ")"
  246. );
  247. final CellRangeAddress partiallyOverlappingRegion = new CellRangeAddress(1, 2, 1, 2); //B2:C3
  248. assertThrows(
  249. IllegalStateException.class,
  250. () -> sheet.addMergedRegion(partiallyOverlappingRegion),
  251. "Should not be able to add a merged region (" + partiallyOverlappingRegion.formatAsString() + ") " +
  252. "if it partially overlaps with an existing merged region (" + baseRegion.formatAsString() + ")"
  253. );
  254. final CellRangeAddress subsetRegion = new CellRangeAddress(0, 1, 0, 0); //A1:A2
  255. assertThrows(
  256. IllegalStateException.class,
  257. () -> sheet.addMergedRegion(subsetRegion),
  258. "Should not be able to add a merged region (" + subsetRegion.formatAsString() + ") " +
  259. "if it is a formal subset of an existing merged region (" + baseRegion.formatAsString() + ")"
  260. );
  261. final CellRangeAddress supersetRegion = new CellRangeAddress(0, 2, 0, 2); //A1:C3
  262. assertThrows(
  263. IllegalStateException.class,
  264. () -> sheet.addMergedRegion(supersetRegion),
  265. "Should not be able to add a merged region (" + supersetRegion.formatAsString() + ") " +
  266. "if it is a formal superset of an existing merged region (" + baseRegion.formatAsString() + ")"
  267. );
  268. final CellRangeAddress disjointRegion = new CellRangeAddress(10, 11, 10, 11);
  269. assertEquals(1, sheet.addMergedRegion(disjointRegion));
  270. }
  271. }
  272. /*
  273. * Bug 56345: Reject single-cell merged regions
  274. */
  275. @Test
  276. public void addMergedRegionWithSingleCellShouldFail() throws IOException {
  277. try (Workbook wb = _testDataProvider.createWorkbook()) {
  278. final Sheet sheet = wb.createSheet();
  279. final CellRangeAddress region = CellRangeAddress.valueOf("A1:A1");
  280. assertThrows(
  281. IllegalArgumentException.class,
  282. () -> sheet.addMergedRegion(region),
  283. "Should not be able to add a single-cell merged region (" + region.formatAsString() + ")"
  284. );
  285. }
  286. }
  287. /**
  288. * Test adding merged regions. If the region's bounds are outside of the allowed range
  289. * then an IllegalArgumentException should be thrown
  290. *
  291. */
  292. @Test
  293. public void addMerged() throws IOException {
  294. try (Workbook wb = _testDataProvider.createWorkbook()) {
  295. Sheet sheet = wb.createSheet();
  296. assertEquals(0, sheet.getNumMergedRegions());
  297. SpreadsheetVersion ssVersion = _testDataProvider.getSpreadsheetVersion();
  298. CellRangeAddress region = new CellRangeAddress(0, 1, 0, 1);
  299. assertEquals(0, sheet.addMergedRegion(region));
  300. assertEquals(1, sheet.getNumMergedRegions());
  301. IllegalArgumentException ex = assertThrows(
  302. IllegalArgumentException.class,
  303. () -> sheet.addMergedRegion(new CellRangeAddress(-1, -1, -1, -1))
  304. );
  305. assertEquals("Merged region : must contain 2 or more cells", ex.getMessage());
  306. ex = assertThrows(
  307. IllegalArgumentException.class,
  308. () -> sheet.addMergedRegion(new CellRangeAddress(0, 0, 0, ssVersion.getLastColumnIndex() + 1))
  309. );
  310. assertEquals("Maximum column number is " + ssVersion.getLastColumnIndex(), ex.getMessage());
  311. ex = assertThrows(
  312. IllegalArgumentException.class,
  313. () -> sheet.addMergedRegion(new CellRangeAddress(0, ssVersion.getLastRowIndex() + 1, 0, 1))
  314. );
  315. assertEquals("Maximum row number is " + ssVersion.getLastRowIndex(), ex.getMessage());
  316. assertEquals(1, sheet.getNumMergedRegions());
  317. }
  318. }
  319. /**
  320. * When removing one merged region, it would break
  321. *
  322. */
  323. @Test
  324. public void removeMerged() throws IOException {
  325. try (Workbook wb = _testDataProvider.createWorkbook()) {
  326. Sheet sheet = wb.createSheet();
  327. CellRangeAddress region = new CellRangeAddress(0, 1, 0, 1);
  328. assertEquals(0, sheet.addMergedRegion(region));
  329. region = new CellRangeAddress(2, 3, 0, 1);
  330. assertEquals(1, sheet.addMergedRegion(region));
  331. sheet.removeMergedRegion(0);
  332. region = sheet.getMergedRegion(0);
  333. assertEquals(2, region.getFirstRow(), "Left over region should be starting at row 2");
  334. sheet.removeMergedRegion(0);
  335. assertEquals(0, sheet.getNumMergedRegions(), "there should be no merged regions left!");
  336. //an, add, remove, get(0) would null pointer
  337. assertEquals(0, sheet.addMergedRegion(region));
  338. assertEquals(1, sheet.getNumMergedRegions(), "there should now be one merged region!");
  339. sheet.removeMergedRegion(0);
  340. assertEquals(0, sheet.getNumMergedRegions(), "there should now be zero merged regions!");
  341. //add it again!
  342. region.setLastRow(4);
  343. assertEquals(0, sheet.addMergedRegion(region));
  344. assertEquals(1, sheet.getNumMergedRegions(), "there should now be one merged region!");
  345. //should exist now!
  346. assertTrue(1 <= sheet.getNumMergedRegions(), "there isn't more than one merged region in there");
  347. region = sheet.getMergedRegion(0);
  348. assertEquals(4, region.getLastRow(), "the merged row to doesn't match the one we put in ");
  349. }
  350. }
  351. /**
  352. * Remove multiple merged regions
  353. */
  354. @Test
  355. public void removeMergedRegions() throws IOException {
  356. try (Workbook wb = _testDataProvider.createWorkbook()) {
  357. Sheet sheet = wb.createSheet();
  358. Map<Integer, CellRangeAddress> mergedRegions = new HashMap<>();
  359. for (int r = 0; r < 10; r++) {
  360. CellRangeAddress region = new CellRangeAddress(r, r, 0, 1);
  361. mergedRegions.put(r, region);
  362. assertEquals(r, sheet.addMergedRegion(region));
  363. }
  364. assertCollectionEquals(mergedRegions.values(), sheet.getMergedRegions());
  365. Collection<Integer> removed = Arrays.asList(0, 2, 3, 6, 8);
  366. mergedRegions.keySet().removeAll(removed);
  367. sheet.removeMergedRegions(removed);
  368. assertCollectionEquals(mergedRegions.values(), sheet.getMergedRegions());
  369. }
  370. }
  371. private static <T> void assertCollectionEquals(Collection<T> expected, Collection<T> actual) {
  372. Set<T> e = new HashSet<>(expected);
  373. Set<T> a = new HashSet<>(actual);
  374. assertEquals(e, a);
  375. }
  376. @Test
  377. public void shiftMerged() throws IOException {
  378. try (Workbook wb = _testDataProvider.createWorkbook()) {
  379. CreationHelper factory = wb.getCreationHelper();
  380. Sheet sheet = wb.createSheet();
  381. Row row = sheet.createRow(0);
  382. Cell cell = row.createCell(0);
  383. cell.setCellValue(factory.createRichTextString("first row, first cell"));
  384. row = sheet.createRow(1);
  385. cell = row.createCell(1);
  386. cell.setCellValue(factory.createRichTextString("second row, second cell"));
  387. CellRangeAddress region = CellRangeAddress.valueOf("A2:B2");
  388. assertEquals(0, sheet.addMergedRegion(region));
  389. sheet.shiftRows(1, 1, 1);
  390. region = sheet.getMergedRegion(0);
  391. CellRangeAddress expectedRegion = CellRangeAddress.valueOf("A3:B3");
  392. assertEquals(expectedRegion, region, "Merged region should shift down a row");
  393. }
  394. }
  395. /**
  396. * bug 58885: checking for overlapping merged regions when
  397. * adding a merged region is safe, but runs in O(n).
  398. * the check for merged regions when adding a merged region
  399. * can be skipped (unsafe) and run in O(1).
  400. */
  401. @Test
  402. public void addMergedRegionUnsafe() throws IOException {
  403. try (Workbook wb = _testDataProvider.createWorkbook()) {
  404. Sheet sh = wb.createSheet();
  405. CellRangeAddress region1 = CellRangeAddress.valueOf("A1:B2");
  406. CellRangeAddress region2 = CellRangeAddress.valueOf("B2:C3");
  407. CellRangeAddress region3 = CellRangeAddress.valueOf("C3:D4");
  408. CellRangeAddress region4 = CellRangeAddress.valueOf("J10:K11");
  409. assumeTrue(region1.intersects(region2));
  410. assumeTrue(region2.intersects(region3));
  411. assertEquals(0, sh.addMergedRegionUnsafe(region1));
  412. assertTrue(sh.getMergedRegions().contains(region1));
  413. // adding a duplicate or overlapping merged region should not
  414. // raise an exception with the unsafe version of addMergedRegion.
  415. assertEquals(1, sh.addMergedRegionUnsafe(region2));
  416. // the safe version of addMergedRegion should throw when trying to add a merged region that overlaps an existing region
  417. assertTrue(sh.getMergedRegions().contains(region2));
  418. assertThrows(
  419. IllegalStateException.class,
  420. () -> sh.addMergedRegion(region3),
  421. "region3 overlaps already added merged region2."
  422. );
  423. assertFalse(sh.getMergedRegions().contains(region3));
  424. // addMergedRegion should not re-validate previously-added merged regions
  425. assertEquals(2, sh.addMergedRegion(region4));
  426. // validation methods should detect a problem with previously added merged regions (runs in O(n^2) time)
  427. assertThrows(
  428. IllegalStateException.class,
  429. sh::validateMergedRegions,
  430. "Sheet contains merged regions A1:B2 and B2:C3, which overlap at B2."
  431. );
  432. }
  433. }
  434. /**
  435. * Tests the display of gridlines, formulas, and rowcolheadings.
  436. */
  437. @Test
  438. public void displayOptions() throws IOException {
  439. try (Workbook wb1 = _testDataProvider.createWorkbook()) {
  440. Sheet sheet = wb1.createSheet();
  441. assertTrue(sheet.isDisplayGridlines());
  442. assertTrue(sheet.isDisplayRowColHeadings());
  443. assertFalse(sheet.isDisplayFormulas());
  444. assertTrue(sheet.isDisplayZeros());
  445. sheet.setDisplayGridlines(false);
  446. sheet.setDisplayRowColHeadings(false);
  447. sheet.setDisplayFormulas(true);
  448. sheet.setDisplayZeros(false);
  449. try (Workbook wb2 = _testDataProvider.writeOutAndReadBack(wb1)) {
  450. sheet = wb2.getSheetAt(0);
  451. assertFalse(sheet.isDisplayGridlines());
  452. assertFalse(sheet.isDisplayRowColHeadings());
  453. assertTrue(sheet.isDisplayFormulas());
  454. assertFalse(sheet.isDisplayZeros());
  455. }
  456. }
  457. }
  458. @Test
  459. public void columnWidth() throws IOException {
  460. try (Workbook wb1 = _testDataProvider.createWorkbook()) {
  461. Sheet sheet1 = wb1.createSheet();
  462. //default column width measured in characters
  463. sheet1.setDefaultColumnWidth(10);
  464. assertEquals(10, sheet1.getDefaultColumnWidth());
  465. //columns A-C have default width
  466. assertEquals(256 * 10, sheet1.getColumnWidth(0));
  467. assertEquals(256 * 10, sheet1.getColumnWidth(1));
  468. assertEquals(256 * 10, sheet1.getColumnWidth(2));
  469. //set custom width for D-F
  470. for (char i = 'D'; i <= 'F'; i++) {
  471. //Sheet#setColumnWidth accepts the width in units of 1/256th of a character width
  472. int w = 256 * 12;
  473. sheet1.setColumnWidth(i, w);
  474. assertEquals(w, sheet1.getColumnWidth(i));
  475. }
  476. //reset the default column width, columns A-C change, D-F still have custom width
  477. sheet1.setDefaultColumnWidth(20);
  478. assertEquals(20, sheet1.getDefaultColumnWidth());
  479. assertEquals(256 * 20, sheet1.getColumnWidth(0));
  480. assertEquals(256 * 20, sheet1.getColumnWidth(1));
  481. assertEquals(256 * 20, sheet1.getColumnWidth(2));
  482. for (char i = 'D'; i <= 'F'; i++) {
  483. int w = 256 * 12;
  484. assertEquals(w, sheet1.getColumnWidth(i));
  485. }
  486. // check for 16-bit signed/unsigned error:
  487. sheet1.setColumnWidth(10, 40000);
  488. assertEquals(40000, sheet1.getColumnWidth(10));
  489. //The maximum column width for an individual cell is 255 characters
  490. IllegalArgumentException ex = assertThrows(
  491. IllegalArgumentException.class,
  492. () -> sheet1.setColumnWidth(9, 256 * 256)
  493. );
  494. assertEquals("The maximum column width for an individual cell is 255 characters.", ex.getMessage());
  495. //serialize and read again
  496. try (Workbook wb2 = _testDataProvider.writeOutAndReadBack(wb1)) {
  497. Sheet sheet2 = wb2.getSheetAt(0);
  498. assertEquals(20, sheet2.getDefaultColumnWidth());
  499. //columns A-C have default width
  500. assertEquals(256 * 20, sheet2.getColumnWidth(0));
  501. assertEquals(256 * 20, sheet2.getColumnWidth(1));
  502. assertEquals(256 * 20, sheet2.getColumnWidth(2));
  503. //columns D-F have custom width
  504. for (char i = 'D'; i <= 'F'; i++) {
  505. short w = (256 * 12);
  506. assertEquals(w, sheet2.getColumnWidth(i));
  507. }
  508. assertEquals(40000, sheet2.getColumnWidth(10));
  509. }
  510. }
  511. }
  512. @Test
  513. public void defaultRowHeight() throws IOException {
  514. try (Workbook workbook = _testDataProvider.createWorkbook()) {
  515. Sheet sheet = workbook.createSheet();
  516. sheet.setDefaultRowHeightInPoints(15);
  517. assertEquals((short) 300, sheet.getDefaultRowHeight());
  518. assertEquals(15.0F, sheet.getDefaultRowHeightInPoints(), 0F);
  519. Row row = sheet.createRow(1);
  520. // new row inherits default height from the sheet
  521. assertEquals(sheet.getDefaultRowHeight(), row.getHeight());
  522. // Set a new default row height in twips and test getting the value in points
  523. sheet.setDefaultRowHeight((short) 360);
  524. assertEquals(18.0f, sheet.getDefaultRowHeightInPoints(), 0F);
  525. assertEquals((short) 360, sheet.getDefaultRowHeight());
  526. // Test that defaultRowHeight is a truncated short: E.G. 360inPoints -> 18; 361inPoints -> 18
  527. sheet.setDefaultRowHeight((short) 361);
  528. assertEquals((float) 361 / 20, sheet.getDefaultRowHeightInPoints(), 0F);
  529. assertEquals((short) 361, sheet.getDefaultRowHeight());
  530. // Set a new default row height in points and test getting the value in twips
  531. sheet.setDefaultRowHeightInPoints(17.5f);
  532. assertEquals(17.5f, sheet.getDefaultRowHeightInPoints(), 0F);
  533. assertEquals((short) (17.5f * 20), sheet.getDefaultRowHeight());
  534. }
  535. }
  536. /** cell with formula becomes null on cloning a sheet*/
  537. @Test
  538. public void bug35084() throws IOException {
  539. try (Workbook wb = _testDataProvider.createWorkbook()) {
  540. Sheet s = wb.createSheet("Sheet1");
  541. Row r = s.createRow(0);
  542. r.createCell(0).setCellValue(1);
  543. r.createCell(1).setCellFormula("A1*2");
  544. Sheet s1 = wb.cloneSheet(0);
  545. r = s1.getRow(0);
  546. // sanity check
  547. assertEquals(r.getCell(0).getNumericCellValue(), 1, 0, "double");
  548. assertNotNull(r.getCell(1));
  549. assertEquals(r.getCell(1).getCellFormula(), "A1*2", "formula");
  550. }
  551. }
  552. /** test that new default column styles get applied */
  553. @Test
  554. public void defaultColumnStyle() throws IOException {
  555. try (Workbook wb = _testDataProvider.createWorkbook()) {
  556. CellStyle style = wb.createCellStyle();
  557. Sheet sheet = wb.createSheet();
  558. sheet.setDefaultColumnStyle(0, style);
  559. assertNotNull(sheet.getColumnStyle(0));
  560. assertEquals(style.getIndex(), sheet.getColumnStyle(0).getIndex());
  561. Row row = sheet.createRow(0);
  562. Cell cell = row.createCell(0);
  563. CellStyle style2 = cell.getCellStyle();
  564. assertNotNull(style2);
  565. assertEquals(style.getIndex(), style2.getIndex(), "style should match");
  566. }
  567. }
  568. @Test
  569. public void outlineProperties() throws IOException {
  570. try (Workbook wb1 = _testDataProvider.createWorkbook()) {
  571. Sheet sheet = wb1.createSheet();
  572. //TODO defaults are different in HSSF and XSSF
  573. //assertTrue(sheet.getRowSumsBelow());
  574. //assertTrue(sheet.getRowSumsRight());
  575. sheet.setRowSumsBelow(false);
  576. sheet.setRowSumsRight(false);
  577. assertFalse(sheet.getRowSumsBelow());
  578. assertFalse(sheet.getRowSumsRight());
  579. sheet.setRowSumsBelow(true);
  580. sheet.setRowSumsRight(true);
  581. assertTrue(sheet.getRowSumsBelow());
  582. assertTrue(sheet.getRowSumsRight());
  583. try (Workbook wb2 = _testDataProvider.writeOutAndReadBack(wb1)) {
  584. sheet = wb2.getSheetAt(0);
  585. assertTrue(sheet.getRowSumsBelow());
  586. assertTrue(sheet.getRowSumsRight());
  587. }
  588. }
  589. }
  590. /**
  591. * Test basic display and print properties
  592. */
  593. @Test
  594. public void sheetProperties() throws IOException {
  595. try (Workbook wb = _testDataProvider.createWorkbook()) {
  596. Sheet sheet = wb.createSheet();
  597. assertFalse(sheet.getHorizontallyCenter());
  598. sheet.setHorizontallyCenter(true);
  599. assertTrue(sheet.getHorizontallyCenter());
  600. sheet.setHorizontallyCenter(false);
  601. assertFalse(sheet.getHorizontallyCenter());
  602. assertFalse(sheet.getVerticallyCenter());
  603. sheet.setVerticallyCenter(true);
  604. assertTrue(sheet.getVerticallyCenter());
  605. sheet.setVerticallyCenter(false);
  606. assertFalse(sheet.getVerticallyCenter());
  607. assertFalse(sheet.isPrintGridlines());
  608. sheet.setPrintGridlines(true);
  609. assertTrue(sheet.isPrintGridlines());
  610. assertFalse(sheet.isPrintRowAndColumnHeadings());
  611. sheet.setPrintRowAndColumnHeadings(true);
  612. assertTrue(sheet.isPrintRowAndColumnHeadings());
  613. assertFalse(sheet.isDisplayFormulas());
  614. sheet.setDisplayFormulas(true);
  615. assertTrue(sheet.isDisplayFormulas());
  616. assertTrue(sheet.isDisplayGridlines());
  617. sheet.setDisplayGridlines(false);
  618. assertFalse(sheet.isDisplayGridlines());
  619. //TODO: default "guts" is different in HSSF and XSSF
  620. //assertTrue(sheet.getDisplayGuts());
  621. sheet.setDisplayGuts(false);
  622. assertFalse(sheet.getDisplayGuts());
  623. assertTrue(sheet.isDisplayRowColHeadings());
  624. sheet.setDisplayRowColHeadings(false);
  625. assertFalse(sheet.isDisplayRowColHeadings());
  626. //TODO: default "autobreaks" is different in HSSF and XSSF
  627. //assertTrue(sheet.getAutobreaks());
  628. sheet.setAutobreaks(false);
  629. assertFalse(sheet.getAutobreaks());
  630. assertFalse(sheet.getScenarioProtect());
  631. //TODO: default "fit-to-page" is different in HSSF and XSSF
  632. //assertFalse(sheet.getFitToPage());
  633. sheet.setFitToPage(true);
  634. assertTrue(sheet.getFitToPage());
  635. sheet.setFitToPage(false);
  636. assertFalse(sheet.getFitToPage());
  637. }
  638. }
  639. @Test
  640. public void testGetSetMargin() throws IOException {
  641. double[] defaultMargins = (getClass().getName().contains("xssf"))
  642. ? new double[]{0.7, 0.7, 0.75, 0.75, 0.3, 0.3}
  643. : new double[]{0.75, 0.75, 1.0, 1.0, 0.3, 0.3};
  644. double marginLeft = defaultMargins[0];
  645. double marginRight = defaultMargins[1];
  646. double marginTop = defaultMargins[2];
  647. double marginBottom = defaultMargins[3];
  648. //double marginHeader = defaultMargins[4];
  649. //double marginFooter = defaultMargins[5];
  650. try (Workbook workbook = _testDataProvider.createWorkbook()) {
  651. Sheet sheet = workbook.createSheet("Sheet 1");
  652. assertEquals(marginLeft, sheet.getMargin(Sheet.LeftMargin), 0.0);
  653. sheet.setMargin(Sheet.LeftMargin, 10.0);
  654. //left margin is custom, all others are default
  655. assertEquals(10.0, sheet.getMargin(Sheet.LeftMargin), 0.0);
  656. assertEquals(marginRight, sheet.getMargin(Sheet.RightMargin), 0.0);
  657. assertEquals(marginTop, sheet.getMargin(Sheet.TopMargin), 0.0);
  658. assertEquals(marginBottom, sheet.getMargin(Sheet.BottomMargin), 0.0);
  659. sheet.setMargin(Sheet.RightMargin, 11.0);
  660. assertEquals(11.0, sheet.getMargin(Sheet.RightMargin), 0.0);
  661. sheet.setMargin(Sheet.TopMargin, 12.0);
  662. assertEquals(12.0, sheet.getMargin(Sheet.TopMargin), 0.0);
  663. sheet.setMargin(Sheet.BottomMargin, 13.0);
  664. assertEquals(13.0, sheet.getMargin(Sheet.BottomMargin), 0.0);
  665. sheet.setMargin(Sheet.FooterMargin, 5.6);
  666. assertEquals(5.6, sheet.getMargin(Sheet.FooterMargin), 0.0);
  667. sheet.setMargin(Sheet.HeaderMargin, 11.5);
  668. assertEquals(11.5, sheet.getMargin(Sheet.HeaderMargin), 0.0);
  669. // incorrect margin constant
  670. IllegalArgumentException ex = assertThrows(
  671. IllegalArgumentException.class,
  672. () -> sheet.setMargin((short) 65, 15)
  673. );
  674. assertEquals("Unknown margin constant: 65", ex.getMessage());
  675. }
  676. }
  677. @Test
  678. public void rowBreaks() throws IOException {
  679. try (Workbook workbook = _testDataProvider.createWorkbook()) {
  680. Sheet sheet = workbook.createSheet();
  681. //Sheet#getRowBreaks() returns an empty array if no row breaks are defined
  682. assertNotNull(sheet.getRowBreaks());
  683. assertEquals(0, sheet.getRowBreaks().length);
  684. sheet.setRowBreak(1);
  685. assertEquals(1, sheet.getRowBreaks().length);
  686. sheet.setRowBreak(15);
  687. assertEquals(2, sheet.getRowBreaks().length);
  688. assertEquals(1, sheet.getRowBreaks()[0]);
  689. assertEquals(15, sheet.getRowBreaks()[1]);
  690. sheet.setRowBreak(1);
  691. assertEquals(2, sheet.getRowBreaks().length);
  692. assertTrue(sheet.isRowBroken(1));
  693. assertTrue(sheet.isRowBroken(15));
  694. //now remove the created breaks
  695. sheet.removeRowBreak(1);
  696. assertEquals(1, sheet.getRowBreaks().length);
  697. sheet.removeRowBreak(15);
  698. assertEquals(0, sheet.getRowBreaks().length);
  699. assertFalse(sheet.isRowBroken(1));
  700. assertFalse(sheet.isRowBroken(15));
  701. }
  702. }
  703. @Test
  704. public void columnBreaks() throws IOException {
  705. try (Workbook workbook = _testDataProvider.createWorkbook()) {
  706. Sheet sheet = workbook.createSheet();
  707. assertNotNull(sheet.getColumnBreaks());
  708. assertEquals(0, sheet.getColumnBreaks().length);
  709. assertFalse(sheet.isColumnBroken(0));
  710. sheet.setColumnBreak(11);
  711. assertNotNull(sheet.getColumnBreaks());
  712. assertEquals(11, sheet.getColumnBreaks()[0]);
  713. sheet.setColumnBreak(12);
  714. assertEquals(2, sheet.getColumnBreaks().length);
  715. assertTrue(sheet.isColumnBroken(11));
  716. assertTrue(sheet.isColumnBroken(12));
  717. sheet.removeColumnBreak((short) 11);
  718. assertEquals(1, sheet.getColumnBreaks().length);
  719. sheet.removeColumnBreak((short) 15); //remove non-existing
  720. assertEquals(1, sheet.getColumnBreaks().length);
  721. sheet.removeColumnBreak((short) 12);
  722. assertEquals(0, sheet.getColumnBreaks().length);
  723. assertFalse(sheet.isColumnBroken(11));
  724. assertFalse(sheet.isColumnBroken(12));
  725. }
  726. }
  727. @Test
  728. public void getFirstLastRowNum() throws IOException {
  729. try (Workbook workbook = _testDataProvider.createWorkbook()) {
  730. Sheet sheet = workbook.createSheet("Sheet 1");
  731. sheet.createRow(9);
  732. sheet.createRow(0);
  733. sheet.createRow(1);
  734. assertEquals(0, sheet.getFirstRowNum());
  735. assertEquals(9, sheet.getLastRowNum());
  736. }
  737. }
  738. @Test
  739. public void getFooter() throws IOException {
  740. try (Workbook workbook = _testDataProvider.createWorkbook()) {
  741. Sheet sheet = workbook.createSheet("Sheet 1");
  742. assertNotNull(sheet.getFooter());
  743. sheet.getFooter().setCenter("test center footer");
  744. assertEquals("test center footer", sheet.getFooter().getCenter());
  745. }
  746. }
  747. @Test
  748. public void getSetColumnHidden() throws IOException {
  749. try (Workbook workbook = _testDataProvider.createWorkbook()) {
  750. Sheet sheet = workbook.createSheet("Sheet 1");
  751. sheet.setColumnHidden(2, true);
  752. assertTrue(sheet.isColumnHidden(2));
  753. }
  754. }
  755. @Test
  756. public void protectSheet() throws IOException {
  757. try (Workbook wb = _testDataProvider.createWorkbook()) {
  758. Sheet sheet = wb.createSheet();
  759. assertFalse(sheet.getProtect());
  760. sheet.protectSheet("Test");
  761. assertTrue(sheet.getProtect());
  762. sheet.protectSheet(null);
  763. assertFalse(sheet.getProtect());
  764. }
  765. }
  766. @Test
  767. public void createFreezePane() throws IOException {
  768. try (Workbook wb = _testDataProvider.createWorkbook()) {
  769. // create a workbook
  770. Sheet sheet = wb.createSheet();
  771. assertNull(sheet.getPaneInformation());
  772. sheet.createFreezePane(0, 0);
  773. // still null
  774. assertNull(sheet.getPaneInformation());
  775. sheet.createFreezePane(2, 3);
  776. PaneInformation info = sheet.getPaneInformation();
  777. assertEquals(PaneInformation.PANE_LOWER_RIGHT, info.getActivePane());
  778. assertEquals(3, info.getHorizontalSplitPosition());
  779. assertEquals(3, info.getHorizontalSplitTopRow());
  780. assertEquals(2, info.getVerticalSplitLeftColumn());
  781. assertEquals(2, info.getVerticalSplitPosition());
  782. sheet.createFreezePane(0, 0);
  783. // If both colSplit and rowSplit are zero then the existing freeze pane is removed
  784. assertNull(sheet.getPaneInformation());
  785. sheet.createFreezePane(0, 3);
  786. info = sheet.getPaneInformation();
  787. assertEquals(PaneInformation.PANE_LOWER_LEFT, info.getActivePane());
  788. assertEquals(3, info.getHorizontalSplitPosition());
  789. assertEquals(3, info.getHorizontalSplitTopRow());
  790. assertEquals(0, info.getVerticalSplitLeftColumn());
  791. assertEquals(0, info.getVerticalSplitPosition());
  792. sheet.createFreezePane(3, 0);
  793. info = sheet.getPaneInformation();
  794. assertEquals(PaneInformation.PANE_UPPER_RIGHT, info.getActivePane());
  795. assertEquals(0, info.getHorizontalSplitPosition());
  796. assertEquals(0, info.getHorizontalSplitTopRow());
  797. assertEquals(3, info.getVerticalSplitLeftColumn());
  798. assertEquals(3, info.getVerticalSplitPosition());
  799. sheet.createFreezePane(0, 0);
  800. // If both colSplit and rowSplit are zero then the existing freeze pane is removed
  801. assertNull(sheet.getPaneInformation());
  802. }
  803. }
  804. @Test
  805. public void getRepeatingRowsAndColumns() throws IOException {
  806. try (Workbook wb = _testDataProvider.openSampleWorkbook(
  807. "RepeatingRowsCols."
  808. + _testDataProvider.getStandardFileNameExtension())) {
  809. checkRepeatingRowsAndColumns(wb.getSheetAt(0), null, null);
  810. checkRepeatingRowsAndColumns(wb.getSheetAt(1), "1:1", null);
  811. checkRepeatingRowsAndColumns(wb.getSheetAt(2), null, "A:A");
  812. checkRepeatingRowsAndColumns(wb.getSheetAt(3), "2:3", "A:B");
  813. }
  814. }
  815. @Test
  816. public void setRepeatingRowsAndColumnsBug47294() throws IOException {
  817. try (Workbook wb = _testDataProvider.createWorkbook()) {
  818. Sheet sheet1 = wb.createSheet();
  819. sheet1.setRepeatingRows(CellRangeAddress.valueOf("1:4"));
  820. assertEquals("1:4", sheet1.getRepeatingRows().formatAsString());
  821. //must handle sheets with quotas, see Bugzilla #47294
  822. Sheet sheet2 = wb.createSheet("My' Sheet");
  823. sheet2.setRepeatingRows(CellRangeAddress.valueOf("1:4"));
  824. assertEquals("1:4", sheet2.getRepeatingRows().formatAsString());
  825. }
  826. }
  827. @Test
  828. public void setRepeatingRowsAndColumns() throws IOException {
  829. try (Workbook wb1 = _testDataProvider.createWorkbook()) {
  830. Sheet sheet1 = wb1.createSheet("Sheet1");
  831. Sheet sheet2 = wb1.createSheet("Sheet2");
  832. Sheet sheet3 = wb1.createSheet("Sheet3");
  833. checkRepeatingRowsAndColumns(sheet1, null, null);
  834. sheet1.setRepeatingRows(CellRangeAddress.valueOf("4:5"));
  835. sheet2.setRepeatingColumns(CellRangeAddress.valueOf("A:C"));
  836. sheet3.setRepeatingRows(CellRangeAddress.valueOf("1:4"));
  837. sheet3.setRepeatingColumns(CellRangeAddress.valueOf("A:A"));
  838. checkRepeatingRowsAndColumns(sheet1, "4:5", null);
  839. checkRepeatingRowsAndColumns(sheet2, null, "A:C");
  840. checkRepeatingRowsAndColumns(sheet3, "1:4", "A:A");
  841. // write out, read back, and test refrain...
  842. try (Workbook wb2 = _testDataProvider.writeOutAndReadBack(wb1)) {
  843. sheet1 = wb2.getSheetAt(0);
  844. sheet2 = wb2.getSheetAt(1);
  845. sheet3 = wb2.getSheetAt(2);
  846. checkRepeatingRowsAndColumns(sheet1, "4:5", null);
  847. checkRepeatingRowsAndColumns(sheet2, null, "A:C");
  848. checkRepeatingRowsAndColumns(sheet3, "1:4", "A:A");
  849. // check removing repeating rows and columns
  850. sheet3.setRepeatingRows(null);
  851. checkRepeatingRowsAndColumns(sheet3, null, "A:A");
  852. sheet3.setRepeatingColumns(null);
  853. checkRepeatingRowsAndColumns(sheet3, null, null);
  854. }
  855. }
  856. }
  857. private void checkRepeatingRowsAndColumns(
  858. Sheet s, String expectedRows, String expectedCols) {
  859. if (expectedRows == null) {
  860. assertNull(s.getRepeatingRows());
  861. } else {
  862. assertEquals(expectedRows, s.getRepeatingRows().formatAsString());
  863. }
  864. if (expectedCols == null) {
  865. assertNull(s.getRepeatingColumns());
  866. } else {
  867. assertEquals(expectedCols, s.getRepeatingColumns().formatAsString());
  868. }
  869. }
  870. @Test
  871. public void baseZoom() throws IOException {
  872. try (Workbook wb = _testDataProvider.createWorkbook()) {
  873. Sheet sheet = wb.createSheet();
  874. // here we can only verify that setting some zoom values works,
  875. // range-checking is different between the implementations
  876. sheet.setZoom(75);
  877. }
  878. }
  879. @Test
  880. public void baseShowInPane() throws IOException {
  881. try (Workbook wb = _testDataProvider.createWorkbook()) {
  882. Sheet sheet = wb.createSheet();
  883. sheet.showInPane(2, 3);
  884. }
  885. }
  886. @Test
  887. public void bug55723() throws IOException {
  888. try (Workbook wb = _testDataProvider.createWorkbook()) {
  889. Sheet sheet = wb.createSheet();
  890. CellRangeAddress range = CellRangeAddress.valueOf("A:B");
  891. AutoFilter filter = sheet.setAutoFilter(range);
  892. assertNotNull(filter);
  893. // there seems to be currently no generic way to check the setting...
  894. range = CellRangeAddress.valueOf("B:C");
  895. filter = sheet.setAutoFilter(range);
  896. assertNotNull(filter);
  897. // there seems to be currently no generic way to check the setting...
  898. }
  899. }
  900. @Test
  901. public void bug55723_Rows() throws IOException {
  902. try (Workbook wb = _testDataProvider.createWorkbook()) {
  903. Sheet sheet = wb.createSheet();
  904. CellRangeAddress range = CellRangeAddress.valueOf("A4:B55000");
  905. AutoFilter filter = sheet.setAutoFilter(range);
  906. assertNotNull(filter);
  907. }
  908. }
  909. @Test
  910. public void bug55723d_RowsOver65k() throws IOException {
  911. try (Workbook wb = _testDataProvider.createWorkbook()) {
  912. Sheet sheet = wb.createSheet();
  913. CellRangeAddress range = CellRangeAddress.valueOf("A4:B75000");
  914. AutoFilter filter = sheet.setAutoFilter(range);
  915. assertNotNull(filter);
  916. }
  917. }
  918. /**
  919. * XSSFSheet autoSizeColumn() on empty RichTextString fails
  920. */
  921. @Test
  922. public void bug48325() throws IOException {
  923. try (Workbook wb = _testDataProvider.createWorkbook()) {
  924. Sheet sheet = wb.createSheet("Test");
  925. trackColumnsForAutoSizingIfSXSSF(sheet);
  926. CreationHelper factory = wb.getCreationHelper();
  927. Row row = sheet.createRow(0);
  928. Cell cell = row.createCell(0);
  929. Font font = wb.createFont();
  930. RichTextString rts = factory.createRichTextString("");
  931. rts.applyFont(font);
  932. cell.setCellValue(rts);
  933. sheet.autoSizeColumn(0);
  934. assertNotNull(_testDataProvider.writeOutAndReadBack(wb));
  935. }
  936. }
  937. @Test
  938. public void getCellComment() throws IOException {
  939. try (Workbook workbook = _testDataProvider.createWorkbook()) {
  940. Sheet sheet = workbook.createSheet();
  941. Drawing<?> dg = sheet.createDrawingPatriarch();
  942. Comment comment = dg.createCellComment(workbook.getCreationHelper().createClientAnchor());
  943. Cell cell = sheet.createRow(9).createCell(2);
  944. comment.setAuthor("test C10 author");
  945. cell.setCellComment(comment);
  946. CellAddress ref = new CellAddress(9, 2);
  947. assertNotNull(sheet.getCellComment(ref));
  948. assertEquals("test C10 author", sheet.getCellComment(ref).getAuthor());
  949. assertNotNull(_testDataProvider.writeOutAndReadBack(workbook));
  950. }
  951. }
  952. @Test
  953. public void getCellComments() throws IOException {
  954. try (Workbook wb1 = _testDataProvider.createWorkbook()) {
  955. Sheet sheet = wb1.createSheet("TEST");
  956. // a sheet with no cell comments should return an empty map (not null or raise NPE).
  957. assertTrue(sheet.getCellComments().isEmpty());
  958. Drawing<?> dg = sheet.createDrawingPatriarch();
  959. ClientAnchor anchor = wb1.getCreationHelper().createClientAnchor();
  960. int nRows = 5;
  961. int nCols = 6;
  962. for (int r = 0; r < nRows; r++) {
  963. sheet.createRow(r);
  964. // Create columns in reverse order
  965. for (int c = nCols - 1; c >= 0; c--) {
  966. // When the comment box is visible, have it show in a 1x3 space
  967. anchor.setCol1(c);
  968. anchor.setCol2(c);
  969. anchor.setRow1(r);
  970. anchor.setRow2(r);
  971. // Create the comment and set the text-author
  972. Comment comment = dg.createCellComment(anchor);
  973. Cell cell = sheet.getRow(r).createCell(c);
  974. comment.setAuthor("Author " + r);
  975. RichTextString text = wb1.getCreationHelper().createRichTextString("Test comment at row=" + r + ", column=" + c);
  976. comment.setString(text);
  977. // Assign the comment to the cell
  978. cell.setCellComment(comment);
  979. }
  980. }
  981. try (Workbook wb2 = _testDataProvider.writeOutAndReadBack(wb1)) {
  982. Sheet sh = wb2.getSheet("TEST");
  983. Map<CellAddress, ? extends Comment> cellComments = sh.getCellComments();
  984. assertEquals(nRows * nCols, cellComments.size());
  985. for (Entry<CellAddress, ? extends Comment> e : cellComments.entrySet()) {
  986. CellAddress ref = e.getKey();
  987. Comment aComment = e.getValue();
  988. assertEquals("Author " + ref.getRow(), aComment.getAuthor());
  989. String text = "Test comment at row=" + ref.getRow() + ", column=" + ref.getColumn();
  990. assertEquals(text, aComment.getString().getString());
  991. }
  992. }
  993. }
  994. }
  995. @Test
  996. public void getHyperlink() throws IOException {
  997. try (Workbook workbook = _testDataProvider.createWorkbook()) {
  998. Hyperlink hyperlink = workbook.getCreationHelper().createHyperlink(HyperlinkType.URL);
  999. hyperlink.setAddress("https://poi.apache.org/");
  1000. Sheet sheet = workbook.createSheet();
  1001. Cell cell = sheet.createRow(5).createCell(1);
  1002. assertEquals(0, sheet.getHyperlinkList().size(), "list size before add");
  1003. cell.setHyperlink(hyperlink);
  1004. assertEquals(1, sheet.getHyperlinkList().size(), "list size after add");
  1005. assertEquals(hyperlink, sheet.getHyperlinkList().get(0), "list");
  1006. CellAddress B6 = new CellAddress(5, 1);
  1007. assertEquals(hyperlink, sheet.getHyperlink(5, 1), "row, col");
  1008. assertEquals(hyperlink, sheet.getHyperlink(B6), "addr");
  1009. assertNull(sheet.getHyperlink(CellAddress.A1), "no hyperlink at A1");
  1010. }
  1011. }
  1012. @Test
  1013. public void removeAllHyperlinks() throws IOException {
  1014. try (Workbook workbook = _testDataProvider.createWorkbook()) {
  1015. Hyperlink hyperlink = workbook.getCreationHelper().createHyperlink(HyperlinkType.URL);
  1016. hyperlink.setAddress("https://poi.apache.org/");
  1017. Sheet sheet = workbook.createSheet();
  1018. Cell cell = sheet.createRow(5).createCell(1);
  1019. cell.setHyperlink(hyperlink);
  1020. assertEquals(1, workbook.getSheetAt(0).getHyperlinkList().size());
  1021. // Save a workbook with a hyperlink
  1022. try (Workbook workbook2 = _testDataProvider.writeOutAndReadBack(workbook)) {
  1023. assertEquals(1, workbook2.getSheetAt(0).getHyperlinkList().size());
  1024. // Remove all hyperlinks from a saved workbook
  1025. workbook2.getSheetAt(0).getRow(5).getCell(1).removeHyperlink();
  1026. assertEquals(0, workbook2.getSheetAt(0).getHyperlinkList().size());
  1027. // Verify that hyperlink was removed from workbook after writing out
  1028. try (Workbook workbook3 = _testDataProvider.writeOutAndReadBack(workbook2)) {
  1029. assertEquals(0, workbook3.getSheetAt(0).getHyperlinkList().size());
  1030. }
  1031. }
  1032. }
  1033. }
  1034. @Test
  1035. public void newMergedRegionAt() throws IOException {
  1036. try (Workbook workbook = _testDataProvider.createWorkbook()) {
  1037. Sheet sheet = workbook.createSheet();
  1038. CellRangeAddress region = CellRangeAddress.valueOf("B2:D4");
  1039. assertEquals(0, sheet.addMergedRegion(region));
  1040. assertEquals("B2:D4", sheet.getMergedRegion(0).formatAsString());
  1041. assertEquals(1, sheet.getNumMergedRegions());
  1042. assertNotNull(_testDataProvider.writeOutAndReadBack(workbook));
  1043. }
  1044. }
  1045. @Test
  1046. public void showInPaneManyRowsBug55248() throws IOException {
  1047. try (Workbook wb1 = _testDataProvider.createWorkbook()) {
  1048. Sheet sheet = wb1.createSheet("Sheet 1");
  1049. sheet.showInPane(0, 0);
  1050. for (int i = ROW_COUNT / 2; i < ROW_COUNT; i++) {
  1051. sheet.createRow(i);
  1052. sheet.showInPane(i, 0);
  1053. // this one fails: sheet.showInPane((short)i, 0);
  1054. }
  1055. int i = 0;
  1056. sheet.showInPane(i, i);
  1057. try (Workbook wb2 = _testDataProvider.writeOutAndReadBack(wb1)) {
  1058. checkRowCount(wb2);
  1059. }
  1060. }
  1061. }
  1062. private void checkRowCount(Workbook wb) {
  1063. assertNotNull(wb);
  1064. final Sheet sh = wb.getSheet("Sheet 1");
  1065. assertNotNull(sh);
  1066. assertEquals(ROW_COUNT-1, sh.getLastRowNum());
  1067. }
  1068. @Test
  1069. public void testRightToLeft() throws IOException {
  1070. try (Workbook wb = _testDataProvider.createWorkbook()) {
  1071. Sheet sheet = wb.createSheet();
  1072. assertFalse(sheet.isRightToLeft());
  1073. sheet.setRightToLeft(true);
  1074. assertTrue(sheet.isRightToLeft());
  1075. sheet.setRightToLeft(false);
  1076. assertFalse(sheet.isRightToLeft());
  1077. }
  1078. }
  1079. @Test
  1080. public void testNoMergedRegionsIsEmptyList() throws IOException {
  1081. try (Workbook wb = _testDataProvider.createWorkbook()) {
  1082. Sheet sheet = wb.createSheet();
  1083. assertTrue(sheet.getMergedRegions().isEmpty());
  1084. }
  1085. }
  1086. /**
  1087. * Tests that the setAsActiveCell and getActiveCell function pairs work together
  1088. */
  1089. @Test
  1090. public void setActiveCell() throws IOException {
  1091. try (Workbook wb1 = _testDataProvider.createWorkbook()) {
  1092. Sheet sheet = wb1.createSheet();
  1093. CellAddress B42 = new CellAddress("B42");
  1094. // active cell behavior is undefined if not set.
  1095. // HSSFSheet defaults to A1 active cell, while XSSFSheet defaults to null.
  1096. CellAddress ac = sheet.getActiveCell();
  1097. assertTrue(ac == null || CellAddress.A1.equals(ac), "If not set, active cell should default to null or A1");
  1098. sheet.setActiveCell(B42);
  1099. try (Workbook wb2 = _testDataProvider.writeOutAndReadBack(wb1)) {
  1100. sheet = wb2.getSheetAt(0);
  1101. assertEquals(B42, sheet.getActiveCell());
  1102. }
  1103. }
  1104. }
  1105. @Test
  1106. public void autoSizeDate() throws IOException {
  1107. try (Workbook wb = _testDataProvider.createWorkbook()) {
  1108. Sheet s = wb.createSheet("Sheet1");
  1109. Row r = s.createRow(0);
  1110. r.createCell(0).setCellValue(1);
  1111. r.createCell(1).setCellValue(123456);
  1112. // for the streaming-variant we need to enable autosize-tracking to make it work
  1113. trackColumnsForAutoSizingIfSXSSF(s);
  1114. // Will be sized fairly small
  1115. s.autoSizeColumn((short) 0);
  1116. s.autoSizeColumn((short) 1);
  1117. // Size ranges due to different fonts on different machines
  1118. assertBetween("Single number column width", s.getColumnWidth(0), 350, 570);
  1119. assertBetween("6 digit number column width", s.getColumnWidth(1), 1500, 2100);
  1120. // Set a date format
  1121. CellStyle cs = wb.createCellStyle();
  1122. DataFormat f = wb.createDataFormat();
  1123. cs.setDataFormat(f.getFormat("yyyy-mm-dd MMMM hh:mm:ss"));
  1124. r.getCell(0).setCellStyle(cs);
  1125. r.getCell(1).setCellStyle(cs);
  1126. assertTrue(DateUtil.isCellDateFormatted(r.getCell(0)));
  1127. assertTrue(DateUtil.isCellDateFormatted(r.getCell(1)));
  1128. // Should get much bigger now
  1129. s.autoSizeColumn((short) 0);
  1130. s.autoSizeColumn((short) 1);
  1131. assertBetween("Date column width", s.getColumnWidth(0), 4750, 7300);
  1132. assertBetween("Date column width", s.getColumnWidth(1), 4750, 7300);
  1133. }
  1134. }
  1135. }