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.

TestXSSFHyperlink.java 26KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603
  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.common.usermodel.HyperlinkType;
  17. import org.apache.poi.hssf.usermodel.HSSFHyperlink;
  18. import org.apache.poi.hssf.usermodel.HSSFWorkbook;
  19. import org.apache.poi.openxml4j.opc.PackageRelationship;
  20. import org.apache.poi.openxml4j.opc.PackageRelationshipCollection;
  21. import org.apache.poi.ss.SpreadsheetVersion;
  22. import org.apache.poi.ss.usermodel.*;
  23. import org.apache.poi.ss.util.AreaReference;
  24. import org.apache.poi.ss.util.CellAddress;
  25. import org.apache.poi.ss.util.CellReference;
  26. import org.apache.poi.xssf.XSSFITestDataProvider;
  27. import org.apache.poi.xssf.XSSFTestDataSamples;
  28. import org.junit.jupiter.api.Test;
  29. import java.io.IOException;
  30. import java.util.ArrayList;
  31. import java.util.HashSet;
  32. import static org.junit.jupiter.api.Assertions.*;
  33. public final class TestXSSFHyperlink extends BaseTestHyperlink {
  34. public TestXSSFHyperlink() {
  35. super(XSSFITestDataProvider.instance);
  36. }
  37. @Test
  38. void testLoadExisting() throws IOException {
  39. try (XSSFWorkbook workbook = XSSFTestDataSamples.openSampleWorkbook("WithMoreVariousData.xlsx")) {
  40. assertEquals(3, workbook.getNumberOfSheets());
  41. XSSFSheet sheet = workbook.getSheetAt(0);
  42. // Check the hyperlinks
  43. assertEquals(4, sheet.getNumHyperlinks());
  44. doTestHyperlinkContents(sheet);
  45. }
  46. }
  47. @Test
  48. public void readSharedHyperlink() throws IOException {
  49. try (XSSFWorkbook wb = XSSFTestDataSamples.openSampleWorkbook("sharedhyperlink.xlsx")) {
  50. XSSFSheet sheet = wb.getSheetAt(0);
  51. XSSFHyperlink hyperlink3 = sheet.getHyperlink(new CellAddress("A3"));
  52. XSSFHyperlink hyperlink4 = sheet.getHyperlink(new CellAddress("A4"));
  53. XSSFHyperlink hyperlink5 = sheet.getHyperlink(new CellAddress("A5"));
  54. assertNotNull(hyperlink3, "hyperlink found?");
  55. assertEquals(hyperlink3, hyperlink4);
  56. assertEquals(hyperlink3, hyperlink5);
  57. assertEquals("A3:A5", hyperlink3.getCellRef());
  58. assertEquals(0, hyperlink3.getFirstColumn());
  59. assertEquals(0, hyperlink3.getLastColumn());
  60. assertEquals(2, hyperlink3.getFirstRow());
  61. assertEquals(4, hyperlink3.getLastRow());
  62. }
  63. }
  64. @Test
  65. void testCreate() throws Exception {
  66. XSSFWorkbook workbook = new XSSFWorkbook();
  67. XSSFSheet sheet = workbook.createSheet();
  68. XSSFRow row = sheet.createRow(0);
  69. XSSFCreationHelper createHelper = workbook.getCreationHelper();
  70. String[] urls = {
  71. "http://apache.org",
  72. "www.apache.org",
  73. "/temp",
  74. "c:/temp",
  75. "http://apache.org/default.php?s=isTramsformed&submit=Search&la=*&li=*"};
  76. for(int i = 0; i < urls.length; i++){
  77. String s = urls[i];
  78. XSSFHyperlink link = createHelper.createHyperlink(HyperlinkType.URL);
  79. link.setAddress(s);
  80. XSSFCell cell = row.createCell(i);
  81. cell.setHyperlink(link);
  82. }
  83. workbook = XSSFTestDataSamples.writeOutAndReadBack(workbook);
  84. sheet = workbook.getSheetAt(0);
  85. PackageRelationshipCollection rels = sheet.getPackagePart().getRelationships();
  86. assertEquals(urls.length, rels.size());
  87. for(int i = 0; i < rels.size(); i++){
  88. PackageRelationship rel = rels.getRelationship(i);
  89. // there should be a relationship for each URL
  90. assertNotNull(rel);
  91. assertEquals(urls[i], rel.getTargetURI().toString());
  92. }
  93. // Bugzilla 53041: Hyperlink relations are duplicated when saving XSSF file
  94. workbook = XSSFTestDataSamples.writeOutAndReadBack(workbook);
  95. sheet = workbook.getSheetAt(0);
  96. rels = sheet.getPackagePart().getRelationships();
  97. assertEquals(urls.length, rels.size());
  98. for(int i = 0; i < rels.size(); i++){
  99. PackageRelationship rel = rels.getRelationship(i);
  100. // there should be a relationship for each URL
  101. assertNotNull(rel);
  102. assertEquals(urls[i], rel.getTargetURI().toString());
  103. }
  104. }
  105. @Test
  106. void testInvalidURLs() throws IOException {
  107. try (XSSFWorkbook workbook = new XSSFWorkbook()) {
  108. XSSFCreationHelper createHelper = workbook.getCreationHelper();
  109. String[] invalidURLs = {
  110. "http:\\apache.org",
  111. "www.apache .org",
  112. "c:\\temp",
  113. "\\poi"};
  114. for (String s : invalidURLs) {
  115. assertThrows(IllegalArgumentException.class,
  116. () -> createHelper.createHyperlink(HyperlinkType.URL).setAddress(s));
  117. }
  118. }
  119. }
  120. @Test
  121. void testLoadSave() throws IOException {
  122. try (XSSFWorkbook workbook = XSSFTestDataSamples.openSampleWorkbook("WithMoreVariousData.xlsx")) {
  123. CreationHelper createHelper = workbook.getCreationHelper();
  124. assertEquals(3, workbook.getNumberOfSheets());
  125. XSSFSheet sheet = workbook.getSheetAt(0);
  126. // Check hyperlinks
  127. assertEquals(4, sheet.getNumHyperlinks());
  128. doTestHyperlinkContents(sheet);
  129. // Write out, and check
  130. // Load up again, check all links still there
  131. XSSFWorkbook wb2 = XSSFTestDataSamples.writeOutAndReadBack(workbook);
  132. assertEquals(3, wb2.getNumberOfSheets());
  133. assertNotNull(wb2.getSheetAt(0));
  134. assertNotNull(wb2.getSheetAt(1));
  135. assertNotNull(wb2.getSheetAt(2));
  136. sheet = wb2.getSheetAt(0);
  137. // Check hyperlinks again
  138. assertEquals(4, sheet.getNumHyperlinks());
  139. doTestHyperlinkContents(sheet);
  140. // Add one more, and re-check
  141. Row r17 = sheet.createRow(17);
  142. Cell r17c = r17.createCell(2);
  143. Hyperlink hyperlink = createHelper.createHyperlink(HyperlinkType.URL);
  144. hyperlink.setAddress("http://poi.apache.org/spreadsheet/");
  145. hyperlink.setLabel("POI SS Link");
  146. r17c.setHyperlink(hyperlink);
  147. assertEquals(5, sheet.getNumHyperlinks());
  148. doTestHyperlinkContents(sheet);
  149. assertEquals(HyperlinkType.URL,
  150. sheet.getRow(17).getCell(2).getHyperlink().getType());
  151. assertEquals("POI SS Link",
  152. sheet.getRow(17).getCell(2).getHyperlink().getLabel());
  153. assertEquals("http://poi.apache.org/spreadsheet/",
  154. sheet.getRow(17).getCell(2).getHyperlink().getAddress());
  155. // Save and re-load once more
  156. XSSFWorkbook wb3 = XSSFTestDataSamples.writeOutAndReadBack(wb2);
  157. assertEquals(3, wb3.getNumberOfSheets());
  158. assertNotNull(wb3.getSheetAt(0));
  159. assertNotNull(wb3.getSheetAt(1));
  160. assertNotNull(wb3.getSheetAt(2));
  161. sheet = wb3.getSheetAt(0);
  162. assertEquals(5, sheet.getNumHyperlinks());
  163. doTestHyperlinkContents(sheet);
  164. assertEquals(HyperlinkType.URL,
  165. sheet.getRow(17).getCell(2).getHyperlink().getType());
  166. assertEquals("POI SS Link",
  167. sheet.getRow(17).getCell(2).getHyperlink().getLabel());
  168. assertEquals("http://poi.apache.org/spreadsheet/",
  169. sheet.getRow(17).getCell(2).getHyperlink().getAddress());
  170. }
  171. }
  172. @Test
  173. void testCopyHSSFHyperlink() throws IOException {
  174. try (HSSFWorkbook hssfworkbook = new HSSFWorkbook()) {
  175. HSSFHyperlink hlink = hssfworkbook.getCreationHelper().createHyperlink(HyperlinkType.URL);
  176. hlink.setAddress("http://poi.apache.org/");
  177. hlink.setFirstColumn(3);
  178. hlink.setFirstRow(2);
  179. hlink.setLastColumn(3);
  180. hlink.setLastRow(2);
  181. hlink.setLabel("label");
  182. XSSFHyperlink xlink = new XSSFHyperlink(hlink);
  183. assertEquals("http://poi.apache.org/", xlink.getAddress());
  184. assertEquals(new CellReference(2, 3), new CellReference(xlink.getCellRef()));
  185. // Are HSSFHyperlink.label and XSSFHyperlink.tooltip the same? If so, perhaps one of these needs renamed for a consistent Hyperlink interface
  186. // assertEquals("label", xlink.getTooltip());
  187. }
  188. }
  189. @Test
  190. void setHyperlinkOnCellFromHSSF() throws Exception {
  191. try (XSSFWorkbook xssfWorkbook = new XSSFWorkbook()) {
  192. XSSFSheet xssfSheet = xssfWorkbook.createSheet();
  193. XSSFRow xssfRow = xssfSheet.createRow(0);
  194. XSSFCell xssfCell = xssfRow.createCell(0);
  195. xssfCell.setCellValue("link");
  196. HSSFHyperlink hssfHyperlink = new HSSFHyperlink(HyperlinkType.URL) {
  197. };
  198. hssfHyperlink.setLabel("label");
  199. hssfHyperlink.setAddress("https://example.com/index.html#label");
  200. hssfHyperlink.setFirstColumn(2);
  201. hssfHyperlink.setLastColumn(3);
  202. hssfHyperlink.setFirstRow(4);
  203. hssfHyperlink.setLastRow(5);
  204. xssfCell.setHyperlink(hssfHyperlink);
  205. XSSFHyperlink xssfHyperlink = xssfCell.getHyperlink();
  206. assertEquals(hssfHyperlink.getType(), xssfHyperlink.getType());
  207. assertEquals(hssfHyperlink.getAddress(), xssfHyperlink.getAddress());
  208. assertEquals(hssfHyperlink.getLabel(), xssfHyperlink.getLabel());
  209. assertEquals("A1", xssfHyperlink.getCellRef());
  210. }
  211. }
  212. @Test
  213. void setHyperlinkOnSheetFromHSSF() throws Exception {
  214. try (XSSFWorkbook xssfWorkbook = new XSSFWorkbook()) {
  215. XSSFSheet xssfSheet = xssfWorkbook.createSheet();
  216. XSSFRow xssfRow = xssfSheet.createRow(0);
  217. XSSFCell xssfCell = xssfRow.createCell(0);
  218. xssfCell.setCellValue("link");
  219. HSSFHyperlink hssfHyperlink = new HSSFHyperlink(HyperlinkType.URL) {
  220. };
  221. hssfHyperlink.setLabel("label");
  222. hssfHyperlink.setAddress("https://example.com/index.html#label");
  223. hssfHyperlink.setFirstColumn(2);
  224. hssfHyperlink.setLastColumn(3);
  225. hssfHyperlink.setFirstRow(4);
  226. hssfHyperlink.setLastRow(5);
  227. XSSFHyperlink xssfHyperlink = new XSSFHyperlink(hssfHyperlink);
  228. xssfSheet.addHyperlink(xssfHyperlink);
  229. assertEquals(hssfHyperlink.getType(), xssfHyperlink.getType());
  230. assertEquals(hssfHyperlink.getAddress(), xssfHyperlink.getAddress());
  231. assertEquals(hssfHyperlink.getLabel(), xssfHyperlink.getLabel());
  232. assertEquals(hssfHyperlink.getFirstColumn(), xssfHyperlink.getFirstColumn());
  233. assertEquals(hssfHyperlink.getLastColumn(), xssfHyperlink.getLastColumn());
  234. assertEquals(hssfHyperlink.getFirstRow(), xssfHyperlink.getFirstRow());
  235. assertEquals(hssfHyperlink.getLastRow(), xssfHyperlink.getLastRow());
  236. }
  237. }
  238. /**
  239. * Only for WithMoreVariousData.xlsx !
  240. */
  241. private static void doTestHyperlinkContents(XSSFSheet sheet) {
  242. assertNotNull(sheet.getRow(3).getCell(2).getHyperlink());
  243. assertNotNull(sheet.getRow(14).getCell(2).getHyperlink());
  244. assertNotNull(sheet.getRow(15).getCell(2).getHyperlink());
  245. assertNotNull(sheet.getRow(16).getCell(2).getHyperlink());
  246. // First is a link to poi
  247. assertEquals(HyperlinkType.URL,
  248. sheet.getRow(3).getCell(2).getHyperlink().getType());
  249. assertNull(sheet.getRow(3).getCell(2).getHyperlink().getLabel());
  250. assertEquals("http://poi.apache.org/",
  251. sheet.getRow(3).getCell(2).getHyperlink().getAddress());
  252. // Next is an internal doc link
  253. assertEquals(HyperlinkType.DOCUMENT,
  254. sheet.getRow(14).getCell(2).getHyperlink().getType());
  255. assertEquals("Internal hyperlink to A2",
  256. sheet.getRow(14).getCell(2).getHyperlink().getLabel());
  257. assertEquals("Sheet1!A2",
  258. sheet.getRow(14).getCell(2).getHyperlink().getAddress());
  259. // Next is a file
  260. assertEquals(HyperlinkType.FILE,
  261. sheet.getRow(15).getCell(2).getHyperlink().getType());
  262. assertNull(sheet.getRow(15).getCell(2).getHyperlink().getLabel());
  263. assertEquals("WithVariousData.xlsx",
  264. sheet.getRow(15).getCell(2).getHyperlink().getAddress());
  265. // Last is a mailto
  266. assertEquals(HyperlinkType.EMAIL,
  267. sheet.getRow(16).getCell(2).getHyperlink().getType());
  268. assertNull(sheet.getRow(16).getCell(2).getHyperlink().getLabel());
  269. assertEquals("mailto:dev@poi.apache.org?subject=XSSF%20Hyperlinks",
  270. sheet.getRow(16).getCell(2).getHyperlink().getAddress());
  271. }
  272. @Test
  273. void test52716() throws IOException {
  274. try (XSSFWorkbook wb1 = XSSFTestDataSamples.openSampleWorkbook("52716.xlsx")) {
  275. XSSFSheet sh1 = wb1.getSheetAt(0);
  276. XSSFWorkbook wb2 = XSSFTestDataSamples.writeOutAndReadBack(wb1);
  277. XSSFSheet sh2 = wb2.getSheetAt(0);
  278. assertEquals(sh1.getNumberOfComments(), sh2.getNumberOfComments());
  279. XSSFHyperlink l1 = sh1.getHyperlink(0, 1);
  280. assertEquals(HyperlinkType.DOCUMENT, l1.getType());
  281. assertEquals("B1", l1.getCellRef());
  282. assertEquals("Sort on Titel", l1.getTooltip());
  283. XSSFHyperlink l2 = sh2.getHyperlink(0, 1);
  284. assertEquals(l1.getTooltip(), l2.getTooltip());
  285. assertEquals(HyperlinkType.DOCUMENT, l2.getType());
  286. assertEquals("B1", l2.getCellRef());
  287. }
  288. }
  289. @Test
  290. void test53734() throws IOException {
  291. try (XSSFWorkbook wb = XSSFTestDataSamples.openSampleWorkbook("53734.xlsx")) {
  292. Hyperlink link = wb.getSheetAt(0).getRow(0).getCell(0).getHyperlink();
  293. assertEquals("javascript:///", link.getAddress());
  294. try (XSSFWorkbook wb2 = XSSFTestDataSamples.writeOutAndReadBack(wb)) {
  295. link = wb2.getSheetAt(0).getRow(0).getCell(0).getHyperlink();
  296. assertEquals("javascript:///", link.getAddress());
  297. }
  298. }
  299. }
  300. @Test
  301. void test53282() throws IOException {
  302. try (XSSFWorkbook wb = XSSFTestDataSamples.openSampleWorkbook("53282.xlsx")) {
  303. Hyperlink link = wb.getSheetAt(0).getRow(0).getCell(14).getHyperlink();
  304. assertEquals("mailto:nobody@nowhere.uk%C2%A0", link.getAddress());
  305. try (XSSFWorkbook wb2 = XSSFTestDataSamples.writeOutAndReadBack(wb)) {
  306. link = wb2.getSheetAt(0).getRow(0).getCell(14).getHyperlink();
  307. assertEquals("mailto:nobody@nowhere.uk%C2%A0", link.getAddress());
  308. }
  309. }
  310. }
  311. @Override
  312. public XSSFHyperlink copyHyperlink(Hyperlink link) {
  313. return new XSSFHyperlink(link);
  314. }
  315. /* bug 59775: XSSFHyperlink has wrong type if it contains a location (CTHyperlink#getLocation)
  316. * URLs with a hash mark (#) are still URL hyperlinks, not document links
  317. */
  318. @Test
  319. void testURLsWithHashMark() throws IOException {
  320. XSSFWorkbook wb = XSSFTestDataSamples.openSampleWorkbook("59775.xlsx");
  321. XSSFSheet sh = wb.getSheetAt(0);
  322. CellAddress A2 = new CellAddress("A2");
  323. CellAddress A3 = new CellAddress("A3");
  324. CellAddress A4 = new CellAddress("A4");
  325. CellAddress A7 = new CellAddress("A7");
  326. XSSFHyperlink link = sh.getHyperlink(A2);
  327. assertEquals("A2", link.getCellRef(), "address");
  328. assertEquals(HyperlinkType.URL, link.getType(), "link type");
  329. assertEquals("http://twitter.com/#!/apacheorg", link.getAddress(), "link target");
  330. link = sh.getHyperlink(A3);
  331. assertEquals("A3", link.getCellRef(), "address");
  332. assertEquals(HyperlinkType.URL, link.getType(), "link type");
  333. assertEquals("http://www.bailii.org/databases.html#ie", link.getAddress(), "link target");
  334. link = sh.getHyperlink(A4);
  335. assertEquals("A4", link.getCellRef(), "address");
  336. assertEquals(HyperlinkType.URL, link.getType(), "link type");
  337. assertEquals("https://en.wikipedia.org/wiki/Apache_POI#See_also", link.getAddress(), "link target");
  338. link = sh.getHyperlink(A7);
  339. assertEquals("A7", link.getCellRef(), "address");
  340. assertEquals(HyperlinkType.DOCUMENT, link.getType(), "link type");
  341. assertEquals("Sheet1", link.getAddress(), "link target");
  342. wb.close();
  343. }
  344. @Test
  345. void testCellStyle() throws IOException {
  346. XSSFWorkbook wb = new XSSFWorkbook();
  347. CreationHelper createHelper = wb.getCreationHelper();
  348. XSSFCellStyle hlinkStyle = wb.createCellStyle();
  349. Font hlinkFont = wb.createFont();
  350. Sheet sheet = wb.createSheet("test");
  351. Row rowDet = sheet.createRow(0);
  352. Cell cellDet = rowDet.createCell(7);
  353. cellDet.setCellValue("http://www.google.at");
  354. //set up style to be able to create hyperlinks
  355. hlinkFont.setColor(IndexedColors.BLUE.getIndex());
  356. hlinkStyle.setFont(hlinkFont);
  357. Hyperlink link = createHelper.createHyperlink(HyperlinkType.URL);
  358. link.setAddress("http://www.example.com");
  359. cellDet.setHyperlink(link);
  360. cellDet.setCellStyle(hlinkStyle);
  361. //set up style to be able to create hyperlinks
  362. hlinkFont.setColor(IndexedColors.BLUE.getIndex());
  363. hlinkStyle.setFont(hlinkFont);
  364. link = createHelper.createHyperlink(HyperlinkType.URL);
  365. //string for hyperlink
  366. cellDet = rowDet.createCell(13);
  367. cellDet.setCellValue("http://www.other.com");
  368. link.setAddress("http://www.gmx.at");
  369. cellDet.setHyperlink(link);
  370. cellDet.setCellStyle(hlinkStyle);
  371. XSSFWorkbook wbBack = XSSFTestDataSamples.writeOutAndReadBack(wb);
  372. assertNotNull(wbBack.getSheetAt(0).getRow(0).getCell(7).getHyperlink());
  373. assertNotNull(wbBack.getSheetAt(0).getRow(0).getCell(13).getHyperlink());
  374. wb.close();
  375. wbBack.close();
  376. }
  377. @Test
  378. void testChangeReference() {
  379. XSSFHyperlink hyperlink = new XSSFHyperlink(HyperlinkType.URL);
  380. hyperlink.setCellReference("B2");
  381. assertEquals(1, hyperlink.getFirstRow());
  382. assertEquals(1, hyperlink.getLastRow());
  383. assertEquals(1, hyperlink.getFirstColumn());
  384. assertEquals(1, hyperlink.getLastColumn());
  385. hyperlink.setFirstRow(0);
  386. assertEquals("B1:B2", hyperlink.getCellRef());
  387. assertEquals(0, hyperlink.getFirstRow());
  388. assertEquals(1, hyperlink.getLastRow());
  389. assertEquals(1, hyperlink.getFirstColumn());
  390. assertEquals(1, hyperlink.getLastColumn());
  391. hyperlink.setLastRow(2);
  392. assertEquals("B1:B3", hyperlink.getCellRef());
  393. assertEquals(0, hyperlink.getFirstRow());
  394. assertEquals(2, hyperlink.getLastRow());
  395. assertEquals(1, hyperlink.getFirstColumn());
  396. assertEquals(1, hyperlink.getLastColumn());
  397. hyperlink.setFirstColumn(0);
  398. assertEquals("A1:B3", hyperlink.getCellRef());
  399. assertEquals(0, hyperlink.getFirstRow());
  400. assertEquals(2, hyperlink.getLastRow());
  401. assertEquals(0, hyperlink.getFirstColumn());
  402. assertEquals(1, hyperlink.getLastColumn());
  403. hyperlink.setLastColumn(2);
  404. assertEquals("A1:C3", hyperlink.getCellRef());
  405. assertEquals(0, hyperlink.getFirstRow());
  406. assertEquals(2, hyperlink.getLastRow());
  407. assertEquals(0, hyperlink.getFirstColumn());
  408. assertEquals(2, hyperlink.getLastColumn());
  409. hyperlink.setFirstColumn(2);
  410. hyperlink.setFirstRow(2);
  411. assertEquals("C3", hyperlink.getCellRef());
  412. assertEquals(2, hyperlink.getFirstRow());
  413. assertEquals(2, hyperlink.getLastRow());
  414. assertEquals(2, hyperlink.getFirstColumn());
  415. assertEquals(2, hyperlink.getLastColumn());
  416. }
  417. @Test
  418. void testChangeRowsAndColumns() {
  419. XSSFHyperlink hyperlink = new XSSFHyperlink(HyperlinkType.URL);
  420. hyperlink.setCellReference("B2");
  421. hyperlink.setLastRow(0);
  422. assertEquals("B1", hyperlink.getCellRef());
  423. assertEquals(0, hyperlink.getFirstRow());
  424. assertEquals(0, hyperlink.getLastRow());
  425. assertEquals(1, hyperlink.getFirstColumn());
  426. assertEquals(1, hyperlink.getLastColumn());
  427. hyperlink.setLastColumn(0);
  428. assertEquals("A1", hyperlink.getCellRef());
  429. assertEquals(0, hyperlink.getFirstRow());
  430. assertEquals(0, hyperlink.getLastRow());
  431. assertEquals(0, hyperlink.getFirstColumn());
  432. assertEquals(0, hyperlink.getLastColumn());
  433. hyperlink.setFirstRow(1);
  434. assertEquals("A2", hyperlink.getCellRef());
  435. assertEquals(1, hyperlink.getFirstRow());
  436. assertEquals(1, hyperlink.getLastRow());
  437. assertEquals(0, hyperlink.getFirstColumn());
  438. assertEquals(0, hyperlink.getLastColumn());
  439. hyperlink.setFirstColumn(1);
  440. assertEquals("B2", hyperlink.getCellRef());
  441. assertEquals(1, hyperlink.getFirstRow());
  442. assertEquals(1, hyperlink.getLastRow());
  443. assertEquals(1, hyperlink.getFirstColumn());
  444. assertEquals(1, hyperlink.getLastColumn());
  445. hyperlink.setLastRow(2);
  446. assertEquals("B2:B3", hyperlink.getCellRef());
  447. assertEquals(1, hyperlink.getFirstRow());
  448. assertEquals(2, hyperlink.getLastRow());
  449. assertEquals(1, hyperlink.getFirstColumn());
  450. assertEquals(1, hyperlink.getLastColumn());
  451. hyperlink.setLastColumn(2);
  452. assertEquals("B2:C3", hyperlink.getCellRef());
  453. assertEquals(1, hyperlink.getFirstRow());
  454. assertEquals(2, hyperlink.getLastRow());
  455. assertEquals(1, hyperlink.getFirstColumn());
  456. assertEquals(2, hyperlink.getLastColumn());
  457. }
  458. @Test
  459. void testRemoveSharedHyperlinkFromOneCell() throws IOException {
  460. testRemoveSharedHyperlinkFromOneCell("A1:E5", new CellAddress("C3"));
  461. testRemoveSharedHyperlinkFromOneCell("A1:E5", new CellAddress("A1"));
  462. testRemoveSharedHyperlinkFromOneCell("A1:E5", new CellAddress("E5"));
  463. testRemoveSharedHyperlinkFromOneCell("A1:E5", new CellAddress("E1"));
  464. testRemoveSharedHyperlinkFromOneCell("A1:E5", new CellAddress("A5"));
  465. testRemoveSharedHyperlinkFromOneCell("D3:D5", new CellAddress("D3"));
  466. testRemoveSharedHyperlinkFromOneCell("D3:D5", new CellAddress("D4"));
  467. testRemoveSharedHyperlinkFromOneCell("D3:D5", new CellAddress("D5"));
  468. }
  469. @Test
  470. void testRemoveSharedHyperlinkFromOneCellWithCellRefs() throws IOException {
  471. try (XSSFWorkbook wb = new XSSFWorkbook()) {
  472. XSSFSheet sheet = wb.createSheet();
  473. XSSFHyperlink hyperlink = new XSSFHyperlink(HyperlinkType.URL);
  474. hyperlink.setAddress("https://poi.apache.org");
  475. hyperlink.setLocation("poi-location");
  476. hyperlink.setLabel("poi-label");
  477. hyperlink.setCellReference("A1:E5");
  478. sheet.addHyperlink(hyperlink);
  479. CellAddress cellAddress = new CellAddress("C3");
  480. sheet.removeHyperlink(cellAddress.getRow(), cellAddress.getColumn());
  481. assertNull(sheet.getHyperlink(cellAddress), "cell " + cellAddress.formatAsString() + "should no longer has a hyperlink");
  482. ArrayList<String> newRefs = new ArrayList<>();
  483. for (XSSFHyperlink testHyperlink : sheet.getHyperlinkList()) {
  484. newRefs.add(testHyperlink.getCellRef());
  485. }
  486. assertEquals(4, newRefs.size());
  487. HashSet<String> set = new HashSet<>(newRefs);
  488. assertTrue(set.contains("A1:B5"), "contains A1:B5");
  489. assertTrue(set.contains("D1:E5"), "contains D1:E5");
  490. assertTrue(set.contains("C1:C2"), "contains C1:C2");
  491. assertTrue(set.contains("C4:C5"), "contains C4:C5");
  492. }
  493. }
  494. private void testRemoveSharedHyperlinkFromOneCell(String area, CellAddress cellAddress) throws IOException {
  495. try (XSSFWorkbook wb = new XSSFWorkbook()) {
  496. XSSFSheet sheet = wb.createSheet();
  497. XSSFHyperlink hyperlink = new XSSFHyperlink(HyperlinkType.URL);
  498. hyperlink.setAddress("https://poi.apache.org");
  499. hyperlink.setLocation("poi-location");
  500. hyperlink.setLabel("poi-label");
  501. hyperlink.setCellReference(area);
  502. sheet.addHyperlink(hyperlink);
  503. AreaReference areaRef = new AreaReference(hyperlink.getCellRef(), SpreadsheetVersion.EXCEL2007);
  504. for (CellReference cellRef : areaRef.getAllReferencedCells()) {
  505. XSSFHyperlink testHyperlink = sheet.getHyperlink(cellRef.getRow(), cellRef.getCol());
  506. assertEquals(hyperlink, testHyperlink, "cell " + cellRef.formatAsString() + "has hyperlink?");
  507. }
  508. sheet.removeHyperlink(cellAddress.getRow(), cellAddress.getColumn());
  509. assertNull(sheet.getHyperlink(cellAddress), "cell " + cellAddress.formatAsString() + "should no longer has a hyperlink");
  510. for (CellReference cellRef : areaRef.getAllReferencedCells()) {
  511. if (cellRef.formatAsString().equals(cellAddress.formatAsString())) {
  512. //ignore
  513. } else {
  514. XSSFHyperlink testHyperlink = sheet.getHyperlink(cellRef.getRow(), cellRef.getCol());
  515. assertEquals(hyperlink.getAddress(), testHyperlink.getAddress(), "cell " + cellRef.formatAsString() + "has hyperlink with right address?");
  516. assertEquals(hyperlink.getLocation(), testHyperlink.getLocation(), "cell " + cellRef.formatAsString() + "has hyperlink with right location?");
  517. assertEquals(hyperlink.getLabel(), testHyperlink.getLabel(), "cell " + cellRef.formatAsString() + "has hyperlink with right label?");
  518. }
  519. }
  520. }
  521. }
  522. }