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

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884
  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 org.apache.poi.ss.usermodel.BaseTestSheet;
  17. import org.apache.poi.ss.usermodel.Cell;
  18. import org.apache.poi.ss.usermodel.Workbook;
  19. import org.apache.poi.ss.util.CellRangeAddress;
  20. import org.apache.poi.xssf.XSSFITestDataProvider;
  21. import org.apache.poi.xssf.XSSFTestDataSamples;
  22. import org.apache.poi.xssf.model.CommentsTable;
  23. import org.apache.poi.xssf.model.StylesTable;
  24. import org.apache.poi.xssf.usermodel.helpers.ColumnHelper;
  25. import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCol;
  26. import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCols;
  27. import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComments;
  28. import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTRow;
  29. import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTWorksheet;
  30. import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTXf;
  31. import org.openxmlformats.schemas.spreadsheetml.x2006.main.STPane;
  32. public class TestXSSFSheet extends BaseTestSheet {
  33. @Override
  34. protected XSSFITestDataProvider getTestDataProvider() {
  35. return XSSFITestDataProvider.getInstance();
  36. }
  37. //TODO column styles are not yet supported by XSSF
  38. public void testDefaultColumnStyle() {
  39. //super.testDefaultColumnStyle();
  40. }
  41. public void testTestGetSetMargin() {
  42. baseTestGetSetMargin(new double[]{0.7, 0.7, 0.75, 0.75, 0.3, 0.3});
  43. }
  44. public void testExistingHeaderFooter() {
  45. XSSFWorkbook workbook = XSSFTestDataSamples.openSampleWorkbook("45540_classic_Header.xlsx");
  46. XSSFOddHeader hdr;
  47. XSSFOddFooter ftr;
  48. // Sheet 1 has a header with center and right text
  49. XSSFSheet s1 = workbook.getSheetAt(0);
  50. assertNotNull(s1.getHeader());
  51. assertNotNull(s1.getFooter());
  52. hdr = (XSSFOddHeader) s1.getHeader();
  53. ftr = (XSSFOddFooter) s1.getFooter();
  54. assertEquals("&Ctestdoc&Rtest phrase", hdr.getText());
  55. assertEquals(null, ftr.getText());
  56. assertEquals("", hdr.getLeft());
  57. assertEquals("testdoc", hdr.getCenter());
  58. assertEquals("test phrase", hdr.getRight());
  59. assertEquals("", ftr.getLeft());
  60. assertEquals("", ftr.getCenter());
  61. assertEquals("", ftr.getRight());
  62. // Sheet 2 has a footer, but it's empty
  63. XSSFSheet s2 = workbook.getSheetAt(1);
  64. assertNotNull(s2.getHeader());
  65. assertNotNull(s2.getFooter());
  66. hdr = (XSSFOddHeader) s2.getHeader();
  67. ftr = (XSSFOddFooter) s2.getFooter();
  68. assertEquals(null, hdr.getText());
  69. assertEquals("&L&F", ftr.getText());
  70. assertEquals("", hdr.getLeft());
  71. assertEquals("", hdr.getCenter());
  72. assertEquals("", hdr.getRight());
  73. assertEquals("&F", ftr.getLeft());
  74. assertEquals("", ftr.getCenter());
  75. assertEquals("", ftr.getRight());
  76. // Save and reload
  77. XSSFWorkbook wb = XSSFTestDataSamples.writeOutAndReadBack(workbook);
  78. hdr = (XSSFOddHeader) wb.getSheetAt(0).getHeader();
  79. ftr = (XSSFOddFooter) wb.getSheetAt(0).getFooter();
  80. assertEquals("", hdr.getLeft());
  81. assertEquals("testdoc", hdr.getCenter());
  82. assertEquals("test phrase", hdr.getRight());
  83. assertEquals("", ftr.getLeft());
  84. assertEquals("", ftr.getCenter());
  85. assertEquals("", ftr.getRight());
  86. }
  87. public void testGetAllHeadersFooters() {
  88. XSSFWorkbook workbook = getTestDataProvider().createWorkbook();
  89. XSSFSheet sheet = workbook.createSheet("Sheet 1");
  90. assertNotNull(sheet.getOddFooter());
  91. assertNotNull(sheet.getEvenFooter());
  92. assertNotNull(sheet.getFirstFooter());
  93. assertNotNull(sheet.getOddHeader());
  94. assertNotNull(sheet.getEvenHeader());
  95. assertNotNull(sheet.getFirstHeader());
  96. assertEquals("", sheet.getOddFooter().getLeft());
  97. sheet.getOddFooter().setLeft("odd footer left");
  98. assertEquals("odd footer left", sheet.getOddFooter().getLeft());
  99. assertEquals("", sheet.getEvenFooter().getLeft());
  100. sheet.getEvenFooter().setLeft("even footer left");
  101. assertEquals("even footer left", sheet.getEvenFooter().getLeft());
  102. assertEquals("", sheet.getFirstFooter().getLeft());
  103. sheet.getFirstFooter().setLeft("first footer left");
  104. assertEquals("first footer left", sheet.getFirstFooter().getLeft());
  105. assertEquals("", sheet.getOddHeader().getLeft());
  106. sheet.getOddHeader().setLeft("odd header left");
  107. assertEquals("odd header left", sheet.getOddHeader().getLeft());
  108. assertEquals("", sheet.getOddHeader().getRight());
  109. sheet.getOddHeader().setRight("odd header right");
  110. assertEquals("odd header right", sheet.getOddHeader().getRight());
  111. assertEquals("", sheet.getOddHeader().getCenter());
  112. sheet.getOddHeader().setCenter("odd header center");
  113. assertEquals("odd header center", sheet.getOddHeader().getCenter());
  114. // Defaults are odd
  115. assertEquals("odd footer left", sheet.getFooter().getLeft());
  116. assertEquals("odd header center", sheet.getHeader().getCenter());
  117. }
  118. public void testAutoSizeColumn() {
  119. XSSFWorkbook workbook = new XSSFWorkbook();
  120. XSSFSheet sheet = workbook.createSheet("Sheet 1");
  121. sheet.createRow(0).createCell(13).setCellValue("test");
  122. sheet.autoSizeColumn(13);
  123. ColumnHelper columnHelper = sheet.getColumnHelper();
  124. CTCol col = columnHelper.getColumn(13, false);
  125. assertTrue(col.getBestFit());
  126. }
  127. public void testGetCellComment() {
  128. XSSFWorkbook workbook = new XSSFWorkbook();
  129. XSSFSheet sheet = workbook.createSheet();
  130. XSSFComment comment = sheet.createComment();
  131. comment.setAuthor("test C10 author");
  132. sheet.setCellComment("C10", comment);
  133. assertNotNull(sheet.getCellComment(9, 2));
  134. assertEquals("test C10 author", sheet.getCellComment(9, 2).getAuthor());
  135. }
  136. public void testSetCellComment() {
  137. XSSFWorkbook workbook = new XSSFWorkbook();
  138. XSSFSheet sheet = workbook.createSheet();
  139. XSSFComment comment = sheet.createComment();
  140. Cell cell = sheet.createRow(0).createCell((short) 0);
  141. CommentsTable comments = sheet.getCommentsTable(false);
  142. CTComments ctComments = comments.getCTComments();
  143. sheet.setCellComment("A1", comment);
  144. assertEquals("A1", ctComments.getCommentList().getCommentArray(0).getRef());
  145. comment.setAuthor("test A1 author");
  146. assertEquals("test A1 author", comments.getAuthor((int) ctComments.getCommentList().getCommentArray(0).getAuthorId()));
  147. }
  148. public void testGetActiveCell() {
  149. XSSFWorkbook workbook = new XSSFWorkbook();
  150. XSSFSheet sheet = workbook.createSheet();
  151. sheet.setActiveCell("R5");
  152. assertEquals("R5", sheet.getActiveCell());
  153. }
  154. public void testCreateFreezePane() {
  155. XSSFWorkbook workbook = new XSSFWorkbook();
  156. XSSFSheet sheet = workbook.createSheet();
  157. CTWorksheet ctWorksheet = sheet.getCTWorksheet();
  158. sheet.createFreezePane(2, 4);
  159. assertEquals(2.0, ctWorksheet.getSheetViews().getSheetViewArray(0).getPane().getXSplit(), 0.0);
  160. assertEquals(STPane.BOTTOM_RIGHT, ctWorksheet.getSheetViews().getSheetViewArray(0).getPane().getActivePane());
  161. sheet.createFreezePane(3, 6, 10, 10);
  162. assertEquals(3.0, ctWorksheet.getSheetViews().getSheetViewArray(0).getPane().getXSplit(), 0.0);
  163. // assertEquals(10, sheet.getTopRow());
  164. // assertEquals(10, sheet.getLeftCol());
  165. sheet.createSplitPane(4, 8, 12, 12, 1);
  166. assertEquals(8.0, ctWorksheet.getSheetViews().getSheetViewArray(0).getPane().getYSplit(), 0.0);
  167. assertEquals(STPane.BOTTOM_RIGHT, ctWorksheet.getSheetViews().getSheetViewArray(0).getPane().getActivePane());
  168. }
  169. public void testNewMergedRegionAt() {
  170. XSSFWorkbook workbook = new XSSFWorkbook();
  171. XSSFSheet sheet = workbook.createSheet();
  172. CellRangeAddress region = CellRangeAddress.valueOf("B2:D4");
  173. sheet.addMergedRegion(region);
  174. assertEquals("B2:D4", sheet.getMergedRegion(0).formatAsString());
  175. assertEquals(1, sheet.getNumMergedRegions());
  176. }
  177. public void testRemoveMergedRegion_lowlevel() {
  178. XSSFWorkbook workbook = new XSSFWorkbook();
  179. XSSFSheet sheet = workbook.createSheet();
  180. CTWorksheet ctWorksheet = sheet.getCTWorksheet();
  181. CellRangeAddress region_1 = CellRangeAddress.valueOf("A1:B2");
  182. CellRangeAddress region_2 = CellRangeAddress.valueOf("C3:D4");
  183. CellRangeAddress region_3 = CellRangeAddress.valueOf("E5:F6");
  184. sheet.addMergedRegion(region_1);
  185. sheet.addMergedRegion(region_2);
  186. sheet.addMergedRegion(region_3);
  187. assertEquals("C3:D4", ctWorksheet.getMergeCells().getMergeCellArray(1).getRef());
  188. assertEquals(3, sheet.getNumMergedRegions());
  189. sheet.removeMergedRegion(1);
  190. assertEquals("E5:F6", ctWorksheet.getMergeCells().getMergeCellArray(1).getRef());
  191. assertEquals(2, sheet.getNumMergedRegions());
  192. sheet.removeMergedRegion(1);
  193. sheet.removeMergedRegion(0);
  194. assertEquals(0, sheet.getNumMergedRegions());
  195. }
  196. public void testSetDefaultColumnStyle() {
  197. XSSFWorkbook workbook = new XSSFWorkbook();
  198. XSSFSheet sheet = workbook.createSheet();
  199. CTWorksheet ctWorksheet = sheet.getCTWorksheet();
  200. StylesTable stylesTable = workbook.getStylesSource();
  201. XSSFFont font = new XSSFFont();
  202. font.setFontName("Cambria");
  203. stylesTable.putFont(font);
  204. CTXf cellStyleXf = CTXf.Factory.newInstance();
  205. cellStyleXf.setFontId(1);
  206. cellStyleXf.setFillId(0);
  207. cellStyleXf.setBorderId(0);
  208. cellStyleXf.setNumFmtId(0);
  209. stylesTable.putCellStyleXf(cellStyleXf);
  210. CTXf cellXf = CTXf.Factory.newInstance();
  211. cellXf.setXfId(1);
  212. stylesTable.putCellXf(cellXf);
  213. XSSFCellStyle cellStyle = new XSSFCellStyle(1, 1, stylesTable);
  214. assertEquals(1, cellStyle.getFontIndex());
  215. sheet.setDefaultColumnStyle((short) 3, cellStyle);
  216. assertEquals(1, ctWorksheet.getColsArray(0).getColArray(0).getStyle());
  217. }
  218. public void testGroupUngroupColumn() {
  219. XSSFWorkbook workbook = new XSSFWorkbook();
  220. XSSFSheet sheet = workbook.createSheet();
  221. //one level
  222. sheet.groupColumn((short) 2, (short) 7);
  223. sheet.groupColumn((short) 10, (short) 11);
  224. CTCols cols = sheet.getCTWorksheet().getColsArray(0);
  225. assertEquals(2, cols.sizeOfColArray());
  226. CTCol[] colArray = cols.getColArray();
  227. assertNotNull(colArray);
  228. assertEquals(2 + 1, colArray[0].getMin()); // 1 based
  229. assertEquals(7 + 1, colArray[0].getMax()); // 1 based
  230. assertEquals(1, colArray[0].getOutlineLevel());
  231. //two level
  232. sheet.groupColumn((short) 1, (short) 2);
  233. cols = sheet.getCTWorksheet().getColsArray(0);
  234. assertEquals(4, cols.sizeOfColArray());
  235. colArray = cols.getColArray();
  236. assertEquals(2, colArray[1].getOutlineLevel());
  237. //three level
  238. sheet.groupColumn((short) 6, (short) 8);
  239. sheet.groupColumn((short) 2, (short) 3);
  240. cols = sheet.getCTWorksheet().getColsArray(0);
  241. assertEquals(7, cols.sizeOfColArray());
  242. colArray = cols.getColArray();
  243. assertEquals(3, colArray[1].getOutlineLevel());
  244. assertEquals(3, sheet.getCTWorksheet().getSheetFormatPr().getOutlineLevelCol());
  245. sheet.ungroupColumn((short) 8, (short) 10);
  246. colArray = cols.getColArray();
  247. //assertEquals(3, colArray[1].getOutlineLevel());
  248. sheet.ungroupColumn((short) 4, (short) 6);
  249. sheet.ungroupColumn((short) 2, (short) 2);
  250. colArray = cols.getColArray();
  251. assertEquals(4, colArray.length);
  252. assertEquals(2, sheet.getCTWorksheet().getSheetFormatPr().getOutlineLevelCol());
  253. }
  254. public void testGroupUngroupRow() {
  255. XSSFWorkbook workbook = new XSSFWorkbook();
  256. XSSFSheet sheet = workbook.createSheet();
  257. //one level
  258. sheet.groupRow(9, 10);
  259. assertEquals(2, sheet.getPhysicalNumberOfRows());
  260. CTRow ctrow = sheet.getRow(9).getCTRow();
  261. assertNotNull(ctrow);
  262. assertEquals(10, ctrow.getR());
  263. assertEquals(1, ctrow.getOutlineLevel());
  264. assertEquals(1, sheet.getCTWorksheet().getSheetFormatPr().getOutlineLevelRow());
  265. //two level
  266. sheet.groupRow(10, 13);
  267. assertEquals(5, sheet.getPhysicalNumberOfRows());
  268. ctrow = sheet.getRow(10).getCTRow();
  269. assertNotNull(ctrow);
  270. assertEquals(11, ctrow.getR());
  271. assertEquals(2, ctrow.getOutlineLevel());
  272. assertEquals(2, sheet.getCTWorksheet().getSheetFormatPr().getOutlineLevelRow());
  273. sheet.ungroupRow(8, 10);
  274. assertEquals(4, sheet.getPhysicalNumberOfRows());
  275. assertEquals(1, sheet.getCTWorksheet().getSheetFormatPr().getOutlineLevelRow());
  276. sheet.ungroupRow(10, 10);
  277. assertEquals(3, sheet.getPhysicalNumberOfRows());
  278. assertEquals(1, sheet.getCTWorksheet().getSheetFormatPr().getOutlineLevelRow());
  279. }
  280. public void testSetZoom() {
  281. XSSFWorkbook workBook = new XSSFWorkbook();
  282. XSSFSheet sheet1 = workBook.createSheet("new sheet");
  283. sheet1.setZoom(3, 4); // 75 percent magnification
  284. long zoom = sheet1.getCTWorksheet().getSheetViews().getSheetViewArray(0).getZoomScale();
  285. assertEquals(zoom, 75);
  286. sheet1.setZoom(200);
  287. zoom = sheet1.getCTWorksheet().getSheetViews().getSheetViewArray(0).getZoomScale();
  288. assertEquals(zoom, 200);
  289. try {
  290. sheet1.setZoom(500);
  291. fail("Expecting exception");
  292. } catch (IllegalArgumentException e) {
  293. assertEquals("Valid scale values range from 10 to 400", e.getMessage());
  294. }
  295. }
  296. /**
  297. * TODO - while this is internally consistent, I'm not
  298. * completely clear in all cases what it's supposed to
  299. * be doing... Someone who understands the goals a little
  300. * better should really review this!
  301. */
  302. public void testSetColumnGroupCollapsed(){
  303. Workbook wb = new XSSFWorkbook();
  304. XSSFSheet sheet1 =(XSSFSheet) wb.createSheet();
  305. CTCols cols=sheet1.getCTWorksheet().getColsArray(0);
  306. assertEquals(0,cols.sizeOfColArray());
  307. sheet1.groupColumn( (short)4, (short)7 );
  308. sheet1.groupColumn( (short)9, (short)12 );
  309. assertEquals(2,cols.sizeOfColArray());
  310. assertEquals(false,cols.getColArray(0).isSetHidden());
  311. assertEquals(true, cols.getColArray(0).isSetCollapsed());
  312. assertEquals(5, cols.getColArray(0).getMin()); // 1 based
  313. assertEquals(8, cols.getColArray(0).getMax()); // 1 based
  314. assertEquals(false,cols.getColArray(1).isSetHidden());
  315. assertEquals(true, cols.getColArray(1).isSetCollapsed());
  316. assertEquals(10, cols.getColArray(1).getMin()); // 1 based
  317. assertEquals(13, cols.getColArray(1).getMax()); // 1 based
  318. sheet1.groupColumn( (short)10, (short)11 );
  319. assertEquals(4,cols.sizeOfColArray());
  320. assertEquals(false,cols.getColArray(0).isSetHidden());
  321. assertEquals(true, cols.getColArray(0).isSetCollapsed());
  322. assertEquals(5, cols.getColArray(0).getMin()); // 1 based
  323. assertEquals(8, cols.getColArray(0).getMax()); // 1 based
  324. assertEquals(false,cols.getColArray(1).isSetHidden());
  325. assertEquals(true, cols.getColArray(1).isSetCollapsed());
  326. assertEquals(10, cols.getColArray(1).getMin()); // 1 based
  327. assertEquals(10, cols.getColArray(1).getMax()); // 1 based
  328. assertEquals(false,cols.getColArray(2).isSetHidden());
  329. assertEquals(true, cols.getColArray(2).isSetCollapsed());
  330. assertEquals(11, cols.getColArray(2).getMin()); // 1 based
  331. assertEquals(12, cols.getColArray(2).getMax()); // 1 based
  332. assertEquals(false,cols.getColArray(3).isSetHidden());
  333. assertEquals(true, cols.getColArray(3).isSetCollapsed());
  334. assertEquals(13, cols.getColArray(3).getMin()); // 1 based
  335. assertEquals(13, cols.getColArray(3).getMax()); // 1 based
  336. // collapse columns - 1
  337. sheet1.setColumnGroupCollapsed( (short)5, true );
  338. assertEquals(5,cols.sizeOfColArray());
  339. assertEquals(true, cols.getColArray(0).isSetHidden());
  340. assertEquals(true, cols.getColArray(0).isSetCollapsed());
  341. assertEquals(5, cols.getColArray(0).getMin()); // 1 based
  342. assertEquals(8, cols.getColArray(0).getMax()); // 1 based
  343. assertEquals(false,cols.getColArray(1).isSetHidden());
  344. assertEquals(true, cols.getColArray(1).isSetCollapsed());
  345. assertEquals(9, cols.getColArray(1).getMin()); // 1 based
  346. assertEquals(9, cols.getColArray(1).getMax()); // 1 based
  347. assertEquals(false,cols.getColArray(2).isSetHidden());
  348. assertEquals(true, cols.getColArray(2).isSetCollapsed());
  349. assertEquals(10, cols.getColArray(2).getMin()); // 1 based
  350. assertEquals(10, cols.getColArray(2).getMax()); // 1 based
  351. assertEquals(false,cols.getColArray(3).isSetHidden());
  352. assertEquals(true, cols.getColArray(3).isSetCollapsed());
  353. assertEquals(11, cols.getColArray(3).getMin()); // 1 based
  354. assertEquals(12, cols.getColArray(3).getMax()); // 1 based
  355. assertEquals(false,cols.getColArray(4).isSetHidden());
  356. assertEquals(true, cols.getColArray(4).isSetCollapsed());
  357. assertEquals(13, cols.getColArray(4).getMin()); // 1 based
  358. assertEquals(13, cols.getColArray(4).getMax()); // 1 based
  359. // expand columns - 1
  360. sheet1.setColumnGroupCollapsed( (short)5, false );
  361. assertEquals(false,cols.getColArray(0).isSetHidden());
  362. assertEquals(true, cols.getColArray(0).isSetCollapsed());
  363. assertEquals(5, cols.getColArray(0).getMin()); // 1 based
  364. assertEquals(8, cols.getColArray(0).getMax()); // 1 based
  365. assertEquals(false,cols.getColArray(1).isSetHidden());
  366. assertEquals(false,cols.getColArray(1).isSetCollapsed());
  367. assertEquals(9, cols.getColArray(1).getMin()); // 1 based
  368. assertEquals(9, cols.getColArray(1).getMax()); // 1 based
  369. assertEquals(false,cols.getColArray(2).isSetHidden());
  370. assertEquals(true, cols.getColArray(2).isSetCollapsed());
  371. assertEquals(10, cols.getColArray(2).getMin()); // 1 based
  372. assertEquals(10, cols.getColArray(2).getMax()); // 1 based
  373. assertEquals(false,cols.getColArray(3).isSetHidden());
  374. assertEquals(true, cols.getColArray(3).isSetCollapsed());
  375. assertEquals(11, cols.getColArray(3).getMin()); // 1 based
  376. assertEquals(12, cols.getColArray(3).getMax()); // 1 based
  377. assertEquals(false,cols.getColArray(4).isSetHidden());
  378. assertEquals(true, cols.getColArray(4).isSetCollapsed());
  379. assertEquals(13, cols.getColArray(4).getMin()); // 1 based
  380. assertEquals(13, cols.getColArray(4).getMax()); // 1 based
  381. //collapse - 2
  382. sheet1.setColumnGroupCollapsed( (short)9, true );
  383. assertEquals(6,cols.sizeOfColArray());
  384. assertEquals(false,cols.getColArray(0).isSetHidden());
  385. assertEquals(true, cols.getColArray(0).isSetCollapsed());
  386. assertEquals(5, cols.getColArray(0).getMin()); // 1 based
  387. assertEquals(8, cols.getColArray(0).getMax()); // 1 based
  388. assertEquals(false,cols.getColArray(1).isSetHidden());
  389. assertEquals(false,cols.getColArray(1).isSetCollapsed());
  390. assertEquals(9, cols.getColArray(1).getMin()); // 1 based
  391. assertEquals(9, cols.getColArray(1).getMax()); // 1 based
  392. assertEquals(true, cols.getColArray(2).isSetHidden());
  393. assertEquals(true, cols.getColArray(2).isSetCollapsed());
  394. assertEquals(10, cols.getColArray(2).getMin()); // 1 based
  395. assertEquals(10, cols.getColArray(2).getMax()); // 1 based
  396. assertEquals(true, cols.getColArray(3).isSetHidden());
  397. assertEquals(true, cols.getColArray(3).isSetCollapsed());
  398. assertEquals(11, cols.getColArray(3).getMin()); // 1 based
  399. assertEquals(12, cols.getColArray(3).getMax()); // 1 based
  400. assertEquals(true, cols.getColArray(4).isSetHidden());
  401. assertEquals(true, cols.getColArray(4).isSetCollapsed());
  402. assertEquals(13, cols.getColArray(4).getMin()); // 1 based
  403. assertEquals(13, cols.getColArray(4).getMax()); // 1 based
  404. assertEquals(false,cols.getColArray(5).isSetHidden());
  405. assertEquals(true, cols.getColArray(5).isSetCollapsed());
  406. assertEquals(14, cols.getColArray(5).getMin()); // 1 based
  407. assertEquals(14, cols.getColArray(5).getMax()); // 1 based
  408. //expand - 2
  409. sheet1.setColumnGroupCollapsed( (short)9, false );
  410. assertEquals(6,cols.sizeOfColArray());
  411. assertEquals(14,cols.getColArray(5).getMin());
  412. //outline level 2: the line under ==> collapsed==True
  413. assertEquals(2,cols.getColArray(3).getOutlineLevel());
  414. assertEquals(true,cols.getColArray(4).isSetCollapsed());
  415. assertEquals(false,cols.getColArray(0).isSetHidden());
  416. assertEquals(true, cols.getColArray(0).isSetCollapsed());
  417. assertEquals(5, cols.getColArray(0).getMin()); // 1 based
  418. assertEquals(8, cols.getColArray(0).getMax()); // 1 based
  419. assertEquals(false,cols.getColArray(1).isSetHidden());
  420. assertEquals(false,cols.getColArray(1).isSetCollapsed());
  421. assertEquals(9, cols.getColArray(1).getMin()); // 1 based
  422. assertEquals(9, cols.getColArray(1).getMax()); // 1 based
  423. assertEquals(false,cols.getColArray(2).isSetHidden());
  424. assertEquals(true, cols.getColArray(2).isSetCollapsed());
  425. assertEquals(10, cols.getColArray(2).getMin()); // 1 based
  426. assertEquals(10, cols.getColArray(2).getMax()); // 1 based
  427. assertEquals(true, cols.getColArray(3).isSetHidden());
  428. assertEquals(true, cols.getColArray(3).isSetCollapsed());
  429. assertEquals(11, cols.getColArray(3).getMin()); // 1 based
  430. assertEquals(12, cols.getColArray(3).getMax()); // 1 based
  431. assertEquals(false,cols.getColArray(4).isSetHidden());
  432. assertEquals(true, cols.getColArray(4).isSetCollapsed());
  433. assertEquals(13, cols.getColArray(4).getMin()); // 1 based
  434. assertEquals(13, cols.getColArray(4).getMax()); // 1 based
  435. assertEquals(false,cols.getColArray(5).isSetHidden());
  436. assertEquals(false,cols.getColArray(5).isSetCollapsed());
  437. assertEquals(14, cols.getColArray(5).getMin()); // 1 based
  438. assertEquals(14, cols.getColArray(5).getMax()); // 1 based
  439. //DOCUMENTARE MEGLIO IL DISCORSO DEL LIVELLO
  440. //collapse - 3
  441. sheet1.setColumnGroupCollapsed( (short)10, true );
  442. assertEquals(6,cols.sizeOfColArray());
  443. assertEquals(false,cols.getColArray(0).isSetHidden());
  444. assertEquals(true, cols.getColArray(0).isSetCollapsed());
  445. assertEquals(5, cols.getColArray(0).getMin()); // 1 based
  446. assertEquals(8, cols.getColArray(0).getMax()); // 1 based
  447. assertEquals(false,cols.getColArray(1).isSetHidden());
  448. assertEquals(false,cols.getColArray(1).isSetCollapsed());
  449. assertEquals(9, cols.getColArray(1).getMin()); // 1 based
  450. assertEquals(9, cols.getColArray(1).getMax()); // 1 based
  451. assertEquals(false,cols.getColArray(2).isSetHidden());
  452. assertEquals(true, cols.getColArray(2).isSetCollapsed());
  453. assertEquals(10, cols.getColArray(2).getMin()); // 1 based
  454. assertEquals(10, cols.getColArray(2).getMax()); // 1 based
  455. assertEquals(true, cols.getColArray(3).isSetHidden());
  456. assertEquals(true, cols.getColArray(3).isSetCollapsed());
  457. assertEquals(11, cols.getColArray(3).getMin()); // 1 based
  458. assertEquals(12, cols.getColArray(3).getMax()); // 1 based
  459. assertEquals(false,cols.getColArray(4).isSetHidden());
  460. assertEquals(true, cols.getColArray(4).isSetCollapsed());
  461. assertEquals(13, cols.getColArray(4).getMin()); // 1 based
  462. assertEquals(13, cols.getColArray(4).getMax()); // 1 based
  463. assertEquals(false,cols.getColArray(5).isSetHidden());
  464. assertEquals(false,cols.getColArray(5).isSetCollapsed());
  465. assertEquals(14, cols.getColArray(5).getMin()); // 1 based
  466. assertEquals(14, cols.getColArray(5).getMax()); // 1 based
  467. //expand - 3
  468. sheet1.setColumnGroupCollapsed( (short)10, false );
  469. assertEquals(6,cols.sizeOfColArray());
  470. assertEquals(false,cols.getColArray(0).getHidden());
  471. assertEquals(false,cols.getColArray(5).getHidden());
  472. assertEquals(false,cols.getColArray(4).isSetCollapsed());
  473. // write out and give back
  474. // Save and re-load
  475. wb = XSSFTestDataSamples.writeOutAndReadBack(wb);
  476. sheet1 = (XSSFSheet)wb.getSheetAt(0);
  477. assertEquals(6,cols.sizeOfColArray());
  478. assertEquals(false,cols.getColArray(0).isSetHidden());
  479. assertEquals(true, cols.getColArray(0).isSetCollapsed());
  480. assertEquals(5, cols.getColArray(0).getMin()); // 1 based
  481. assertEquals(8, cols.getColArray(0).getMax()); // 1 based
  482. assertEquals(false,cols.getColArray(1).isSetHidden());
  483. assertEquals(false,cols.getColArray(1).isSetCollapsed());
  484. assertEquals(9, cols.getColArray(1).getMin()); // 1 based
  485. assertEquals(9, cols.getColArray(1).getMax()); // 1 based
  486. assertEquals(false,cols.getColArray(2).isSetHidden());
  487. assertEquals(true, cols.getColArray(2).isSetCollapsed());
  488. assertEquals(10, cols.getColArray(2).getMin()); // 1 based
  489. assertEquals(10, cols.getColArray(2).getMax()); // 1 based
  490. assertEquals(false,cols.getColArray(3).isSetHidden());
  491. assertEquals(true, cols.getColArray(3).isSetCollapsed());
  492. assertEquals(11, cols.getColArray(3).getMin()); // 1 based
  493. assertEquals(12, cols.getColArray(3).getMax()); // 1 based
  494. assertEquals(false,cols.getColArray(4).isSetHidden());
  495. assertEquals(false,cols.getColArray(4).isSetCollapsed());
  496. assertEquals(13, cols.getColArray(4).getMin()); // 1 based
  497. assertEquals(13, cols.getColArray(4).getMax()); // 1 based
  498. assertEquals(false,cols.getColArray(5).isSetHidden());
  499. assertEquals(false,cols.getColArray(5).isSetCollapsed());
  500. assertEquals(14, cols.getColArray(5).getMin()); // 1 based
  501. assertEquals(14, cols.getColArray(5).getMax()); // 1 based
  502. }
  503. /**
  504. * TODO - while this is internally consistent, I'm not
  505. * completely clear in all cases what it's supposed to
  506. * be doing... Someone who understands the goals a little
  507. * better should really review this!
  508. */
  509. public void testSetRowGroupCollapsed(){
  510. Workbook wb = new XSSFWorkbook();
  511. XSSFSheet sheet1 = (XSSFSheet)wb.createSheet();
  512. sheet1.groupRow( 5, 14 );
  513. sheet1.groupRow( 7, 14 );
  514. sheet1.groupRow( 16, 19 );
  515. assertEquals(14,sheet1.getPhysicalNumberOfRows());
  516. assertEquals(false,sheet1.getRow(6).getCTRow().isSetCollapsed());
  517. assertEquals(false,sheet1.getRow(6).getCTRow().isSetHidden());
  518. assertEquals(false,sheet1.getRow(7).getCTRow().isSetCollapsed());
  519. assertEquals(false,sheet1.getRow(7).getCTRow().isSetHidden());
  520. assertEquals(false,sheet1.getRow(9).getCTRow().isSetCollapsed());
  521. assertEquals(false,sheet1.getRow(9).getCTRow().isSetHidden());
  522. assertEquals(false,sheet1.getRow(14).getCTRow().isSetCollapsed());
  523. assertEquals(false,sheet1.getRow(14).getCTRow().isSetHidden());
  524. assertEquals(false,sheet1.getRow(16).getCTRow().isSetCollapsed());
  525. assertEquals(false,sheet1.getRow(16).getCTRow().isSetHidden());
  526. assertEquals(false,sheet1.getRow(18).getCTRow().isSetCollapsed());
  527. assertEquals(false,sheet1.getRow(18).getCTRow().isSetHidden());
  528. //collapsed
  529. sheet1.setRowGroupCollapsed( 7, true );
  530. assertEquals(false,sheet1.getRow(6).getCTRow().isSetCollapsed());
  531. assertEquals(false,sheet1.getRow(6).getCTRow().isSetHidden());
  532. assertEquals(false,sheet1.getRow(7).getCTRow().isSetCollapsed());
  533. assertEquals(true, sheet1.getRow(7).getCTRow().isSetHidden());
  534. assertEquals(false,sheet1.getRow(9).getCTRow().isSetCollapsed());
  535. assertEquals(true, sheet1.getRow(9).getCTRow().isSetHidden());
  536. assertEquals(false,sheet1.getRow(14).getCTRow().isSetCollapsed());
  537. assertEquals(true, sheet1.getRow(14).getCTRow().isSetHidden());
  538. assertEquals(false,sheet1.getRow(16).getCTRow().isSetCollapsed());
  539. assertEquals(false,sheet1.getRow(16).getCTRow().isSetHidden());
  540. assertEquals(false,sheet1.getRow(18).getCTRow().isSetCollapsed());
  541. assertEquals(false,sheet1.getRow(18).getCTRow().isSetHidden());
  542. //expanded
  543. sheet1.setRowGroupCollapsed( 7, false );
  544. assertEquals(false,sheet1.getRow(6).getCTRow().isSetCollapsed());
  545. assertEquals(false,sheet1.getRow(6).getCTRow().isSetHidden());
  546. assertEquals(false,sheet1.getRow(7).getCTRow().isSetCollapsed());
  547. assertEquals(true, sheet1.getRow(7).getCTRow().isSetHidden());
  548. assertEquals(false,sheet1.getRow(9).getCTRow().isSetCollapsed());
  549. assertEquals(true, sheet1.getRow(9).getCTRow().isSetHidden());
  550. assertEquals(false,sheet1.getRow(14).getCTRow().isSetCollapsed());
  551. assertEquals(true, sheet1.getRow(14).getCTRow().isSetHidden());
  552. assertEquals(false,sheet1.getRow(16).getCTRow().isSetCollapsed());
  553. assertEquals(false,sheet1.getRow(16).getCTRow().isSetHidden());
  554. assertEquals(false,sheet1.getRow(18).getCTRow().isSetCollapsed());
  555. assertEquals(false,sheet1.getRow(18).getCTRow().isSetHidden());
  556. // Save and re-load
  557. wb = XSSFTestDataSamples.writeOutAndReadBack(wb);
  558. sheet1 = (XSSFSheet)wb.getSheetAt(0);
  559. assertEquals(false,sheet1.getRow(6).getCTRow().isSetCollapsed());
  560. assertEquals(false,sheet1.getRow(6).getCTRow().isSetHidden());
  561. assertEquals(false,sheet1.getRow(7).getCTRow().isSetCollapsed());
  562. assertEquals(true, sheet1.getRow(7).getCTRow().isSetHidden());
  563. assertEquals(false,sheet1.getRow(9).getCTRow().isSetCollapsed());
  564. assertEquals(true, sheet1.getRow(9).getCTRow().isSetHidden());
  565. assertEquals(false,sheet1.getRow(14).getCTRow().isSetCollapsed());
  566. assertEquals(true, sheet1.getRow(14).getCTRow().isSetHidden());
  567. assertEquals(false,sheet1.getRow(16).getCTRow().isSetCollapsed());
  568. assertEquals(false,sheet1.getRow(16).getCTRow().isSetHidden());
  569. assertEquals(false,sheet1.getRow(18).getCTRow().isSetCollapsed());
  570. assertEquals(false,sheet1.getRow(18).getCTRow().isSetHidden());
  571. }
  572. /**
  573. * Get / Set column width and check the actual values of the underlying XML beans
  574. */
  575. public void testColumnWidth_lowlevel() {
  576. XSSFWorkbook workbook = new XSSFWorkbook();
  577. XSSFSheet sheet = workbook.createSheet("Sheet 1");
  578. sheet.setColumnWidth(1, 22 * 256);
  579. assertEquals(22 * 256, sheet.getColumnWidth(1));
  580. // Now check the low level stuff, and check that's all
  581. // been set correctly
  582. XSSFSheet xs = sheet;
  583. CTWorksheet cts = xs.getCTWorksheet();
  584. CTCols[] cols_s = cts.getColsArray();
  585. assertEquals(1, cols_s.length);
  586. CTCols cols = cols_s[0];
  587. assertEquals(1, cols.sizeOfColArray());
  588. CTCol col = cols.getColArray(0);
  589. // XML is 1 based, POI is 0 based
  590. assertEquals(2, col.getMin());
  591. assertEquals(2, col.getMax());
  592. assertEquals(22.0, col.getWidth(), 0.0);
  593. assertTrue(col.getCustomWidth());
  594. // Now set another
  595. sheet.setColumnWidth(3, 33 * 256);
  596. cols_s = cts.getColsArray();
  597. assertEquals(1, cols_s.length);
  598. cols = cols_s[0];
  599. assertEquals(2, cols.sizeOfColArray());
  600. col = cols.getColArray(0);
  601. assertEquals(2, col.getMin()); // POI 1
  602. assertEquals(2, col.getMax());
  603. assertEquals(22.0, col.getWidth(), 0.0);
  604. assertTrue(col.getCustomWidth());
  605. col = cols.getColArray(1);
  606. assertEquals(4, col.getMin()); // POI 3
  607. assertEquals(4, col.getMax());
  608. assertEquals(33.0, col.getWidth(), 0.0);
  609. assertTrue(col.getCustomWidth());
  610. }
  611. /**
  612. * Setting width of a column included in a column span
  613. */
  614. public void test47862() {
  615. XSSFWorkbook wb = XSSFTestDataSamples.openSampleWorkbook("47862.xlsx");
  616. XSSFSheet sheet = wb.getSheetAt(0);
  617. CTCols cols = sheet.getCTWorksheet().getColsArray(0);
  618. //<cols>
  619. // <col min="1" max="5" width="15.77734375" customWidth="1"/>
  620. //</cols>
  621. //a span of columns [1,5]
  622. assertEquals(1, cols.sizeOfColArray());
  623. CTCol col = cols.getColArray(0);
  624. assertEquals(1, col.getMin());
  625. assertEquals(5, col.getMax());
  626. double swidth = 15.77734375; //width of columns in the span
  627. assertEquals(swidth, col.getWidth());
  628. for (int i = 0; i < 5; i++) {
  629. assertEquals((int)(swidth*256), sheet.getColumnWidth(i));
  630. }
  631. int[] cw = new int[]{10, 15, 20, 25, 30};
  632. for (int i = 0; i < 5; i++) {
  633. sheet.setColumnWidth(i, cw[i]*256);
  634. }
  635. //the check below failed prior to fix of Bug #47862
  636. ColumnHelper.sortColumns(cols);
  637. //<cols>
  638. // <col min="1" max="1" customWidth="true" width="10.0" />
  639. // <col min="2" max="2" customWidth="true" width="15.0" />
  640. // <col min="3" max="3" customWidth="true" width="20.0" />
  641. // <col min="4" max="4" customWidth="true" width="25.0" />
  642. // <col min="5" max="5" customWidth="true" width="30.0" />
  643. //</cols>
  644. //now the span is splitted into 5 individual columns
  645. assertEquals(5, cols.sizeOfColArray());
  646. for (int i = 0; i < 5; i++) {
  647. assertEquals(cw[i]*256, sheet.getColumnWidth(i));
  648. assertEquals((double)cw[i], cols.getColArray(i).getWidth());
  649. }
  650. //serialize and check again
  651. wb = getTestDataProvider().writeOutAndReadBack(wb);
  652. sheet = wb.getSheetAt(0);
  653. cols = sheet.getCTWorksheet().getColsArray(0);
  654. assertEquals(5, cols.sizeOfColArray());
  655. for (int i = 0; i < 5; i++) {
  656. assertEquals(cw[i]*256, sheet.getColumnWidth(i));
  657. assertEquals((double)cw[i], cols.getColArray(i).getWidth());
  658. }
  659. }
  660. /**
  661. * Hiding a column included in a column span
  662. */
  663. public void test47804() {
  664. XSSFWorkbook wb = XSSFTestDataSamples.openSampleWorkbook("47804.xlsx");
  665. XSSFSheet sheet = wb.getSheetAt(0);
  666. CTCols cols = sheet.getCTWorksheet().getColsArray(0);
  667. assertEquals(2, cols.sizeOfColArray());
  668. CTCol col;
  669. //<cols>
  670. // <col min="2" max="4" width="12" customWidth="1"/>
  671. // <col min="7" max="7" width="10.85546875" customWidth="1"/>
  672. //</cols>
  673. //a span of columns [2,4]
  674. col = cols.getColArray(0);
  675. assertEquals(2, col.getMin());
  676. assertEquals(4, col.getMax());
  677. //individual column
  678. col = cols.getColArray(1);
  679. assertEquals(7, col.getMin());
  680. assertEquals(7, col.getMax());
  681. sheet.setColumnHidden(2, true); // Column C
  682. sheet.setColumnHidden(6, true); // Column G
  683. assertTrue(sheet.isColumnHidden(2));
  684. assertTrue(sheet.isColumnHidden(6));
  685. //other columns but C and G are not hidden
  686. assertFalse(sheet.isColumnHidden(1));
  687. assertFalse(sheet.isColumnHidden(3));
  688. assertFalse(sheet.isColumnHidden(4));
  689. assertFalse(sheet.isColumnHidden(5));
  690. //the check below failed prior to fix of Bug #47804
  691. ColumnHelper.sortColumns(cols);
  692. //the span is now splitted into three parts
  693. //<cols>
  694. // <col min="2" max="2" customWidth="true" width="12.0" />
  695. // <col min="3" max="3" customWidth="true" width="12.0" hidden="true"/>
  696. // <col min="4" max="4" customWidth="true" width="12.0"/>
  697. // <col min="7" max="7" customWidth="true" width="10.85546875" hidden="true"/>
  698. //</cols>
  699. assertEquals(4, cols.sizeOfColArray());
  700. col = cols.getColArray(0);
  701. assertEquals(2, col.getMin());
  702. assertEquals(2, col.getMax());
  703. col = cols.getColArray(1);
  704. assertEquals(3, col.getMin());
  705. assertEquals(3, col.getMax());
  706. col = cols.getColArray(2);
  707. assertEquals(4, col.getMin());
  708. assertEquals(4, col.getMax());
  709. col = cols.getColArray(3);
  710. assertEquals(7, col.getMin());
  711. assertEquals(7, col.getMax());
  712. //serialize and check again
  713. wb = getTestDataProvider().writeOutAndReadBack(wb);
  714. sheet = wb.getSheetAt(0);
  715. assertTrue(sheet.isColumnHidden(2));
  716. assertTrue(sheet.isColumnHidden(6));
  717. assertFalse(sheet.isColumnHidden(1));
  718. assertFalse(sheet.isColumnHidden(3));
  719. assertFalse(sheet.isColumnHidden(4));
  720. assertFalse(sheet.isColumnHidden(5));
  721. }
  722. public void testCommentsTable() {
  723. XSSFWorkbook workbook = new XSSFWorkbook();
  724. XSSFSheet sheet1 = workbook.createSheet();
  725. CommentsTable comment1 = sheet1.getCommentsTable(false);
  726. assertNull(comment1);
  727. comment1 = sheet1.getCommentsTable(true);
  728. assertNotNull(comment1);
  729. assertEquals("/xl/comments1.xml", comment1.getPackageRelationship().getTargetURI().toString());
  730. assertSame(comment1, sheet1.getCommentsTable(true));
  731. //second sheet
  732. XSSFSheet sheet2 = workbook.createSheet();
  733. CommentsTable comment2 = sheet2.getCommentsTable(false);
  734. assertNull(comment2);
  735. comment2 = sheet2.getCommentsTable(true);
  736. assertNotNull(comment2);
  737. assertSame(comment2, sheet2.getCommentsTable(true));
  738. assertEquals("/xl/comments2.xml", comment2.getPackageRelationship().getTargetURI().toString());
  739. //comment1 and comment2 are different objects
  740. assertNotSame(comment1, comment2);
  741. //now test against a workbook containing cell comments
  742. workbook = XSSFTestDataSamples.openSampleWorkbook("WithMoreVariousData.xlsx");
  743. sheet1 = workbook.getSheetAt(0);
  744. comment1 = sheet1.getCommentsTable(true);
  745. assertNotNull(comment1);
  746. assertEquals("/xl/comments1.xml", comment1.getPackageRelationship().getTargetURI().toString());
  747. assertSame(comment1, sheet1.getCommentsTable(true));
  748. }
  749. }