1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
/* ====================================================================
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
==================================================================== */
package org.apache.poi.ss.usermodel;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotEquals;
import static org.junit.Assert.assertNotSame;
import java.io.IOException;
import java.util.List;
import org.junit.Test;
import org.apache.poi.common.usermodel.HyperlinkType;
import org.apache.poi.ss.ITestDataProvider;
/**
* Test diffrent types of Excel hyperlinks
*
* @author Yegor Kozlov
*/
public abstract class BaseTestHyperlink {
private final ITestDataProvider _testDataProvider;
protected BaseTestHyperlink(ITestDataProvider testDataProvider) {
_testDataProvider = testDataProvider;
}
@Test
public final void testBasicTypes() throws IOException {
Workbook wb1 = _testDataProvider.createWorkbook();
CreationHelper createHelper = wb1.getCreationHelper();
Cell cell;
Hyperlink link;
Sheet sheet = wb1.createSheet("Hyperlinks");
//URL
cell = sheet.createRow(0).createCell((short) 0);
cell.setCellValue("URL Link");
link = createHelper.createHyperlink(HyperlinkType.URL);
link.setAddress("http://poi.apache.org/");
cell.setHyperlink(link);
//link to a file in the current directory
cell = sheet.createRow(1).createCell((short) 0);
cell.setCellValue("File Link");
link = createHelper.createHyperlink(HyperlinkType.FILE);
link.setAddress("hyperinks-beta4-dump.txt");
cell.setHyperlink(link);
//e-mail link
cell = sheet.createRow(2).createCell((short) 0);
cell.setCellValue("Email Link");
link = createHelper.createHyperlink(HyperlinkType.EMAIL);
//note, if subject contains white spaces, make sure they are url-encoded
link.setAddress("mailto:poi@apache.org?subject=Hyperlinks");
cell.setHyperlink(link);
//link to a place in this workbook
//create a target sheet and cell
Sheet sheet2 = wb1.createSheet("Target Sheet");
sheet2.createRow(0).createCell((short) 0).setCellValue("Target Cell");
cell = sheet.createRow(3).createCell((short) 0);
cell.setCellValue("Worksheet Link");
link = createHelper.createHyperlink(HyperlinkType.DOCUMENT);
link.setAddress("'Target Sheet'!A1");
cell.setHyperlink(link);
Workbook wb2 = _testDataProvider.writeOutAndReadBack(wb1);
wb1.close();
sheet = wb2.getSheetAt(0);
link = sheet.getRow(0).getCell(0).getHyperlink();
assertEquals("http://poi.apache.org/", link.getAddress());
link = sheet.getRow(1).getCell(0).getHyperlink();
assertEquals("hyperinks-beta4-dump.txt", link.getAddress());
link = sheet.getRow(2).getCell(0).getHyperlink();
assertEquals("mailto:poi@apache.org?subject=Hyperlinks", link.getAddress());
link = sheet.getRow(3).getCell(0).getHyperlink();
assertEquals("'Target Sheet'!A1", link.getAddress());
wb2.close();
}
// copy a hyperlink via the copy constructor
@Test
public void testCopyHyperlink() throws IOException {
final Workbook wb = _testDataProvider.createWorkbook();
final CreationHelper createHelper = wb.getCreationHelper();
final Sheet sheet = wb.createSheet("Hyperlinks");
final Row row = sheet.createRow(0);
final Cell cell1, cell2;
final Hyperlink link1, link2;
//URL
cell1 = row.createCell(0);
cell2 = row.createCell(1);
cell1.setCellValue("URL Link");
link1 = createHelper.createHyperlink(HyperlinkType.URL);
link1.setAddress("http://poi.apache.org/");
cell1.setHyperlink(link1);
link2 = copyHyperlink(link1);
// Change address (type is not changeable)
link2.setAddress("http://apache.org/");
cell2.setHyperlink(link2);
// Make sure hyperlinks were deep-copied, and modifying one does not modify the other.
assertNotSame(link1, link2);
assertNotEquals(link1, link2);
assertEquals("http://poi.apache.org/", link1.getAddress());
assertEquals("http://apache.org/", link2.getAddress());
assertEquals(link1, cell1.getHyperlink());
assertEquals(link2, cell2.getHyperlink());
// Make sure both hyperlinks were added to the sheet
@SuppressWarnings("unchecked")
final List<Hyperlink> actualHyperlinks = (List<Hyperlink>) sheet.getHyperlinkList();
assertEquals(2, actualHyperlinks.size());
assertEquals(link1, actualHyperlinks.get(0));
assertEquals(link2, actualHyperlinks.get(1));
wb.close();
}
public abstract Hyperlink copyHyperlink(Hyperlink link);
}
|
