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

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