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 88KB

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