You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

TestXSSFSheet.java 86KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018
  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.xssf.usermodel;
  16. import static java.util.concurrent.TimeUnit.SECONDS;
  17. import static org.apache.poi.xssf.XSSFTestDataSamples.openSampleWorkbook;
  18. import static org.apache.poi.xssf.XSSFTestDataSamples.writeOutAndReadBack;
  19. import static org.junit.jupiter.api.Assertions.assertEquals;
  20. import static org.junit.jupiter.api.Assertions.assertFalse;
  21. import static org.junit.jupiter.api.Assertions.assertNotNull;
  22. import static org.junit.jupiter.api.Assertions.assertNotSame;
  23. import static org.junit.jupiter.api.Assertions.assertNull;
  24. import static org.junit.jupiter.api.Assertions.assertSame;
  25. import static org.junit.jupiter.api.Assertions.assertThrows;
  26. import static org.junit.jupiter.api.Assertions.assertTrue;
  27. import java.io.IOException;
  28. import java.util.Arrays;
  29. import java.util.Calendar;
  30. import java.util.Date;
  31. import java.util.HashSet;
  32. import java.util.List;
  33. import java.util.Map;
  34. import java.util.Set;
  35. import org.apache.poi.hssf.HSSFTestDataSamples;
  36. import org.apache.poi.ooxml.POIXMLException;
  37. import org.apache.poi.poifs.crypt.CryptoFunctions;
  38. import org.apache.poi.poifs.crypt.HashAlgorithm;
  39. import org.apache.poi.ss.tests.usermodel.BaseTestXSheet;
  40. import org.apache.poi.ss.usermodel.AutoFilter;
  41. import org.apache.poi.ss.usermodel.Cell;
  42. import org.apache.poi.ss.usermodel.CellCopyPolicy;
  43. import org.apache.poi.ss.usermodel.CellType;
  44. import org.apache.poi.ss.usermodel.ClientAnchor;
  45. import org.apache.poi.ss.usermodel.Comment;
  46. import org.apache.poi.ss.usermodel.CreationHelper;
  47. import org.apache.poi.ss.usermodel.Drawing;
  48. import org.apache.poi.ss.usermodel.FormulaError;
  49. import org.apache.poi.ss.usermodel.IgnoredErrorType;
  50. import org.apache.poi.ss.usermodel.IndexedColors;
  51. import org.apache.poi.ss.usermodel.Row;
  52. import org.apache.poi.ss.usermodel.Sheet;
  53. import org.apache.poi.ss.usermodel.Workbook;
  54. import org.apache.poi.ss.util.AreaReference;
  55. import org.apache.poi.ss.util.CellAddress;
  56. import org.apache.poi.ss.util.CellRangeAddress;
  57. import org.apache.poi.ss.util.CellReference;
  58. import org.apache.poi.ss.util.CellUtil;
  59. import org.apache.poi.util.LocaleUtil;
  60. import org.apache.poi.xssf.XSSFITestDataProvider;
  61. import org.apache.poi.xssf.XSSFTestDataSamples;
  62. import org.apache.poi.xssf.model.CalculationChain;
  63. import org.apache.poi.xssf.model.CommentsTable;
  64. import org.apache.poi.xssf.model.StylesTable;
  65. import org.apache.poi.xssf.streaming.SXSSFWorkbook;
  66. import org.apache.poi.xssf.usermodel.helpers.ColumnHelper;
  67. import org.junit.jupiter.api.Test;
  68. import org.junit.jupiter.api.Timeout;
  69. import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCalcPr;
  70. import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCell;
  71. import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCol;
  72. import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor;
  73. import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCols;
  74. import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComments;
  75. import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTIgnoredError;
  76. import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTRow;
  77. import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTSheetData;
  78. import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTSheetProtection;
  79. import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTWorksheet;
  80. import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTXf;
  81. import org.openxmlformats.schemas.spreadsheetml.x2006.main.STCalcMode;
  82. import org.openxmlformats.schemas.spreadsheetml.x2006.main.STPane;
  83. import org.openxmlformats.schemas.spreadsheetml.x2006.main.STUnsignedShortHex;
  84. public final class TestXSSFSheet extends BaseTestXSheet {
  85. public TestXSSFSheet() {
  86. super(XSSFITestDataProvider.instance);
  87. }
  88. //TODO column styles are not yet supported by XSSF
  89. @Override
  90. protected void defaultColumnStyle() {
  91. //super.defaultColumnStyle();
  92. }
  93. @Test
  94. void existingHeaderFooter() throws IOException {
  95. try (XSSFWorkbook wb1 = XSSFTestDataSamples.openSampleWorkbook("45540_classic_Header.xlsx")) {
  96. XSSFOddHeader hdr;
  97. XSSFOddFooter ftr;
  98. // Sheet 1 has a header with center and right text
  99. XSSFSheet s1 = wb1.getSheetAt(0);
  100. assertNotNull(s1.getHeader());
  101. assertNotNull(s1.getFooter());
  102. hdr = (XSSFOddHeader) s1.getHeader();
  103. ftr = (XSSFOddFooter) s1.getFooter();
  104. assertEquals("&Ctestdoc&Rtest phrase", hdr.getText());
  105. assertNull(ftr.getText());
  106. assertEquals("", hdr.getLeft());
  107. assertEquals("testdoc", hdr.getCenter());
  108. assertEquals("test phrase", hdr.getRight());
  109. assertEquals("", ftr.getLeft());
  110. assertEquals("", ftr.getCenter());
  111. assertEquals("", ftr.getRight());
  112. // Sheet 2 has a footer, but it's empty
  113. XSSFSheet s2 = wb1.getSheetAt(1);
  114. assertNotNull(s2.getHeader());
  115. assertNotNull(s2.getFooter());
  116. hdr = (XSSFOddHeader) s2.getHeader();
  117. ftr = (XSSFOddFooter) s2.getFooter();
  118. assertNull(hdr.getText());
  119. assertEquals("&L&F", ftr.getText());
  120. assertEquals("", hdr.getLeft());
  121. assertEquals("", hdr.getCenter());
  122. assertEquals("", hdr.getRight());
  123. assertEquals("&F", ftr.getLeft());
  124. assertEquals("", ftr.getCenter());
  125. assertEquals("", ftr.getRight());
  126. // Save and reload
  127. try (XSSFWorkbook wb2 = XSSFTestDataSamples.writeOutAndReadBack(wb1)) {
  128. hdr = (XSSFOddHeader) wb2.getSheetAt(0).getHeader();
  129. ftr = (XSSFOddFooter) wb2.getSheetAt(0).getFooter();
  130. assertEquals("", hdr.getLeft());
  131. assertEquals("testdoc", hdr.getCenter());
  132. assertEquals("test phrase", hdr.getRight());
  133. assertEquals("", ftr.getLeft());
  134. assertEquals("", ftr.getCenter());
  135. assertEquals("", ftr.getRight());
  136. }
  137. }
  138. }
  139. @Test
  140. void getAllHeadersFooters() throws IOException {
  141. try (XSSFWorkbook workbook = new XSSFWorkbook()) {
  142. XSSFSheet sheet = workbook.createSheet("Sheet 1");
  143. assertNotNull(sheet.getOddFooter());
  144. assertNotNull(sheet.getEvenFooter());
  145. assertNotNull(sheet.getFirstFooter());
  146. assertNotNull(sheet.getOddHeader());
  147. assertNotNull(sheet.getEvenHeader());
  148. assertNotNull(sheet.getFirstHeader());
  149. assertEquals("", sheet.getOddFooter().getLeft());
  150. sheet.getOddFooter().setLeft("odd footer left");
  151. assertEquals("odd footer left", sheet.getOddFooter().getLeft());
  152. assertEquals("", sheet.getEvenFooter().getLeft());
  153. sheet.getEvenFooter().setLeft("even footer left");
  154. assertEquals("even footer left", sheet.getEvenFooter().getLeft());
  155. assertEquals("", sheet.getFirstFooter().getLeft());
  156. sheet.getFirstFooter().setLeft("first footer left");
  157. assertEquals("first footer left", sheet.getFirstFooter().getLeft());
  158. assertEquals("", sheet.getOddHeader().getLeft());
  159. sheet.getOddHeader().setLeft("odd header left");
  160. assertEquals("odd header left", sheet.getOddHeader().getLeft());
  161. assertEquals("", sheet.getOddHeader().getRight());
  162. sheet.getOddHeader().setRight("odd header right");
  163. assertEquals("odd header right", sheet.getOddHeader().getRight());
  164. assertEquals("", sheet.getOddHeader().getCenter());
  165. sheet.getOddHeader().setCenter("odd header center");
  166. assertEquals("odd header center", sheet.getOddHeader().getCenter());
  167. // Defaults are odd
  168. assertEquals("odd footer left", sheet.getFooter().getLeft());
  169. assertEquals("odd header center", sheet.getHeader().getCenter());
  170. }
  171. }
  172. @Test
  173. void autoSizeColumn() throws IOException {
  174. try (XSSFWorkbook workbook = new XSSFWorkbook()) {
  175. XSSFSheet sheet = workbook.createSheet("Sheet 1");
  176. sheet.createRow(0).createCell(13).setCellValue("test");
  177. sheet.autoSizeColumn(13);
  178. ColumnHelper columnHelper = sheet.getColumnHelper();
  179. CTCol col = columnHelper.getColumn(13, false);
  180. assertTrue(col.getBestFit());
  181. }
  182. }
  183. @Test
  184. void setCellComment() throws IOException {
  185. XSSFWorkbook workbook = new XSSFWorkbook();
  186. XSSFSheet sheet = workbook.createSheet();
  187. XSSFDrawing dg = sheet.createDrawingPatriarch();
  188. XSSFComment comment = dg.createCellComment(new XSSFClientAnchor());
  189. Cell cell = sheet.createRow(0).createCell(0);
  190. CommentsTable comments = sheet.getCommentsTable(false);
  191. CTComments ctComments = comments.getCTComments();
  192. cell.setCellComment(comment);
  193. assertEquals("A1", ctComments.getCommentList().getCommentArray(0).getRef());
  194. comment.setAuthor("test A1 author");
  195. assertEquals("test A1 author", comments.getAuthor((int) ctComments.getCommentList().getCommentArray(0).getAuthorId()));
  196. workbook.close();
  197. }
  198. @Test
  199. void getActiveCell() throws IOException {
  200. XSSFWorkbook workbook = new XSSFWorkbook();
  201. XSSFSheet sheet = workbook.createSheet();
  202. CellAddress R5 = new CellAddress("R5");
  203. sheet.setActiveCell(R5);
  204. assertEquals(R5, sheet.getActiveCell());
  205. workbook.close();
  206. }
  207. @Test
  208. void createFreezePane_XSSF() throws IOException {
  209. XSSFWorkbook workbook = new XSSFWorkbook();
  210. XSSFSheet sheet = workbook.createSheet();
  211. CTWorksheet ctWorksheet = sheet.getCTWorksheet();
  212. sheet.createFreezePane(2, 4);
  213. assertEquals(2.0, ctWorksheet.getSheetViews().getSheetViewArray(0).getPane().getXSplit(), 0.0);
  214. assertSame(STPane.BOTTOM_RIGHT, ctWorksheet.getSheetViews().getSheetViewArray(0).getPane().getActivePane());
  215. sheet.createFreezePane(3, 6, 10, 10);
  216. assertEquals(3.0, ctWorksheet.getSheetViews().getSheetViewArray(0).getPane().getXSplit(), 0.0);
  217. // assertEquals(10, sheet.getTopRow());
  218. // assertEquals(10, sheet.getLeftCol());
  219. sheet.createSplitPane(4, 8, 12, 12, 1);
  220. assertEquals(8.0, ctWorksheet.getSheetViews().getSheetViewArray(0).getPane().getYSplit(), 0.0);
  221. assertSame(STPane.BOTTOM_RIGHT, ctWorksheet.getSheetViews().getSheetViewArray(0).getPane().getActivePane());
  222. workbook.close();
  223. }
  224. @Test
  225. void removeMergedRegion_lowlevel() throws IOException {
  226. XSSFWorkbook workbook = new XSSFWorkbook();
  227. XSSFSheet sheet = workbook.createSheet();
  228. CTWorksheet ctWorksheet = sheet.getCTWorksheet();
  229. CellRangeAddress region_1 = CellRangeAddress.valueOf("A1:B2");
  230. CellRangeAddress region_2 = CellRangeAddress.valueOf("C3:D4");
  231. CellRangeAddress region_3 = CellRangeAddress.valueOf("E5:F6");
  232. CellRangeAddress region_4 = CellRangeAddress.valueOf("G7:H8");
  233. assertEquals(0, sheet.addMergedRegion(region_1));
  234. assertEquals(1, sheet.addMergedRegion(region_2));
  235. assertEquals(2, sheet.addMergedRegion(region_3));
  236. assertEquals("C3:D4", ctWorksheet.getMergeCells().getMergeCellArray(1).getRef());
  237. assertEquals(3, sheet.getNumMergedRegions());
  238. sheet.removeMergedRegion(1);
  239. assertEquals("E5:F6", ctWorksheet.getMergeCells().getMergeCellArray(1).getRef());
  240. assertEquals(2, sheet.getNumMergedRegions());
  241. sheet.removeMergedRegion(1);
  242. sheet.removeMergedRegion(0);
  243. assertEquals(0, sheet.getNumMergedRegions());
  244. assertNull(sheet.getCTWorksheet().getMergeCells(),
  245. "CTMergeCells should be deleted after removing the last merged region on the sheet.");
  246. assertEquals(0, sheet.addMergedRegion(region_1));
  247. assertEquals(1, sheet.addMergedRegion(region_2));
  248. assertEquals(2, sheet.addMergedRegion(region_3));
  249. assertEquals(3, sheet.addMergedRegion(region_4));
  250. // test invalid indexes OOBE
  251. Set<Integer> rmIdx = new HashSet<>(Arrays.asList(5, 6));
  252. sheet.removeMergedRegions(rmIdx);
  253. rmIdx = new HashSet<>(Arrays.asList(1, 3));
  254. sheet.removeMergedRegions(rmIdx);
  255. assertEquals("A1:B2", ctWorksheet.getMergeCells().getMergeCellArray(0).getRef());
  256. assertEquals("E5:F6", ctWorksheet.getMergeCells().getMergeCellArray(1).getRef());
  257. workbook.close();
  258. }
  259. @Test
  260. void setDefaultColumnStyle() throws IOException {
  261. XSSFWorkbook workbook = new XSSFWorkbook();
  262. XSSFSheet sheet = workbook.createSheet();
  263. CTWorksheet ctWorksheet = sheet.getCTWorksheet();
  264. StylesTable stylesTable = workbook.getStylesSource();
  265. XSSFFont font = new XSSFFont();
  266. font.setFontName("Cambria");
  267. stylesTable.putFont(font);
  268. CTXf cellStyleXf = CTXf.Factory.newInstance();
  269. cellStyleXf.setFontId(1);
  270. cellStyleXf.setFillId(0);
  271. cellStyleXf.setBorderId(0);
  272. cellStyleXf.setNumFmtId(0);
  273. assertEquals(2, stylesTable.putCellStyleXf(cellStyleXf));
  274. CTXf cellXf = CTXf.Factory.newInstance();
  275. cellXf.setXfId(1);
  276. stylesTable.putCellXf(cellXf);
  277. XSSFCellStyle cellStyle = new XSSFCellStyle(1, 1, stylesTable, null);
  278. assertEquals(1, cellStyle.getFontIndex());
  279. sheet.setDefaultColumnStyle(3, cellStyle);
  280. assertEquals(1, ctWorksheet.getColsArray(0).getColArray(0).getStyle());
  281. workbook.close();
  282. }
  283. @Test
  284. void groupUngroupColumn() throws IOException {
  285. XSSFWorkbook workbook = new XSSFWorkbook();
  286. XSSFSheet sheet = workbook.createSheet();
  287. //one level
  288. sheet.groupColumn(2, 7);
  289. sheet.groupColumn(10, 11);
  290. CTCols cols = sheet.getCTWorksheet().getColsArray(0);
  291. assertEquals(2, cols.sizeOfColArray());
  292. CTCol[] colArray = cols.getColArray();
  293. assertNotNull(colArray);
  294. assertEquals(2 + 1, colArray[0].getMin()); // 1 based
  295. assertEquals(7 + 1, colArray[0].getMax()); // 1 based
  296. assertEquals(1, colArray[0].getOutlineLevel());
  297. assertEquals(0, sheet.getColumnOutlineLevel(0));
  298. //two level
  299. sheet.groupColumn(1, 2);
  300. cols = sheet.getCTWorksheet().getColsArray(0);
  301. assertEquals(4, cols.sizeOfColArray());
  302. colArray = cols.getColArray();
  303. assertEquals(2, colArray[1].getOutlineLevel());
  304. //three level
  305. sheet.groupColumn(6, 8);
  306. sheet.groupColumn(2, 3);
  307. cols = sheet.getCTWorksheet().getColsArray(0);
  308. assertEquals(7, cols.sizeOfColArray());
  309. colArray = cols.getColArray();
  310. assertEquals(3, colArray[1].getOutlineLevel());
  311. assertEquals(3, sheet.getCTWorksheet().getSheetFormatPr().getOutlineLevelCol());
  312. sheet.ungroupColumn(8, 10);
  313. colArray = cols.getColArray();
  314. assertEquals(3, colArray[1].getOutlineLevel());
  315. sheet.ungroupColumn(4, 6);
  316. sheet.ungroupColumn(2, 2);
  317. colArray = cols.getColArray();
  318. assertEquals(4, colArray.length);
  319. assertEquals(2, sheet.getCTWorksheet().getSheetFormatPr().getOutlineLevelCol());
  320. workbook.close();
  321. }
  322. @Test
  323. void groupUngroupRow() throws IOException {
  324. XSSFWorkbook workbook = new XSSFWorkbook();
  325. XSSFSheet sheet = workbook.createSheet();
  326. //one level
  327. sheet.groupRow(9, 10);
  328. assertEquals(2, sheet.getPhysicalNumberOfRows());
  329. CTRow ctrow = sheet.getRow(9).getCTRow();
  330. assertNotNull(ctrow);
  331. assertEquals(10, ctrow.getR());
  332. assertEquals(1, ctrow.getOutlineLevel());
  333. assertEquals(1, sheet.getCTWorksheet().getSheetFormatPr().getOutlineLevelRow());
  334. //two level
  335. sheet.groupRow(10, 13);
  336. assertEquals(5, sheet.getPhysicalNumberOfRows());
  337. ctrow = sheet.getRow(10).getCTRow();
  338. assertNotNull(ctrow);
  339. assertEquals(11, ctrow.getR());
  340. assertEquals(2, ctrow.getOutlineLevel());
  341. assertEquals(2, sheet.getCTWorksheet().getSheetFormatPr().getOutlineLevelRow());
  342. sheet.ungroupRow(8, 10);
  343. assertEquals(4, sheet.getPhysicalNumberOfRows());
  344. assertEquals(1, sheet.getCTWorksheet().getSheetFormatPr().getOutlineLevelRow());
  345. sheet.ungroupRow(10, 10);
  346. assertEquals(3, sheet.getPhysicalNumberOfRows());
  347. assertEquals(1, sheet.getCTWorksheet().getSheetFormatPr().getOutlineLevelRow());
  348. workbook.close();
  349. }
  350. @Test
  351. void setZoom() throws IOException {
  352. try (XSSFWorkbook workBook = new XSSFWorkbook()) {
  353. XSSFSheet sheet1 = workBook.createSheet("new sheet");
  354. sheet1.setZoom(75); // 75 percent magnification
  355. long zoom = sheet1.getCTWorksheet().getSheetViews().getSheetViewArray(0).getZoomScale();
  356. assertEquals(zoom, 75);
  357. sheet1.setZoom(200);
  358. zoom = sheet1.getCTWorksheet().getSheetViews().getSheetViewArray(0).getZoomScale();
  359. assertEquals(zoom, 200);
  360. // Valid scale values range from 10 to 400
  361. assertThrows(IllegalArgumentException.class, () -> sheet1.setZoom(500));
  362. }
  363. }
  364. /**
  365. * TODO - while this is internally consistent, I'm not
  366. * completely clear in all cases what it's supposed to
  367. * be doing... Someone who understands the goals a little
  368. * better should really review this!
  369. */
  370. @Test
  371. void setColumnGroupCollapsed() throws IOException {
  372. try (XSSFWorkbook wb1 = new XSSFWorkbook()) {
  373. XSSFSheet sheet1 = wb1.createSheet();
  374. CTCols cols = sheet1.getCTWorksheet().getColsArray(0);
  375. assertEquals(0, cols.sizeOfColArray());
  376. sheet1.groupColumn(4, 7);
  377. assertEquals(1, cols.sizeOfColArray());
  378. checkColumnGroup(cols.getColArray(0), 4, 7); // false, true
  379. sheet1.groupColumn(9, 12);
  380. assertEquals(2, cols.sizeOfColArray());
  381. checkColumnGroup(cols.getColArray(0), 4, 7); // false, true
  382. checkColumnGroup(cols.getColArray(1), 9, 12); // false, true
  383. sheet1.groupColumn(10, 11);
  384. assertEquals(4, cols.sizeOfColArray());
  385. checkColumnGroup(cols.getColArray(0), 4, 7); // false, true
  386. checkColumnGroup(cols.getColArray(1), 9, 9); // false, true
  387. checkColumnGroup(cols.getColArray(2), 10, 11); // false, true
  388. checkColumnGroup(cols.getColArray(3), 12, 12); // false, true
  389. // collapse columns - 1
  390. sheet1.setColumnGroupCollapsed(5, true);
  391. // FIXME: we grew a column?
  392. assertEquals(5, cols.sizeOfColArray());
  393. checkColumnGroupIsCollapsed(cols.getColArray(0), 4, 7); // true, true
  394. checkColumnGroup(cols.getColArray(1), 8, 8); // false, true
  395. checkColumnGroup(cols.getColArray(2), 9, 9); // false, true
  396. checkColumnGroup(cols.getColArray(3), 10, 11); // false, true
  397. checkColumnGroup(cols.getColArray(4), 12, 12); // false, true
  398. // expand columns - 1
  399. sheet1.setColumnGroupCollapsed(5, false);
  400. assertEquals(5, cols.sizeOfColArray());
  401. checkColumnGroupIsExpanded(cols.getColArray(0), 4, 7); // false, true
  402. checkColumnGroup(cols.getColArray(1), 8, 8, false, false);
  403. checkColumnGroup(cols.getColArray(2), 9, 9); // false, true
  404. checkColumnGroup(cols.getColArray(3), 10, 11); // false, true
  405. checkColumnGroup(cols.getColArray(4), 12, 12); // false, true
  406. //collapse - 2
  407. sheet1.setColumnGroupCollapsed(9, true);
  408. // it grew again?
  409. assertEquals(6, cols.sizeOfColArray());
  410. checkColumnGroup(cols.getColArray(0), 4, 7); // false, true
  411. checkColumnGroup(cols.getColArray(1), 8, 8, false, false);
  412. checkColumnGroupIsCollapsed(cols.getColArray(2), 9, 9); // true, true
  413. checkColumnGroupIsCollapsed(cols.getColArray(3), 10, 11); // true, true
  414. checkColumnGroupIsCollapsed(cols.getColArray(4), 12, 12); // true, true
  415. // why was this column group added?
  416. checkColumnGroup(cols.getColArray(5), 13, 13); // false, true
  417. //expand - 2
  418. sheet1.setColumnGroupCollapsed(9, false);
  419. assertEquals(6, cols.sizeOfColArray());
  420. //outline level 2: the line under ==> collapsed==True
  421. assertEquals(2, cols.getColArray(3).getOutlineLevel());
  422. assertTrue(cols.getColArray(4).isSetCollapsed());
  423. checkColumnGroup(cols.getColArray(0), 4, 7);
  424. checkColumnGroup(cols.getColArray(1), 8, 8, false, false);
  425. checkColumnGroup(cols.getColArray(2), 9, 9); // false, true
  426. checkColumnGroupIsCollapsed(cols.getColArray(3), 10, 11); // true, true
  427. checkColumnGroup(cols.getColArray(4), 12, 12); // false, true
  428. checkColumnGroup(cols.getColArray(5), 13, 13, false, false);
  429. //DOCUMENTARE MEGLIO IL DISCORSO DEL LIVELLO
  430. //collapse - 3
  431. sheet1.setColumnGroupCollapsed(10, true);
  432. assertEquals(6, cols.sizeOfColArray());
  433. checkColumnGroup(cols.getColArray(0), 4, 7);
  434. checkColumnGroup(cols.getColArray(1), 8, 8, false, false);
  435. checkColumnGroup(cols.getColArray(2), 9, 9); // false, true
  436. checkColumnGroupIsCollapsed(cols.getColArray(3), 10, 11); // true, true
  437. checkColumnGroup(cols.getColArray(4), 12, 12); // false, true
  438. checkColumnGroup(cols.getColArray(5), 13, 13, false, false);
  439. //expand - 3
  440. sheet1.setColumnGroupCollapsed(10, false);
  441. assertEquals(6, cols.sizeOfColArray());
  442. assertFalse(cols.getColArray(0).getHidden());
  443. assertFalse(cols.getColArray(5).getHidden());
  444. assertFalse(cols.getColArray(4).isSetCollapsed());
  445. // write out and give back
  446. // Save and re-load
  447. try (XSSFWorkbook wb2 = XSSFTestDataSamples.writeOutAndReadBack(wb1)) {
  448. sheet1 = wb2.getSheetAt(0);
  449. cols = sheet1.getCTWorksheet().getColsArray(0);
  450. assertEquals(6, cols.sizeOfColArray());
  451. checkColumnGroup(cols.getColArray(0), 4, 7, false, true);
  452. checkColumnGroup(cols.getColArray(1), 8, 8, false, true);
  453. checkColumnGroup(cols.getColArray(2), 9, 9, false, true);
  454. checkColumnGroup(cols.getColArray(3), 10, 11, false, true);
  455. checkColumnGroup(cols.getColArray(4), 12, 12, false, true);
  456. checkColumnGroup(cols.getColArray(5), 13, 13, false, true);
  457. }
  458. }
  459. }
  460. /**
  461. * Verify that column groups were created correctly after Sheet.groupColumn
  462. *
  463. * @param col the column group xml bean
  464. * @param fromColumnIndex 0-indexed
  465. * @param toColumnIndex 0-indexed
  466. */
  467. @SuppressWarnings("SameParameterValue")
  468. private static void checkColumnGroup(
  469. CTCol col,
  470. int fromColumnIndex, int toColumnIndex,
  471. boolean isSetHidden, boolean isSetCollapsed
  472. ) {
  473. assertEquals(fromColumnIndex, col.getMin() - 1, "from column index"); // 1 based
  474. assertEquals(toColumnIndex, col.getMax() - 1, "to column index"); // 1 based
  475. assertEquals(isSetHidden, col.isSetHidden(), "isSetHidden");
  476. assertEquals(isSetCollapsed, col.isSetCollapsed(), "isSetCollapsed"); //not necessarily set
  477. }
  478. /**
  479. * Verify that column groups were created correctly after Sheet.groupColumn
  480. *
  481. * @param col the column group xml bean
  482. * @param fromColumnIndex 0-indexed
  483. * @param toColumnIndex 0-indexed
  484. */
  485. private static void checkColumnGroup(CTCol col, int fromColumnIndex, int toColumnIndex) {
  486. assertEquals(fromColumnIndex, col.getMin() - 1, "from column index"); // 1 based
  487. assertEquals(toColumnIndex, col.getMax() - 1, "to column index"); // 1 based
  488. assertFalse(col.isSetHidden(), "isSetHidden");
  489. assertTrue(col.isSetCollapsed(), "isSetCollapsed"); //not necessarily set
  490. }
  491. /**
  492. * Verify that column groups were created correctly after Sheet.groupColumn
  493. *
  494. * @param col the column group xml bean
  495. * @param fromColumnIndex 0-indexed
  496. * @param toColumnIndex 0-indexed
  497. */
  498. private static void checkColumnGroupIsCollapsed(CTCol col, int fromColumnIndex, int toColumnIndex) {
  499. assertEquals(fromColumnIndex, col.getMin() - 1, "from column index"); // 1 based
  500. assertEquals(toColumnIndex, col.getMax() - 1, "to column index"); // 1 based
  501. assertTrue(col.isSetHidden(), "isSetHidden");
  502. assertTrue(col.isSetCollapsed(), "isSetCollapsed");
  503. //assertTrue(col.getCollapsed(), "getCollapsed");
  504. }
  505. /**
  506. * Verify that column groups were created correctly after Sheet.groupColumn
  507. *
  508. * @param col the column group xml bean
  509. * @param fromColumnIndex 0-indexed
  510. * @param toColumnIndex 0-indexed
  511. */
  512. @SuppressWarnings("SameParameterValue")
  513. private static void checkColumnGroupIsExpanded(CTCol col, int fromColumnIndex, int toColumnIndex) {
  514. assertEquals(fromColumnIndex, col.getMin() - 1, "from column index"); // 1 based
  515. assertEquals(toColumnIndex, col.getMax() - 1, "to column index"); // 1 based
  516. assertFalse(col.isSetHidden(), "isSetHidden");
  517. assertTrue(col.isSetCollapsed(), "isSetCollapsed");
  518. //assertTrue(!col.isSetCollapsed() || !col.getCollapsed(), "isSetCollapsed");
  519. //assertFalse(col.getCollapsed(), "getCollapsed");
  520. }
  521. /**
  522. * TODO - while this is internally consistent, I'm not
  523. * completely clear in all cases what it's supposed to
  524. * be doing... Someone who understands the goals a little
  525. * better should really review this!
  526. */
  527. @Test
  528. void setRowGroupCollapsed() throws IOException {
  529. XSSFWorkbook wb1 = new XSSFWorkbook();
  530. XSSFSheet sheet1 = wb1.createSheet();
  531. sheet1.groupRow( 5, 14 );
  532. sheet1.groupRow( 7, 14 );
  533. sheet1.groupRow( 16, 19 );
  534. assertEquals(14,sheet1.getPhysicalNumberOfRows());
  535. assertFalse(sheet1.getRow(6).getCTRow().isSetCollapsed());
  536. assertFalse(sheet1.getRow(6).getCTRow().isSetHidden());
  537. assertFalse(sheet1.getRow(7).getCTRow().isSetCollapsed());
  538. assertFalse(sheet1.getRow(7).getCTRow().isSetHidden());
  539. assertFalse(sheet1.getRow(9).getCTRow().isSetCollapsed());
  540. assertFalse(sheet1.getRow(9).getCTRow().isSetHidden());
  541. assertFalse(sheet1.getRow(14).getCTRow().isSetCollapsed());
  542. assertFalse(sheet1.getRow(14).getCTRow().isSetHidden());
  543. assertFalse(sheet1.getRow(16).getCTRow().isSetCollapsed());
  544. assertFalse(sheet1.getRow(16).getCTRow().isSetHidden());
  545. assertFalse(sheet1.getRow(18).getCTRow().isSetCollapsed());
  546. assertFalse(sheet1.getRow(18).getCTRow().isSetHidden());
  547. //collapsed
  548. sheet1.setRowGroupCollapsed( 7, true );
  549. assertFalse(sheet1.getRow(6).getCTRow().isSetCollapsed());
  550. assertFalse(sheet1.getRow(6).getCTRow().isSetHidden());
  551. assertFalse(sheet1.getRow(7).getCTRow().isSetCollapsed());
  552. assertTrue (sheet1.getRow(7).getCTRow().isSetHidden());
  553. assertFalse(sheet1.getRow(9).getCTRow().isSetCollapsed());
  554. assertTrue (sheet1.getRow(9).getCTRow().isSetHidden());
  555. assertFalse(sheet1.getRow(14).getCTRow().isSetCollapsed());
  556. assertTrue (sheet1.getRow(14).getCTRow().isSetHidden());
  557. assertFalse(sheet1.getRow(16).getCTRow().isSetCollapsed());
  558. assertFalse(sheet1.getRow(16).getCTRow().isSetHidden());
  559. assertFalse(sheet1.getRow(18).getCTRow().isSetCollapsed());
  560. assertFalse(sheet1.getRow(18).getCTRow().isSetHidden());
  561. //expanded
  562. sheet1.setRowGroupCollapsed( 7, false );
  563. assertFalse(sheet1.getRow(6).getCTRow().isSetCollapsed());
  564. assertFalse(sheet1.getRow(6).getCTRow().isSetHidden());
  565. assertFalse(sheet1.getRow(7).getCTRow().isSetCollapsed());
  566. assertTrue (sheet1.getRow(7).getCTRow().isSetHidden());
  567. assertFalse(sheet1.getRow(9).getCTRow().isSetCollapsed());
  568. assertTrue (sheet1.getRow(9).getCTRow().isSetHidden());
  569. assertFalse(sheet1.getRow(14).getCTRow().isSetCollapsed());
  570. assertTrue (sheet1.getRow(14).getCTRow().isSetHidden());
  571. assertFalse(sheet1.getRow(16).getCTRow().isSetCollapsed());
  572. assertFalse(sheet1.getRow(16).getCTRow().isSetHidden());
  573. assertFalse(sheet1.getRow(18).getCTRow().isSetCollapsed());
  574. assertFalse(sheet1.getRow(18).getCTRow().isSetHidden());
  575. // Save and re-load
  576. XSSFWorkbook wb2 = XSSFTestDataSamples.writeOutAndReadBack(wb1);
  577. wb1.close();
  578. sheet1 = wb2.getSheetAt(0);
  579. assertFalse(sheet1.getRow(6).getCTRow().isSetCollapsed());
  580. assertFalse(sheet1.getRow(6).getCTRow().isSetHidden());
  581. assertFalse(sheet1.getRow(7).getCTRow().isSetCollapsed());
  582. assertTrue (sheet1.getRow(7).getCTRow().isSetHidden());
  583. assertFalse(sheet1.getRow(9).getCTRow().isSetCollapsed());
  584. assertTrue (sheet1.getRow(9).getCTRow().isSetHidden());
  585. assertFalse(sheet1.getRow(14).getCTRow().isSetCollapsed());
  586. assertTrue (sheet1.getRow(14).getCTRow().isSetHidden());
  587. assertFalse(sheet1.getRow(16).getCTRow().isSetCollapsed());
  588. assertFalse(sheet1.getRow(16).getCTRow().isSetHidden());
  589. assertFalse(sheet1.getRow(18).getCTRow().isSetCollapsed());
  590. assertFalse(sheet1.getRow(18).getCTRow().isSetHidden());
  591. wb2.close();
  592. }
  593. /**
  594. * Get / Set column width and check the actual values of the underlying XML beans
  595. */
  596. @Test
  597. void columnWidth_lowlevel() throws IOException {
  598. XSSFWorkbook workbook = new XSSFWorkbook();
  599. XSSFSheet sheet = workbook.createSheet("Sheet 1");
  600. sheet.setColumnWidth(1, 22 * 256);
  601. assertEquals(22 * 256, sheet.getColumnWidth(1));
  602. // Now check the low level stuff, and check that's all
  603. // been set correctly
  604. CTWorksheet cts = sheet.getCTWorksheet();
  605. assertEquals(1, cts.sizeOfColsArray());
  606. CTCols cols = cts.getColsArray(0);
  607. assertEquals(1, cols.sizeOfColArray());
  608. CTCol col = cols.getColArray(0);
  609. // XML is 1 based, POI is 0 based
  610. assertEquals(2, col.getMin());
  611. assertEquals(2, col.getMax());
  612. assertEquals(22.0, col.getWidth(), 0.0);
  613. assertTrue(col.getCustomWidth());
  614. // Now set another
  615. sheet.setColumnWidth(3, 33 * 256);
  616. assertEquals(1, cts.sizeOfColsArray());
  617. cols = cts.getColsArray(0);
  618. assertEquals(2, cols.sizeOfColArray());
  619. col = cols.getColArray(0);
  620. assertEquals(2, col.getMin()); // POI 1
  621. assertEquals(2, col.getMax());
  622. assertEquals(22.0, col.getWidth(), 0.0);
  623. assertTrue(col.getCustomWidth());
  624. col = cols.getColArray(1);
  625. assertEquals(4, col.getMin()); // POI 3
  626. assertEquals(4, col.getMax());
  627. assertEquals(33.0, col.getWidth(), 0.0);
  628. assertTrue(col.getCustomWidth());
  629. workbook.close();
  630. }
  631. /**
  632. * Setting width of a column included in a column span
  633. */
  634. @Test
  635. void bug47862() throws IOException {
  636. XSSFWorkbook wb1 = XSSFTestDataSamples.openSampleWorkbook("47862.xlsx");
  637. XSSFSheet sheet = wb1.getSheetAt(0);
  638. CTCols cols = sheet.getCTWorksheet().getColsArray(0);
  639. //<cols>
  640. // <col min="1" max="5" width="15.77734375" customWidth="1"/>
  641. //</cols>
  642. //a span of columns [1,5]
  643. assertEquals(1, cols.sizeOfColArray());
  644. CTCol col = cols.getColArray(0);
  645. assertEquals(1, col.getMin());
  646. assertEquals(5, col.getMax());
  647. double swidth = 15.77734375; //width of columns in the span
  648. assertEquals(swidth, col.getWidth(), 0.0);
  649. for (int i = 0; i < 5; i++) {
  650. assertEquals((int)(swidth*256), sheet.getColumnWidth(i));
  651. }
  652. int[] cw = new int[]{10, 15, 20, 25, 30};
  653. for (int i = 0; i < 5; i++) {
  654. sheet.setColumnWidth(i, cw[i]*256);
  655. }
  656. //the check below failed prior to fix of Bug #47862
  657. ColumnHelper.sortColumns(cols);
  658. //<cols>
  659. // <col min="1" max="1" customWidth="true" width="10.0" />
  660. // <col min="2" max="2" customWidth="true" width="15.0" />
  661. // <col min="3" max="3" customWidth="true" width="20.0" />
  662. // <col min="4" max="4" customWidth="true" width="25.0" />
  663. // <col min="5" max="5" customWidth="true" width="30.0" />
  664. //</cols>
  665. //now the span is splitted into 5 individual columns
  666. assertEquals(5, cols.sizeOfColArray());
  667. for (int i = 0; i < 5; i++) {
  668. assertEquals(cw[i]*256L, sheet.getColumnWidth(i));
  669. assertEquals(cw[i], cols.getColArray(i).getWidth(), 0.0);
  670. }
  671. //serialize and check again
  672. XSSFWorkbook wb2 = XSSFTestDataSamples.writeOutAndReadBack(wb1);
  673. wb1.close();
  674. sheet = wb2.getSheetAt(0);
  675. cols = sheet.getCTWorksheet().getColsArray(0);
  676. assertEquals(5, cols.sizeOfColArray());
  677. for (int i = 0; i < 5; i++) {
  678. assertEquals(cw[i]*256L, sheet.getColumnWidth(i));
  679. assertEquals(cw[i], cols.getColArray(i).getWidth(), 0.0);
  680. }
  681. wb2.close();
  682. }
  683. /**
  684. * Hiding a column included in a column span
  685. */
  686. @Test
  687. void bug47804() throws IOException {
  688. XSSFWorkbook wb1 = XSSFTestDataSamples.openSampleWorkbook("47804.xlsx");
  689. XSSFSheet sheet = wb1.getSheetAt(0);
  690. CTCols cols = sheet.getCTWorksheet().getColsArray(0);
  691. assertEquals(2, cols.sizeOfColArray());
  692. CTCol col;
  693. //<cols>
  694. // <col min="2" max="4" width="12" customWidth="1"/>
  695. // <col min="7" max="7" width="10.85546875" customWidth="1"/>
  696. //</cols>
  697. //a span of columns [2,4]
  698. col = cols.getColArray(0);
  699. assertEquals(2, col.getMin());
  700. assertEquals(4, col.getMax());
  701. //individual column
  702. col = cols.getColArray(1);
  703. assertEquals(7, col.getMin());
  704. assertEquals(7, col.getMax());
  705. sheet.setColumnHidden(2, true); // Column C
  706. sheet.setColumnHidden(6, true); // Column G
  707. assertTrue(sheet.isColumnHidden(2));
  708. assertTrue(sheet.isColumnHidden(6));
  709. //other columns but C and G are not hidden
  710. assertFalse(sheet.isColumnHidden(1));
  711. assertFalse(sheet.isColumnHidden(3));
  712. assertFalse(sheet.isColumnHidden(4));
  713. assertFalse(sheet.isColumnHidden(5));
  714. //the check below failed prior to fix of Bug #47804
  715. ColumnHelper.sortColumns(cols);
  716. //the span is now splitted into three parts
  717. //<cols>
  718. // <col min="2" max="2" customWidth="true" width="12.0" />
  719. // <col min="3" max="3" customWidth="true" width="12.0" hidden="true"/>
  720. // <col min="4" max="4" customWidth="true" width="12.0"/>
  721. // <col min="7" max="7" customWidth="true" width="10.85546875" hidden="true"/>
  722. //</cols>
  723. assertEquals(4, cols.sizeOfColArray());
  724. col = cols.getColArray(0);
  725. assertEquals(2, col.getMin());
  726. assertEquals(2, col.getMax());
  727. col = cols.getColArray(1);
  728. assertEquals(3, col.getMin());
  729. assertEquals(3, col.getMax());
  730. col = cols.getColArray(2);
  731. assertEquals(4, col.getMin());
  732. assertEquals(4, col.getMax());
  733. col = cols.getColArray(3);
  734. assertEquals(7, col.getMin());
  735. assertEquals(7, col.getMax());
  736. //serialize and check again
  737. XSSFWorkbook wb2 = XSSFTestDataSamples.writeOutAndReadBack(wb1);
  738. wb1.close();
  739. sheet = wb2.getSheetAt(0);
  740. assertTrue(sheet.isColumnHidden(2));
  741. assertTrue(sheet.isColumnHidden(6));
  742. assertFalse(sheet.isColumnHidden(1));
  743. assertFalse(sheet.isColumnHidden(3));
  744. assertFalse(sheet.isColumnHidden(4));
  745. assertFalse(sheet.isColumnHidden(5));
  746. wb2.close();
  747. }
  748. @Test
  749. void commentsTable() throws IOException {
  750. XSSFWorkbook wb1 = new XSSFWorkbook();
  751. XSSFSheet sheet1 = wb1.createSheet();
  752. CommentsTable comment1 = sheet1.getCommentsTable(false);
  753. assertNull(comment1);
  754. comment1 = sheet1.getCommentsTable(true);
  755. assertNotNull(comment1);
  756. assertEquals("/xl/comments1.xml", comment1.getPackagePart().getPartName().getName());
  757. assertSame(comment1, sheet1.getCommentsTable(true));
  758. //second sheet
  759. XSSFSheet sheet2 = wb1.createSheet();
  760. CommentsTable comment2 = sheet2.getCommentsTable(false);
  761. assertNull(comment2);
  762. comment2 = sheet2.getCommentsTable(true);
  763. assertNotNull(comment2);
  764. assertSame(comment2, sheet2.getCommentsTable(true));
  765. assertEquals("/xl/comments2.xml", comment2.getPackagePart().getPartName().getName());
  766. //comment1 and comment2 are different objects
  767. assertNotSame(comment1, comment2);
  768. wb1.close();
  769. //now test against a workbook containing cell comments
  770. XSSFWorkbook wb2 = XSSFTestDataSamples.openSampleWorkbook("WithMoreVariousData.xlsx");
  771. sheet1 = wb2.getSheetAt(0);
  772. comment1 = sheet1.getCommentsTable(true);
  773. assertNotNull(comment1);
  774. assertEquals("/xl/comments1.xml", comment1.getPackagePart().getPartName().getName());
  775. assertSame(comment1, sheet1.getCommentsTable(true));
  776. wb2.close();
  777. }
  778. /**
  779. * Rows and cells can be created in random order,
  780. * but CTRows are kept in ascending order
  781. */
  782. @Override
  783. @Test
  784. protected void createRow() throws IOException {
  785. XSSFWorkbook wb1 = new XSSFWorkbook();
  786. XSSFSheet sheet = wb1.createSheet();
  787. CTWorksheet wsh = sheet.getCTWorksheet();
  788. CTSheetData sheetData = wsh.getSheetData();
  789. assertEquals(0, sheetData.sizeOfRowArray());
  790. XSSFRow row1 = sheet.createRow(2);
  791. row1.createCell(2);
  792. row1.createCell(1);
  793. XSSFRow row2 = sheet.createRow(1);
  794. row2.createCell(2);
  795. row2.createCell(1);
  796. row2.createCell(0);
  797. XSSFRow row3 = sheet.createRow(0);
  798. row3.createCell(3);
  799. row3.createCell(0);
  800. row3.createCell(2);
  801. row3.createCell(5);
  802. CTRow[] xrow = sheetData.getRowArray();
  803. assertEquals(3, xrow.length);
  804. //rows are sorted: {0, 1, 2}
  805. assertEquals(4, xrow[0].sizeOfCArray());
  806. assertEquals(1, xrow[0].getR());
  807. assertEquals(xrow[0], row3.getCTRow());
  808. assertEquals(3, xrow[1].sizeOfCArray());
  809. assertEquals(2, xrow[1].getR());
  810. assertEquals(xrow[1], row2.getCTRow());
  811. assertEquals(2, xrow[2].sizeOfCArray());
  812. assertEquals(3, xrow[2].getR());
  813. assertEquals(xrow[2], row1.getCTRow());
  814. CTCell[] xcell = xrow[0].getCArray();
  815. assertEquals("D1", xcell[0].getR());
  816. assertEquals("A1", xcell[1].getR());
  817. assertEquals("C1", xcell[2].getR());
  818. assertEquals("F1", xcell[3].getR());
  819. //re-creating a row does NOT add extra data to the parent
  820. row2 = sheet.createRow(1);
  821. assertEquals(3, sheetData.sizeOfRowArray());
  822. //existing cells are invalidated
  823. assertEquals(0, sheetData.getRowArray(1).sizeOfCArray());
  824. assertEquals(0, row2.getPhysicalNumberOfCells());
  825. XSSFWorkbook wb2 = XSSFTestDataSamples.writeOutAndReadBack(wb1);
  826. wb1.close();
  827. sheet = wb2.getSheetAt(0);
  828. wsh = sheet.getCTWorksheet();
  829. assertNotNull(wsh);
  830. xrow = sheetData.getRowArray();
  831. assertEquals(3, xrow.length);
  832. //rows are sorted: {0, 1, 2}
  833. assertEquals(4, xrow[0].sizeOfCArray());
  834. assertEquals(1, xrow[0].getR());
  835. //cells are now sorted
  836. xcell = xrow[0].getCArray();
  837. assertEquals("A1", xcell[0].getR());
  838. assertEquals("C1", xcell[1].getR());
  839. assertEquals("D1", xcell[2].getR());
  840. assertEquals("F1", xcell[3].getR());
  841. assertEquals(0, xrow[1].sizeOfCArray());
  842. assertEquals(2, xrow[1].getR());
  843. assertEquals(2, xrow[2].sizeOfCArray());
  844. assertEquals(3, xrow[2].getR());
  845. wb2.close();
  846. }
  847. @Test
  848. void setAutoFilter() throws IOException {
  849. XSSFWorkbook wb = new XSSFWorkbook();
  850. XSSFSheet sheet = wb.createSheet("new sheet");
  851. sheet.setAutoFilter(CellRangeAddress.valueOf("A1:D100"));
  852. assertEquals("A1:D100", sheet.getCTWorksheet().getAutoFilter().getRef());
  853. // auto-filter must be registered in workboook.xml, see Bugzilla 50315
  854. XSSFName nm = wb.getBuiltInName(XSSFName.BUILTIN_FILTER_DB, 0);
  855. assertNotNull(nm);
  856. assertEquals(0, nm.getCTName().getLocalSheetId());
  857. assertTrue(nm.getCTName().getHidden());
  858. assertEquals("_xlnm._FilterDatabase", nm.getCTName().getName());
  859. assertEquals("'new sheet'!$A$1:$D$100", nm.getCTName().getStringValue());
  860. wb.close();
  861. }
  862. @Test
  863. void protectSheet_lowlevel() throws IOException {
  864. XSSFWorkbook wb = new XSSFWorkbook();
  865. XSSFSheet sheet = wb.createSheet();
  866. CTSheetProtection pr = sheet.getCTWorksheet().getSheetProtection();
  867. assertNull(pr, "CTSheetProtection should be null by default");
  868. String password = "Test";
  869. sheet.protectSheet(password);
  870. pr = sheet.getCTWorksheet().getSheetProtection();
  871. assertNotNull(pr, "CTSheetProtection should be not null");
  872. assertTrue(pr.isSetSheet(), "sheet protection should be on");
  873. assertTrue(pr.isSetObjects(), "object protection should be on");
  874. assertTrue(pr.isSetScenarios(), "scenario protection should be on");
  875. int hashVal = CryptoFunctions.createXorVerifier1(password);
  876. int actualVal = Integer.parseInt(pr.xgetPassword().getStringValue(),16);
  877. assertEquals(hashVal, actualVal, "well known value for top secret hash should match");
  878. sheet.protectSheet(null);
  879. assertNull(sheet.getCTWorksheet().getSheetProtection(), "protectSheet(null) should unset CTSheetProtection");
  880. wb.close();
  881. }
  882. @Test
  883. void protectSheet_emptyPassword() throws IOException {
  884. XSSFWorkbook wb = new XSSFWorkbook();
  885. XSSFSheet sheet = wb.createSheet();
  886. CTSheetProtection pr = sheet.getCTWorksheet().getSheetProtection();
  887. assertNull(pr, "CTSheetProtection should be null by default");
  888. String password = "";
  889. sheet.protectSheet(password);
  890. pr = sheet.getCTWorksheet().getSheetProtection();
  891. assertNotNull(pr, "CTSheetProtection should be not null");
  892. assertTrue(pr.isSetSheet(), "sheet protection should be on");
  893. assertTrue(pr.isSetObjects(), "object protection should be on");
  894. assertTrue(pr.isSetScenarios(), "scenario protection should be on");
  895. int hashVal = CryptoFunctions.createXorVerifier1(password);
  896. STUnsignedShortHex xpassword = pr.xgetPassword();
  897. int actualVal = Integer.parseInt(xpassword.getStringValue(),16);
  898. assertEquals(hashVal, actualVal, "well known value for top secret hash should match");
  899. sheet.protectSheet(null);
  900. assertNull(sheet.getCTWorksheet().getSheetProtection(), "protectSheet(null) should unset CTSheetProtection");
  901. wb.close();
  902. }
  903. @Test
  904. void protectSheet_lowlevel_2013() throws IOException {
  905. String password = "test";
  906. XSSFWorkbook wb1 = new XSSFWorkbook();
  907. XSSFSheet xs = wb1.createSheet();
  908. xs.setSheetPassword(password, HashAlgorithm.sha384);
  909. XSSFWorkbook wb2 = writeOutAndReadBack(wb1);
  910. wb1.close();
  911. assertTrue(wb2.getSheetAt(0).validateSheetPassword(password));
  912. wb2.close();
  913. XSSFWorkbook wb3 = openSampleWorkbook("workbookProtection-sheet_password-2013.xlsx");
  914. assertTrue(wb3.getSheetAt(0).validateSheetPassword("pwd"));
  915. wb3.close();
  916. }
  917. @Test
  918. void bug49966() throws IOException {
  919. XSSFWorkbook wb1 = XSSFTestDataSamples.openSampleWorkbook("49966.xlsx");
  920. CalculationChain calcChain = wb1.getCalculationChain();
  921. assertNotNull(wb1.getCalculationChain());
  922. assertEquals(3, calcChain.getCTCalcChain().sizeOfCArray());
  923. XSSFSheet sheet = wb1.getSheetAt(0);
  924. XSSFRow row = sheet.getRow(0);
  925. sheet.removeRow(row);
  926. assertEquals(0, calcChain.getCTCalcChain().sizeOfCArray(), "XSSFSheet#removeRow did not clear calcChain entries");
  927. //calcChain should be gone
  928. XSSFWorkbook wb2 = XSSFTestDataSamples.writeOutAndReadBack(wb1);
  929. wb1.close();
  930. assertNull(wb2.getCalculationChain());
  931. wb2.close();
  932. }
  933. /**
  934. * See bug #50829 test data tables
  935. */
  936. @Test
  937. void tables() throws IOException {
  938. XSSFWorkbook wb = XSSFTestDataSamples.openSampleWorkbook("WithTable.xlsx");
  939. assertEquals(3, wb.getNumberOfSheets());
  940. // Check the table sheet
  941. XSSFSheet s1 = wb.getSheetAt(0);
  942. assertEquals("a", s1.getRow(0).getCell(0).getRichStringCellValue().toString());
  943. assertEquals(1.0, s1.getRow(1).getCell(0).getNumericCellValue(), 0);
  944. List<XSSFTable> tables = s1.getTables();
  945. assertNotNull(tables);
  946. assertEquals(1, tables.size());
  947. XSSFTable table = tables.get(0);
  948. assertEquals("Tabella1", table.getName());
  949. assertEquals("Tabella1", table.getDisplayName());
  950. // And the others
  951. XSSFSheet s2 = wb.getSheetAt(1);
  952. assertEquals(0, s2.getTables().size());
  953. XSSFSheet s3 = wb.getSheetAt(2);
  954. assertEquals(0, s3.getTables().size());
  955. wb.close();
  956. }
  957. /**
  958. * Test to trigger OOXML-LITE generating to include org.openxmlformats.schemas.spreadsheetml.x2006.main.CTSheetCalcPr
  959. */
  960. @Test
  961. void setForceFormulaRecalculation() throws IOException {
  962. XSSFWorkbook wb1 = new XSSFWorkbook();
  963. XSSFSheet sheet = wb1.createSheet("Sheet 1");
  964. assertFalse(sheet.getForceFormulaRecalculation());
  965. // Set
  966. sheet.setForceFormulaRecalculation(true);
  967. assertTrue(sheet.getForceFormulaRecalculation());
  968. // calcMode="manual" is unset when forceFormulaRecalculation=true
  969. CTCalcPr calcPr = wb1.getCTWorkbook().addNewCalcPr();
  970. calcPr.setCalcMode(STCalcMode.MANUAL);
  971. sheet.setForceFormulaRecalculation(true);
  972. assertSame(STCalcMode.AUTO, calcPr.getCalcMode());
  973. // Check
  974. sheet.setForceFormulaRecalculation(false);
  975. assertFalse(sheet.getForceFormulaRecalculation());
  976. // Save, re-load, and re-check
  977. XSSFWorkbook wb2 = XSSFTestDataSamples.writeOutAndReadBack(wb1);
  978. wb1.close();
  979. sheet = wb2.getSheet("Sheet 1");
  980. assertFalse(sheet.getForceFormulaRecalculation());
  981. wb2.close();
  982. }
  983. @Test
  984. void bug54607() throws IOException {
  985. // run with the file provided in the Bug-Report
  986. runGetTopRow("54607.xlsx", true, 1, 0, 0);
  987. runGetLeftCol("54607.xlsx", true, 0, 0, 0);
  988. // run with some other flie to see
  989. runGetTopRow("54436.xlsx", true, 0);
  990. runGetLeftCol("54436.xlsx", true, 0);
  991. runGetTopRow("TwoSheetsNoneHidden.xlsx", true, 0, 0);
  992. runGetLeftCol("TwoSheetsNoneHidden.xlsx", true, 0, 0);
  993. runGetTopRow("TwoSheetsNoneHidden.xls", false, 0, 0);
  994. runGetLeftCol("TwoSheetsNoneHidden.xls", false, 0, 0);
  995. }
  996. private void runGetTopRow(String file, boolean isXSSF, int... topRows) throws IOException {
  997. final Workbook wb = (isXSSF)
  998. ? XSSFTestDataSamples.openSampleWorkbook(file)
  999. : HSSFTestDataSamples.openSampleWorkbook(file);
  1000. for (int si = 0; si < wb.getNumberOfSheets(); si++) {
  1001. Sheet sh = wb.getSheetAt(si);
  1002. assertNotNull(sh.getSheetName());
  1003. assertEquals(topRows[si], sh.getTopRow(), "Did not match for sheet " + si);
  1004. }
  1005. // for XSSF also test with SXSSF
  1006. if (isXSSF) {
  1007. Workbook swb = new SXSSFWorkbook((XSSFWorkbook) wb);
  1008. for (int si = 0; si < swb.getNumberOfSheets(); si++) {
  1009. Sheet sh = swb.getSheetAt(si);
  1010. assertNotNull(sh.getSheetName());
  1011. assertEquals(topRows[si], sh.getTopRow(), "Did not match for sheet " + si);
  1012. }
  1013. swb.close();
  1014. }
  1015. wb.close();
  1016. }
  1017. private void runGetLeftCol(String file, boolean isXSSF, int... topRows) throws IOException {
  1018. final Workbook wb = (isXSSF)
  1019. ? XSSFTestDataSamples.openSampleWorkbook(file)
  1020. : HSSFTestDataSamples.openSampleWorkbook(file);
  1021. for (int si = 0; si < wb.getNumberOfSheets(); si++) {
  1022. Sheet sh = wb.getSheetAt(si);
  1023. assertNotNull(sh.getSheetName());
  1024. assertEquals(topRows[si], sh.getLeftCol(), "Did not match for sheet " + si);
  1025. }
  1026. // for XSSF also test with SXSSF
  1027. if(isXSSF) {
  1028. Workbook swb = new SXSSFWorkbook((XSSFWorkbook) wb);
  1029. for (int si = 0; si < swb.getNumberOfSheets(); si++) {
  1030. Sheet sh = swb.getSheetAt(si);
  1031. assertNotNull(sh.getSheetName());
  1032. assertEquals(topRows[si], sh.getLeftCol(), "Did not match for sheet " + si);
  1033. }
  1034. swb.close();
  1035. }
  1036. wb.close();
  1037. }
  1038. @Test
  1039. void bug55745() throws Exception {
  1040. try (XSSFWorkbook wb = XSSFTestDataSamples.openSampleWorkbook("55745.xlsx")) {
  1041. XSSFSheet sheet = wb.getSheetAt(0);
  1042. List<XSSFTable> tables = sheet.getTables();
  1043. assertEquals(8, tables.size(), "Sheet should contain 8 tables");
  1044. assertNotNull(sheet.getCommentsTable(false), "Sheet should contain a comments table");
  1045. }
  1046. }
  1047. @Test
  1048. void bug55723b() throws IOException {
  1049. XSSFWorkbook wb = new XSSFWorkbook();
  1050. Sheet sheet = wb.createSheet();
  1051. // stored with a special name
  1052. assertNull(wb.getBuiltInName(XSSFName.BUILTIN_FILTER_DB, 0));
  1053. CellRangeAddress range = CellRangeAddress.valueOf("A:B");
  1054. AutoFilter filter = sheet.setAutoFilter(range);
  1055. assertNotNull(filter);
  1056. // stored with a special name
  1057. XSSFName name = wb.getBuiltInName(XSSFName.BUILTIN_FILTER_DB, 0);
  1058. assertNotNull(name);
  1059. assertEquals("Sheet0!$A:$B", name.getRefersToFormula());
  1060. range = CellRangeAddress.valueOf("B:C");
  1061. filter = sheet.setAutoFilter(range);
  1062. assertNotNull(filter);
  1063. // stored with a special name
  1064. name = wb.getBuiltInName(XSSFName.BUILTIN_FILTER_DB, 0);
  1065. assertNotNull(name);
  1066. assertEquals("Sheet0!$B:$C", name.getRefersToFormula());
  1067. wb.close();
  1068. }
  1069. @Timeout(value = 180, unit = SECONDS)
  1070. @Test
  1071. void bug51585() throws IOException {
  1072. try (XSSFWorkbook wb = XSSFTestDataSamples.openSampleWorkbook("51585.xlsx")) {
  1073. assertNotNull(wb.getSheetAt(0));
  1074. }
  1075. }
  1076. private XSSFWorkbook setupSheet(){
  1077. //set up workbook
  1078. XSSFWorkbook wb = new XSSFWorkbook();
  1079. XSSFSheet sheet = wb.createSheet();
  1080. Row row1 = sheet.createRow(0);
  1081. Cell cell = row1.createCell(0);
  1082. cell.setCellValue("Names");
  1083. Cell cell2 = row1.createCell(1);
  1084. cell2.setCellValue("#");
  1085. Row row2 = sheet.createRow(1);
  1086. Cell cell3 = row2.createCell(0);
  1087. cell3.setCellValue("Jane");
  1088. Cell cell4 = row2.createCell(1);
  1089. cell4.setCellValue(3);
  1090. Row row3 = sheet.createRow(2);
  1091. Cell cell5 = row3.createCell(0);
  1092. cell5.setCellValue("John");
  1093. Cell cell6 = row3.createCell(1);
  1094. cell6.setCellValue(3);
  1095. return wb;
  1096. }
  1097. @Test
  1098. void testCreateTwoPivotTablesInOneSheet() throws IOException {
  1099. XSSFWorkbook wb = setupSheet();
  1100. XSSFSheet sheet = wb.getSheetAt(0);
  1101. assertNotNull(wb);
  1102. assertNotNull(sheet);
  1103. XSSFPivotTable pivotTable = sheet.createPivotTable(wb.getCreationHelper().createAreaReference("A1:B2"),
  1104. new CellReference("H5"));
  1105. assertNotNull(pivotTable);
  1106. assertTrue(wb.getPivotTables().size() > 0);
  1107. XSSFPivotTable pivotTable2 = sheet.createPivotTable(wb.getCreationHelper().createAreaReference("A1:B2"),
  1108. new CellReference("L5"), sheet);
  1109. assertNotNull(pivotTable2);
  1110. assertTrue(wb.getPivotTables().size() > 1);
  1111. wb.close();
  1112. }
  1113. @Test
  1114. void testCreateTwoPivotTablesInTwoSheets() throws IOException {
  1115. XSSFWorkbook wb = setupSheet();
  1116. XSSFSheet sheet = wb.getSheetAt(0);
  1117. assertNotNull(wb);
  1118. assertNotNull(sheet);
  1119. XSSFPivotTable pivotTable = sheet.createPivotTable(wb.getCreationHelper().createAreaReference("A1:B2"), new CellReference("H5"));
  1120. assertNotNull(pivotTable);
  1121. assertTrue(wb.getPivotTables().size() > 0);
  1122. assertNotNull(wb);
  1123. XSSFSheet sheet2 = wb.createSheet();
  1124. XSSFPivotTable pivotTable2 = sheet2.createPivotTable(wb.getCreationHelper().createAreaReference("A1:B2"),
  1125. new CellReference("H5"), sheet);
  1126. assertNotNull(pivotTable2);
  1127. assertTrue(wb.getPivotTables().size() > 1);
  1128. wb.close();
  1129. }
  1130. @Test
  1131. void testCreatePivotTable() throws IOException {
  1132. XSSFWorkbook wb = setupSheet();
  1133. XSSFSheet sheet = wb.getSheetAt(0);
  1134. assertNotNull(wb);
  1135. assertNotNull(sheet);
  1136. XSSFPivotTable pivotTable = sheet.createPivotTable(wb.getCreationHelper().createAreaReference("A1:B2"), new CellReference("H5"));
  1137. assertNotNull(pivotTable);
  1138. assertTrue(wb.getPivotTables().size() > 0);
  1139. wb.close();
  1140. }
  1141. @Test
  1142. void testCreatePivotTableInOtherSheetThanDataSheet() throws IOException {
  1143. XSSFWorkbook wb = setupSheet();
  1144. XSSFSheet sheet1 = wb.getSheetAt(0);
  1145. XSSFSheet sheet2 = wb.createSheet();
  1146. XSSFPivotTable pivotTable = sheet2.createPivotTable
  1147. (wb.getCreationHelper().createAreaReference("A1:B2"), new CellReference("H5"), sheet1);
  1148. assertEquals(0, pivotTable.getRowLabelColumns().size());
  1149. assertEquals(1, wb.getPivotTables().size());
  1150. assertEquals(0, sheet1.getPivotTables().size());
  1151. assertEquals(1, sheet2.getPivotTables().size());
  1152. wb.close();
  1153. }
  1154. @Test
  1155. void testCreatePivotTableInOtherSheetThanDataSheetUsingAreaReference() throws IOException {
  1156. XSSFWorkbook wb = setupSheet();
  1157. XSSFSheet sheet = wb.getSheetAt(0);
  1158. XSSFSheet sheet2 = wb.createSheet("TEST");
  1159. XSSFPivotTable pivotTable = sheet2.createPivotTable(
  1160. wb.getCreationHelper().createAreaReference(sheet.getSheetName()+"!A$1:B$2"),
  1161. new CellReference("H5"));
  1162. assertEquals(0, pivotTable.getRowLabelColumns().size());
  1163. wb.close();
  1164. }
  1165. @Test
  1166. void testCreatePivotTableWithConflictingDataSheets() throws IOException {
  1167. try (XSSFWorkbook wb = setupSheet()) {
  1168. XSSFSheet sheet = wb.getSheetAt(0);
  1169. XSSFSheet sheet2 = wb.createSheet("TEST");
  1170. CellReference cr = new CellReference("H5");
  1171. AreaReference ar = wb.getCreationHelper().createAreaReference(sheet.getSheetName() + "!A$1:B$2");
  1172. assertThrows(IllegalArgumentException.class, () -> sheet2.createPivotTable(ar, cr, sheet2));
  1173. }
  1174. }
  1175. @Test
  1176. void testReadFails() throws IOException {
  1177. try (XSSFWorkbook wb = new XSSFWorkbook()) {
  1178. XSSFSheet sheet = wb.createSheet();
  1179. // Throws exception because we cannot read here
  1180. assertThrows(POIXMLException.class, sheet::onDocumentRead);
  1181. }
  1182. }
  1183. /**
  1184. * This would be better off as a testable example rather than a simple unit test
  1185. * since Sheet.createComment() was deprecated and removed.
  1186. * https://poi.apache.org/spreadsheet/quick-guide.html#CellComments
  1187. * Feel free to relocated or delete this unit test if it doesn't belong here.
  1188. */
  1189. @Test
  1190. void testCreateComment() throws IOException {
  1191. XSSFWorkbook wb = new XSSFWorkbook();
  1192. ClientAnchor anchor = wb.getCreationHelper().createClientAnchor();
  1193. XSSFSheet sheet = wb.createSheet();
  1194. XSSFComment comment = sheet.createDrawingPatriarch().createCellComment(anchor);
  1195. assertNotNull(comment);
  1196. wb.close();
  1197. }
  1198. @Test
  1199. void testCopyOneRow() throws IOException {
  1200. final double FLOAT_PRECISION = 1e-9;
  1201. try (final XSSFWorkbook wb = XSSFTestDataSamples.openSampleWorkbook("XSSFSheet.copyRows.xlsx")) {
  1202. final XSSFSheet sheet = wb.getSheetAt(0);
  1203. final CellCopyPolicy defaultCopyPolicy = new CellCopyPolicy();
  1204. sheet.copyRows(1, 1, 6, defaultCopyPolicy);
  1205. final Row srcRow = sheet.getRow(1);
  1206. final Row destRow = sheet.getRow(6);
  1207. int col = 0;
  1208. Cell cell;
  1209. cell = CellUtil.getCell(destRow, col++);
  1210. assertEquals("Source row ->", cell.getStringCellValue());
  1211. // Style
  1212. cell = CellUtil.getCell(destRow, col++);
  1213. assertEquals("Red", cell.getStringCellValue(), "[Style] B7 cell value");
  1214. assertEquals(CellUtil.getCell(srcRow, 1).getCellStyle(), cell.getCellStyle(), "[Style] B7 cell style");
  1215. // Blank
  1216. cell = CellUtil.getCell(destRow, col++);
  1217. assertEquals(CellType.BLANK, cell.getCellType(), "[Blank] C7 cell type");
  1218. // Error
  1219. cell = CellUtil.getCell(destRow, col++);
  1220. assertEquals(CellType.ERROR, cell.getCellType(), "[Error] D7 cell type");
  1221. final FormulaError error = FormulaError.forInt(cell.getErrorCellValue());
  1222. //FIXME: XSSFCell and HSSFCell expose different interfaces. getErrorCellString would be helpful here
  1223. assertEquals(FormulaError.NA, error, "[Error] D7 cell value");
  1224. // Date
  1225. cell = CellUtil.getCell(destRow, col++);
  1226. assertEquals(CellType.NUMERIC, cell.getCellType(), "[Date] E7 cell type");
  1227. final Date date = LocaleUtil.getLocaleCalendar(2000, Calendar.JANUARY, 1).getTime();
  1228. assertEquals(date, cell.getDateCellValue(), "[Date] E7 cell value");
  1229. // Boolean
  1230. cell = CellUtil.getCell(destRow, col++);
  1231. assertEquals(CellType.BOOLEAN, cell.getCellType(), "[Boolean] F7 cell type");
  1232. assertTrue(cell.getBooleanCellValue(), "[Boolean] F7 cell value");
  1233. // String
  1234. cell = CellUtil.getCell(destRow, col++);
  1235. assertEquals(CellType.STRING, cell.getCellType(), "[String] G7 cell type");
  1236. assertEquals("Hello", cell.getStringCellValue(), "[String] G7 cell value");
  1237. // Int
  1238. cell = CellUtil.getCell(destRow, col++);
  1239. assertEquals(CellType.NUMERIC, cell.getCellType(), "[Int] H7 cell type");
  1240. assertEquals(15, (int) cell.getNumericCellValue(), "[Int] H7 cell value");
  1241. // Float
  1242. cell = CellUtil.getCell(destRow, col++);
  1243. assertEquals(CellType.NUMERIC, cell.getCellType(), "[Float] I7 cell type");
  1244. assertEquals(12.5, cell.getNumericCellValue(), FLOAT_PRECISION, "[Float] I7 cell value");
  1245. // Cell Formula
  1246. cell = CellUtil.getCell(destRow, col++);
  1247. assertEquals("Sheet1!J7", new CellReference(cell).formatAsString());
  1248. assertEquals(CellType.FORMULA, cell.getCellType(), "[Cell Formula] J7 cell type");
  1249. assertEquals("5+2", cell.getCellFormula(), "[Cell Formula] J7 cell formula");
  1250. //System.out.println("Cell formula evaluation currently unsupported");
  1251. // Cell Formula with Reference
  1252. // Formula row references should be adjusted by destRowNum-srcRowNum
  1253. cell = CellUtil.getCell(destRow, col++);
  1254. assertEquals("Sheet1!K7", new CellReference(cell).formatAsString());
  1255. assertEquals(CellType.FORMULA, cell.getCellType(), "[Cell Formula with Reference] K7 cell type");
  1256. assertEquals("J7+H$2", cell.getCellFormula(), "[Cell Formula with Reference] K7 cell formula");
  1257. // Cell Formula with Reference spanning multiple rows
  1258. cell = CellUtil.getCell(destRow, col++);
  1259. assertEquals(CellType.FORMULA, cell.getCellType(), "[Cell Formula with Reference spanning multiple rows] L7 cell type");
  1260. assertEquals("G7&\" \"&G8", cell.getCellFormula(), "[Cell Formula with Reference spanning multiple rows] L7 cell formula");
  1261. // Cell Formula with Reference spanning multiple rows
  1262. cell = CellUtil.getCell(destRow, col++);
  1263. assertEquals(CellType.FORMULA, cell.getCellType(), "[Cell Formula with Area Reference] M7 cell type");
  1264. assertEquals("SUM(H7:I8)", cell.getCellFormula(), "[Cell Formula with Area Reference] M7 cell formula");
  1265. // Array Formula
  1266. col++;
  1267. // cell = CellUtil.getCell(destRow, col++);
  1268. // Array formulas currently unsupported"
  1269. // FIXME: Array Formula set with Sheet.setArrayFormula() instead of cell.setFormula()
  1270. // assertEquals(CellType.FORMULA, cell.getCellType(), "[Array Formula] N7 cell type");
  1271. // assertEquals("{SUM(H7:J7*{1,2,3})}", cell.getCellFormula(), "[Array Formula] N7 cell formula");
  1272. // Data Format
  1273. cell = CellUtil.getCell(destRow, col++);
  1274. assertEquals(CellType.NUMERIC, cell.getCellType(), "[Data Format] O7 cell type");
  1275. assertEquals(100.20, cell.getNumericCellValue(), FLOAT_PRECISION, "[Data Format] O7 cell value");
  1276. //FIXME: currently fails
  1277. final String moneyFormat = "\"$\"#,##0.00_);[Red]\\(\"$\"#,##0.00\\)";
  1278. assertEquals(moneyFormat, cell.getCellStyle().getDataFormatString(), "[Data Format] O7 data format");
  1279. // Merged
  1280. cell = CellUtil.getCell(destRow, col);
  1281. assertEquals("Merged cells", cell.getStringCellValue(), "[Merged] P7:Q7 cell value");
  1282. assertTrue(sheet.getMergedRegions().contains(CellRangeAddress.valueOf("P7:Q7")), "[Merged] P7:Q7 merged region");
  1283. // Merged across multiple rows
  1284. // Microsoft Excel 2013 does not copy a merged region unless all rows of
  1285. // the source merged region are selected
  1286. // POI's behavior should match this behavior
  1287. col += 2;
  1288. cell = CellUtil.getCell(destRow, col);
  1289. // Note: this behavior deviates from Microsoft Excel,
  1290. // which will not overwrite a cell in destination row if merged region extends beyond the copied row.
  1291. // The Excel way would require:
  1292. //assertEquals("[Merged across multiple rows] R7:S8 merged region", "Should NOT be overwritten", cell.getStringCellValue());
  1293. //assertFalse("[Merged across multiple rows] R7:S8 merged region",
  1294. // sheet.getMergedRegions().contains(CellRangeAddress.valueOf("R7:S8")));
  1295. // As currently implemented, cell value is copied but merged region is not copied
  1296. assertEquals("Merged cells across multiple rows", cell.getStringCellValue(), "[Merged across multiple rows] R7:S8 cell value");
  1297. // shouldn't do 1-row merge
  1298. assertFalse(sheet.getMergedRegions().contains(CellRangeAddress.valueOf("R7:S7")), "[Merged across multiple rows] R7:S7 merged region (one row)");
  1299. //shouldn't do 2-row merge
  1300. assertFalse(sheet.getMergedRegions().contains(CellRangeAddress.valueOf("R7:S8")), "[Merged across multiple rows] R7:S8 merged region");
  1301. // Make sure other rows are blank (off-by-one errors)
  1302. assertNull(sheet.getRow(5));
  1303. assertNull(sheet.getRow(7));
  1304. }
  1305. }
  1306. @Test
  1307. void testCopyMultipleRows() throws IOException {
  1308. final double FLOAT_PRECISION = 1e-9;
  1309. try (XSSFWorkbook wb = XSSFTestDataSamples.openSampleWorkbook("XSSFSheet.copyRows.xlsx")) {
  1310. final XSSFSheet sheet = wb.getSheetAt(0);
  1311. final CellCopyPolicy defaultCopyPolicy = new CellCopyPolicy();
  1312. sheet.copyRows(0, 3, 8, defaultCopyPolicy);
  1313. sheet.getRow(0);
  1314. final Row srcRow1 = sheet.getRow(1);
  1315. final Row srcRow2 = sheet.getRow(2);
  1316. final Row srcRow3 = sheet.getRow(3);
  1317. final Row destHeaderRow = sheet.getRow(8);
  1318. final Row destRow1 = sheet.getRow(9);
  1319. final Row destRow2 = sheet.getRow(10);
  1320. final Row destRow3 = sheet.getRow(11);
  1321. int col = 0;
  1322. Cell cell;
  1323. // Header row should be copied
  1324. assertNotNull(destHeaderRow);
  1325. // Data rows
  1326. cell = CellUtil.getCell(destRow1, col);
  1327. assertEquals("Source row ->", cell.getStringCellValue());
  1328. // Style
  1329. col++;
  1330. cell = CellUtil.getCell(destRow1, col);
  1331. assertEquals("Red", cell.getStringCellValue(), "[Style] B10 cell value");
  1332. assertEquals(CellUtil.getCell(srcRow1, 1).getCellStyle(), cell.getCellStyle(), "[Style] B10 cell style");
  1333. cell = CellUtil.getCell(destRow2, col);
  1334. assertEquals("Blue", cell.getStringCellValue(), "[Style] B11 cell value");
  1335. assertEquals(CellUtil.getCell(srcRow2, 1).getCellStyle(), cell.getCellStyle(), "[Style] B11 cell style");
  1336. // Blank
  1337. col++;
  1338. cell = CellUtil.getCell(destRow1, col);
  1339. assertEquals(CellType.BLANK, cell.getCellType(), "[Blank] C10 cell type");
  1340. cell = CellUtil.getCell(destRow2, col);
  1341. assertEquals(CellType.BLANK, cell.getCellType(), "[Blank] C11 cell type");
  1342. // Error
  1343. col++;
  1344. cell = CellUtil.getCell(destRow1, col);
  1345. FormulaError error = FormulaError.forInt(cell.getErrorCellValue());
  1346. //FIXME: XSSFCell and HSSFCell expose different interfaces. getErrorCellString would be helpful here
  1347. assertEquals(CellType.ERROR, cell.getCellType(), "[Error] D10 cell type");
  1348. assertEquals(FormulaError.NA, error, "[Error] D10 cell value");
  1349. cell = CellUtil.getCell(destRow2, col);
  1350. error = FormulaError.forInt(cell.getErrorCellValue());
  1351. //FIXME: XSSFCell and HSSFCell expose different interfaces. getErrorCellString would be helpful here
  1352. assertEquals(CellType.ERROR, cell.getCellType(), "[Error] D11 cell type");
  1353. assertEquals(FormulaError.NAME, error, "[Error] D11 cell value");
  1354. // Date
  1355. col++;
  1356. cell = CellUtil.getCell(destRow1, col);
  1357. Date date = LocaleUtil.getLocaleCalendar(2000, Calendar.JANUARY, 1).getTime();
  1358. assertEquals(CellType.NUMERIC, cell.getCellType(), "[Date] E10 cell type");
  1359. assertEquals(date, cell.getDateCellValue(), "[Date] E10 cell value");
  1360. cell = CellUtil.getCell(destRow2, col);
  1361. date = LocaleUtil.getLocaleCalendar(2000, Calendar.JANUARY, 2).getTime();
  1362. assertEquals(CellType.NUMERIC, cell.getCellType(), "[Date] E11 cell type");
  1363. assertEquals(date, cell.getDateCellValue(), "[Date] E11 cell value");
  1364. // Boolean
  1365. col++;
  1366. cell = CellUtil.getCell(destRow1, col);
  1367. assertEquals(CellType.BOOLEAN, cell.getCellType(), "[Boolean] F10 cell type");
  1368. assertTrue(cell.getBooleanCellValue(), "[Boolean] F10 cell value");
  1369. cell = CellUtil.getCell(destRow2, col);
  1370. assertEquals(CellType.BOOLEAN, cell.getCellType(), "[Boolean] F11 cell type");
  1371. assertFalse(cell.getBooleanCellValue(), "[Boolean] F11 cell value");
  1372. // String
  1373. col++;
  1374. cell = CellUtil.getCell(destRow1, col);
  1375. assertEquals(CellType.STRING, cell.getCellType(), "[String] G10 cell type");
  1376. assertEquals("Hello", cell.getStringCellValue(), "[String] G10 cell value");
  1377. cell = CellUtil.getCell(destRow2, col);
  1378. assertEquals(CellType.STRING, cell.getCellType(), "[String] G11 cell type");
  1379. assertEquals("World", cell.getStringCellValue(), "[String] G11 cell value");
  1380. // Int
  1381. col++;
  1382. cell = CellUtil.getCell(destRow1, col);
  1383. assertEquals(CellType.NUMERIC, cell.getCellType(), "[Int] H10 cell type");
  1384. assertEquals(15, (int) cell.getNumericCellValue(), "[Int] H10 cell value");
  1385. cell = CellUtil.getCell(destRow2, col);
  1386. assertEquals(CellType.NUMERIC, cell.getCellType(), "[Int] H11 cell type");
  1387. assertEquals(42, (int) cell.getNumericCellValue(), "[Int] H11 cell value");
  1388. // Float
  1389. col++;
  1390. cell = CellUtil.getCell(destRow1, col);
  1391. assertEquals(CellType.NUMERIC, cell.getCellType(), "[Float] I10 cell type");
  1392. assertEquals(12.5, cell.getNumericCellValue(), FLOAT_PRECISION, "[Float] I10 cell value");
  1393. cell = CellUtil.getCell(destRow2, col);
  1394. assertEquals(CellType.NUMERIC, cell.getCellType(), "[Float] I11 cell type");
  1395. assertEquals(5.5, cell.getNumericCellValue(), FLOAT_PRECISION, "[Float] I11 cell value");
  1396. // Cell Formula
  1397. col++;
  1398. cell = CellUtil.getCell(destRow1, col);
  1399. assertEquals(CellType.FORMULA, cell.getCellType(), "[Cell Formula] J10 cell type");
  1400. assertEquals("5+2", cell.getCellFormula(), "[Cell Formula] J10 cell formula");
  1401. cell = CellUtil.getCell(destRow2, col);
  1402. assertEquals(CellType.FORMULA, cell.getCellType(), "[Cell Formula] J11 cell type");
  1403. assertEquals("6+18", cell.getCellFormula(), "[Cell Formula] J11 cell formula");
  1404. // Cell Formula with Reference
  1405. col++;
  1406. // Formula row references should be adjusted by destRowNum-srcRowNum
  1407. cell = CellUtil.getCell(destRow1, col);
  1408. assertEquals(CellType.FORMULA, cell.getCellType(), "[Cell Formula with Reference] K10 cell type");
  1409. assertEquals("J10+H$2", cell.getCellFormula(), "[Cell Formula with Reference] K10 cell formula");
  1410. cell = CellUtil.getCell(destRow2, col);
  1411. assertEquals(CellType.FORMULA, cell.getCellType(), "[Cell Formula with Reference] K11 cell type");
  1412. assertEquals("J11+H$2", cell.getCellFormula(), "[Cell Formula with Reference] K11 cell formula");
  1413. // Cell Formula with Reference spanning multiple rows
  1414. col++;
  1415. cell = CellUtil.getCell(destRow1, col);
  1416. assertEquals(CellType.FORMULA, cell.getCellType(), "[Cell Formula with Reference spanning multiple rows] L10 cell type");
  1417. assertEquals("G10&\" \"&G11", cell.getCellFormula(), "[Cell Formula with Reference spanning multiple rows] L10 cell formula");
  1418. cell = CellUtil.getCell(destRow2, col);
  1419. assertEquals(CellType.FORMULA, cell.getCellType(), "[Cell Formula with Reference spanning multiple rows] L11 cell type");
  1420. assertEquals("G11&\" \"&G12", cell.getCellFormula(), "[Cell Formula with Reference spanning multiple rows] L11 cell formula");
  1421. // Cell Formula with Area Reference
  1422. col++;
  1423. cell = CellUtil.getCell(destRow1, col);
  1424. assertEquals(CellType.FORMULA, cell.getCellType(), "[Cell Formula with Area Reference] M10 cell type");
  1425. assertEquals("SUM(H10:I11)", cell.getCellFormula(), "[Cell Formula with Area Reference] M10 cell formula");
  1426. cell = CellUtil.getCell(destRow2, col);
  1427. // Also acceptable: SUM($H10:I$3), but this AreaReference isn't in ascending order
  1428. assertEquals(CellType.FORMULA, cell.getCellType(), "[Cell Formula with Area Reference] M11 cell type");
  1429. assertEquals("SUM($H$3:I10)", cell.getCellFormula(), "[Cell Formula with Area Reference] M11 cell formula");
  1430. // Array Formula
  1431. col++;
  1432. // cell = CellUtil.getCell(destRow1, col);
  1433. // Array formulas currently unsupported
  1434. // FIXME: Array Formula set with Sheet.setArrayFormula() instead of cell.setFormula()
  1435. // assertEquals(CellType.FORMULA, cell.getCellType(), "[Array Formula] N10 cell type");
  1436. // assertEquals("{SUM(H10:J10*{1,2,3})}", cell.getCellFormula(), "[Array Formula] N10 cell formula");
  1437. // cell = CellUtil.getCell(destRow2, col);
  1438. // FIXME: Array Formula set with Sheet.setArrayFormula() instead of cell.setFormula()
  1439. // assertEquals(CellType.FORMULA, cell.getCellType(). "[Array Formula] N11 cell type");
  1440. // assertEquals("{SUM(H11:J11*{1,2,3})}", cell.getCellFormula(). "[Array Formula] N11 cell formula");
  1441. // Data Format
  1442. col++;
  1443. cell = CellUtil.getCell(destRow2, col);
  1444. assertEquals(CellType.NUMERIC, cell.getCellType(), "[Data Format] O10 cell type");
  1445. assertEquals(100.20, cell.getNumericCellValue(), FLOAT_PRECISION, "[Data Format] O10 cell value");
  1446. final String moneyFormat = "\"$\"#,##0.00_);[Red]\\(\"$\"#,##0.00\\)";
  1447. assertEquals(moneyFormat, cell.getCellStyle().getDataFormatString(), "[Data Format] O10 cell data format");
  1448. // Merged
  1449. col++;
  1450. cell = CellUtil.getCell(destRow1, col);
  1451. assertEquals("Merged cells", cell.getStringCellValue(), "[Merged] P10:Q10 cell value");
  1452. assertTrue(sheet.getMergedRegions().contains(CellRangeAddress.valueOf("P10:Q10")), "[Merged] P10:Q10 merged region");
  1453. cell = CellUtil.getCell(destRow2, col);
  1454. assertEquals("Merged cells", cell.getStringCellValue(), "[Merged] P11:Q11 cell value");
  1455. assertTrue(sheet.getMergedRegions().contains(CellRangeAddress.valueOf("P11:Q11")), "[Merged] P11:Q11 merged region");
  1456. // Should Q10/Q11 be checked?
  1457. // Merged across multiple rows
  1458. // Microsoft Excel 2013 does not copy a merged region unless all rows of
  1459. // the source merged region are selected
  1460. // POI's behavior should match this behavior
  1461. col += 2;
  1462. cell = CellUtil.getCell(destRow1, col);
  1463. assertEquals("Merged cells across multiple rows", cell.getStringCellValue(), "[Merged across multiple rows] R10:S11 cell value");
  1464. assertTrue(sheet.getMergedRegions().contains(CellRangeAddress.valueOf("R10:S11")), "[Merged across multiple rows] R10:S11 merged region");
  1465. // Row 3 (zero-based) was empty, so Row 11 (zero-based) should be empty too.
  1466. if (srcRow3 == null) {
  1467. assertNull(destRow3, "Row 3 was empty, so Row 11 should be empty");
  1468. }
  1469. // Make sure other rows are blank (off-by-one errors)
  1470. assertNull(sheet.getRow(7), "Off-by-one lower edge case"); //one row above destHeaderRow
  1471. assertNull(sheet.getRow(12), "Off-by-one upper edge case"); //one row below destRow3
  1472. }
  1473. }
  1474. @Test
  1475. void testIgnoredErrors() throws IOException {
  1476. XSSFWorkbook workbook = new XSSFWorkbook();
  1477. XSSFSheet sheet = workbook.createSheet();
  1478. CellRangeAddress region = CellRangeAddress.valueOf("B2:D4");
  1479. sheet.addIgnoredErrors(region, IgnoredErrorType.NUMBER_STORED_AS_TEXT);
  1480. final CTIgnoredError ignoredError = sheet.getCTWorksheet().getIgnoredErrors().getIgnoredErrorArray(0);
  1481. assertEquals(1, ignoredError.getSqref().size());
  1482. assertEquals("B2:D4", ignoredError.getSqref().get(0));
  1483. assertTrue(ignoredError.getNumberStoredAsText());
  1484. Map<IgnoredErrorType, Set<CellRangeAddress>> ignoredErrors = sheet.getIgnoredErrors();
  1485. assertEquals(1, ignoredErrors.size());
  1486. assertEquals(1, ignoredErrors.get(IgnoredErrorType.NUMBER_STORED_AS_TEXT).size());
  1487. assertEquals("B2:D4", ignoredErrors.get(IgnoredErrorType.NUMBER_STORED_AS_TEXT).iterator().next().formatAsString());
  1488. workbook.close();
  1489. }
  1490. @Test
  1491. void testIgnoredErrorsMultipleTypes() throws IOException {
  1492. XSSFWorkbook workbook = new XSSFWorkbook();
  1493. XSSFSheet sheet = workbook.createSheet();
  1494. CellRangeAddress region = CellRangeAddress.valueOf("B2:D4");
  1495. sheet.addIgnoredErrors(region, IgnoredErrorType.FORMULA, IgnoredErrorType.EVALUATION_ERROR);
  1496. final CTIgnoredError ignoredError = sheet.getCTWorksheet().getIgnoredErrors().getIgnoredErrorArray(0);
  1497. assertEquals(1, ignoredError.getSqref().size());
  1498. assertEquals("B2:D4", ignoredError.getSqref().get(0));
  1499. assertFalse(ignoredError.getNumberStoredAsText());
  1500. assertTrue(ignoredError.getFormula());
  1501. assertTrue(ignoredError.getEvalError());
  1502. Map<IgnoredErrorType, Set<CellRangeAddress>> ignoredErrors = sheet.getIgnoredErrors();
  1503. assertEquals(2, ignoredErrors.size());
  1504. assertEquals(1, ignoredErrors.get(IgnoredErrorType.FORMULA).size());
  1505. assertEquals("B2:D4", ignoredErrors.get(IgnoredErrorType.FORMULA).iterator().next().formatAsString());
  1506. assertEquals(1, ignoredErrors.get(IgnoredErrorType.EVALUATION_ERROR).size());
  1507. assertEquals("B2:D4", ignoredErrors.get(IgnoredErrorType.EVALUATION_ERROR).iterator().next().formatAsString());
  1508. workbook.close();
  1509. }
  1510. @Test
  1511. void testIgnoredErrorsMultipleCalls() throws IOException {
  1512. XSSFWorkbook workbook = new XSSFWorkbook();
  1513. XSSFSheet sheet = workbook.createSheet();
  1514. CellRangeAddress region = CellRangeAddress.valueOf("B2:D4");
  1515. // Two calls means two elements, no clever collapsing just yet.
  1516. sheet.addIgnoredErrors(region, IgnoredErrorType.EVALUATION_ERROR);
  1517. sheet.addIgnoredErrors(region, IgnoredErrorType.FORMULA);
  1518. CTIgnoredError ignoredError = sheet.getCTWorksheet().getIgnoredErrors().getIgnoredErrorArray(0);
  1519. assertEquals(1, ignoredError.getSqref().size());
  1520. assertEquals("B2:D4", ignoredError.getSqref().get(0));
  1521. assertFalse(ignoredError.getFormula());
  1522. assertTrue(ignoredError.getEvalError());
  1523. ignoredError = sheet.getCTWorksheet().getIgnoredErrors().getIgnoredErrorArray(1);
  1524. assertEquals(1, ignoredError.getSqref().size());
  1525. assertEquals("B2:D4", ignoredError.getSqref().get(0));
  1526. assertTrue(ignoredError.getFormula());
  1527. assertFalse(ignoredError.getEvalError());
  1528. Map<IgnoredErrorType, Set<CellRangeAddress>> ignoredErrors = sheet.getIgnoredErrors();
  1529. assertEquals(2, ignoredErrors.size());
  1530. assertEquals(1, ignoredErrors.get(IgnoredErrorType.FORMULA).size());
  1531. assertEquals("B2:D4", ignoredErrors.get(IgnoredErrorType.FORMULA).iterator().next().formatAsString());
  1532. assertEquals(1, ignoredErrors.get(IgnoredErrorType.EVALUATION_ERROR).size());
  1533. assertEquals("B2:D4", ignoredErrors.get(IgnoredErrorType.EVALUATION_ERROR).iterator().next().formatAsString());
  1534. workbook.close();
  1535. }
  1536. @Test
  1537. void setTabColor() throws IOException {
  1538. try (XSSFWorkbook wb = new XSSFWorkbook()) {
  1539. XSSFSheet sh = wb.createSheet();
  1540. assertTrue(sh.getCTWorksheet().getSheetPr() == null || !sh.getCTWorksheet().getSheetPr().isSetTabColor());
  1541. sh.setTabColor(new XSSFColor(IndexedColors.RED, null));
  1542. assertTrue(sh.getCTWorksheet().getSheetPr().isSetTabColor());
  1543. assertEquals(IndexedColors.RED.index,
  1544. sh.getCTWorksheet().getSheetPr().getTabColor().getIndexed());
  1545. }
  1546. }
  1547. @Test
  1548. void getTabColor() throws IOException {
  1549. try (XSSFWorkbook wb = new XSSFWorkbook()) {
  1550. XSSFSheet sh = wb.createSheet();
  1551. assertTrue(sh.getCTWorksheet().getSheetPr() == null || !sh.getCTWorksheet().getSheetPr().isSetTabColor());
  1552. assertNull(sh.getTabColor());
  1553. sh.setTabColor(new XSSFColor(IndexedColors.RED, null));
  1554. XSSFColor expected = new XSSFColor(IndexedColors.RED, null);
  1555. assertEquals(expected, sh.getTabColor());
  1556. }
  1557. }
  1558. // Test using an existing workbook saved by Excel
  1559. @Test
  1560. void tabColor() throws IOException {
  1561. try (XSSFWorkbook wb = openSampleWorkbook("SheetTabColors.xlsx")) {
  1562. // non-colored sheets do not have a color
  1563. assertNull(wb.getSheet("default").getTabColor());
  1564. // test indexed-colored sheet
  1565. XSSFColor expected = new XSSFColor(IndexedColors.RED, null);
  1566. assertEquals(expected, wb.getSheet("indexedRed").getTabColor());
  1567. // test regular-colored (non-indexed, ARGB) sheet
  1568. expected = XSSFColor.from(CTColor.Factory.newInstance(), wb.getStylesSource().getIndexedColors());
  1569. assertNotNull(expected);
  1570. expected.setARGBHex("FF7F2700");
  1571. assertEquals(expected, wb.getSheet("customOrange").getTabColor());
  1572. }
  1573. }
  1574. /**
  1575. * See bug #52425
  1576. */
  1577. @Test
  1578. void testInsertCommentsToClonedSheet() throws IOException {
  1579. try (Workbook wb = XSSFTestDataSamples.openSampleWorkbook("52425.xlsx")) {
  1580. CreationHelper helper = wb.getCreationHelper();
  1581. Sheet sheet2 = wb.createSheet("Sheet 2");
  1582. Sheet sheet3 = wb.cloneSheet(0);
  1583. wb.setSheetName(2, "Sheet 3");
  1584. Sheet[] sheets = { sheet2, sheet3 };
  1585. for (Sheet sheet : sheets) {
  1586. Drawing<?> drawing = sheet.createDrawingPatriarch();
  1587. for (int i = 0; i < 2; i++) {
  1588. ClientAnchor anchor = helper.createClientAnchor();
  1589. anchor.setCol1(0);
  1590. anchor.setRow1(i);
  1591. anchor.setCol2(2);
  1592. anchor.setRow2(3 + i);
  1593. Comment comment = drawing.createCellComment(anchor);
  1594. comment.setString(helper.createRichTextString("BugTesting"));
  1595. Row row = sheet.getRow(i);
  1596. if (row == null) {
  1597. row = sheet.createRow(i);
  1598. }
  1599. Cell cell = row.getCell(0);
  1600. if (cell == null) {
  1601. cell = row.createCell(0);
  1602. }
  1603. cell.setCellComment(comment);
  1604. }
  1605. }
  1606. for (Sheet sheet : sheets) {
  1607. for (int i = 0; i < 2; i++) {
  1608. CellAddress ref = new CellAddress(i, 0);
  1609. Comment c = sheet.getCellComment(ref);
  1610. assertNotNull(c);
  1611. assertEquals("BugTesting", c.getString().getString());
  1612. }
  1613. }
  1614. }
  1615. }
  1616. // bug 59687: XSSFSheet.RemoveRow doesn't handle row gaps properly when removing row comments
  1617. @Test
  1618. void testRemoveRowWithCommentAndGapAbove() throws IOException {
  1619. try (Workbook wb = _testDataProvider.openSampleWorkbook("59687.xlsx")) {
  1620. final Sheet sheet = wb.getSheetAt(0);
  1621. // comment exists
  1622. CellAddress commentCellAddress = new CellAddress("A4");
  1623. assertNotNull(sheet.getCellComment(commentCellAddress));
  1624. assertEquals(1, sheet.getCellComments().size(), "Wrong starting # of comments");
  1625. sheet.removeRow(sheet.getRow(commentCellAddress.getRow()));
  1626. assertEquals(0, sheet.getCellComments().size(), "There should not be any comments left!");
  1627. }
  1628. }
  1629. @Test
  1630. void testGetHeaderFooterProperties() throws IOException {
  1631. try (XSSFWorkbook wb = new XSSFWorkbook()) {
  1632. XSSFSheet sh = wb.createSheet();
  1633. XSSFHeaderFooterProperties hfProp = sh.getHeaderFooterProperties();
  1634. assertNotNull(hfProp);
  1635. }
  1636. }
  1637. @Test
  1638. void testSheetForceFormulaRecalculationDefaultValues() throws IOException {
  1639. try (Workbook wb = _testDataProvider.openSampleWorkbook("sample.xlsx")){
  1640. for (Sheet s : wb) {
  1641. assertEquals(wb.getForceFormulaRecalculation(),s.getForceFormulaRecalculation());
  1642. }
  1643. }
  1644. }
  1645. @Test
  1646. void testWorkbookSetForceFormulaRecalculation() throws IOException {
  1647. try (Workbook wb = _testDataProvider.openSampleWorkbook("sample.xlsx")){
  1648. wb.setForceFormulaRecalculation(true);
  1649. assertTrue(wb.getForceFormulaRecalculation());
  1650. }
  1651. }
  1652. @Test
  1653. void testNotCascadeWorkbookSetForceFormulaRecalculation() throws IOException {
  1654. try (Workbook wb = _testDataProvider.openSampleWorkbook("sample.xlsx")) {
  1655. // set all sheets to force recalculation
  1656. for (Sheet s : wb) {
  1657. s.setForceFormulaRecalculation(true);
  1658. assertTrue(s.getForceFormulaRecalculation());
  1659. }
  1660. // disable on workbook-level
  1661. wb.setForceFormulaRecalculation(false);
  1662. // on sheet-level, the flag is still set
  1663. for (Sheet s : wb) {
  1664. assertTrue(s.getForceFormulaRecalculation(), "Sheet-level flag is still set to true");
  1665. }
  1666. }
  1667. }
  1668. @Test
  1669. public void bug65120() throws IOException {
  1670. try (XSSFWorkbook wb = new XSSFWorkbook()) {
  1671. XSSFCreationHelper creationHelper = wb.getCreationHelper();
  1672. XSSFSheet sheet1 = wb.createSheet();
  1673. Cell cell1 = sheet1.createRow(0).createCell(0);
  1674. XSSFDrawing dwg1 = sheet1.createDrawingPatriarch();
  1675. XSSFComment comment1 = dwg1.createCellComment(creationHelper.createClientAnchor());
  1676. cell1.setCellComment(comment1);
  1677. XSSFVMLDrawing vml0 = sheet1.getVMLDrawing(false);
  1678. assertEquals("/xl/drawings/vmlDrawing0.vml", vml0.getPackagePart().getPartName().getName());
  1679. XSSFSheet sheet2 = wb.createSheet();
  1680. Cell cell2 = sheet2.createRow(0).createCell(0);
  1681. XSSFDrawing dwg2 = sheet2.createDrawingPatriarch();
  1682. Comment comment2 = dwg2.createCellComment(creationHelper.createClientAnchor());
  1683. cell2.setCellComment(comment2);
  1684. XSSFVMLDrawing vml1 = sheet2.getVMLDrawing(false);
  1685. assertEquals("/xl/drawings/vmlDrawing1.vml", vml1.getPackagePart().getPartName().getName());
  1686. wb.removeSheetAt(0);
  1687. XSSFSheet sheet3 = wb.createSheet();
  1688. Cell cell3 = sheet3.createRow(0).createCell(0);
  1689. XSSFDrawing dwg3 = sheet3.createDrawingPatriarch();
  1690. Comment comment3 = dwg3.createCellComment(creationHelper.createClientAnchor());
  1691. cell3.setCellComment(comment3);
  1692. XSSFVMLDrawing vml2 = sheet3.getVMLDrawing(false);
  1693. assertEquals("/xl/drawings/vmlDrawing2.vml", vml2.getPackagePart().getPartName().getName());
  1694. }
  1695. }
  1696. }