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

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