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

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