| /* ==================================================================== |
| 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.examples.hssf.usermodel; |
| |
| import java.io.FileOutputStream; |
| import java.io.IOException; |
| |
| import org.apache.poi.common.usermodel.HyperlinkType; |
| import org.apache.poi.hssf.usermodel.HSSFCell; |
| import org.apache.poi.hssf.usermodel.HSSFCellStyle; |
| import org.apache.poi.hssf.usermodel.HSSFCreationHelper; |
| import org.apache.poi.hssf.usermodel.HSSFFont; |
| import org.apache.poi.hssf.usermodel.HSSFHyperlink; |
| import org.apache.poi.hssf.usermodel.HSSFSheet; |
| import org.apache.poi.hssf.usermodel.HSSFWorkbook; |
| import org.apache.poi.hssf.util.HSSFColor.HSSFColorPredefined; |
| import org.apache.poi.ss.usermodel.Font; |
| |
| /** |
| * Demonstrates how to create hyperlinks. |
| */ |
| public class Hyperlinks { |
| |
| public static void main(String[] args) throws IOException { |
| try (HSSFWorkbook wb = new HSSFWorkbook()) { |
| HSSFCreationHelper helper = wb.getCreationHelper(); |
| |
| //cell style for hyperlinks |
| //by default hyperlinks are blue and underlined |
| HSSFCellStyle hlinkStyle = wb.createCellStyle(); |
| HSSFFont hlinkFont = wb.createFont(); |
| hlinkFont.setUnderline(Font.U_SINGLE); |
| hlinkFont.setColor(HSSFColorPredefined.BLUE.getIndex()); |
| hlinkStyle.setFont(hlinkFont); |
| |
| HSSFCell cell; |
| HSSFSheet sheet = wb.createSheet("Hyperlinks"); |
| |
| //URL |
| cell = sheet.createRow(0).createCell(0); |
| cell.setCellValue("URL Link"); |
| HSSFHyperlink link = helper.createHyperlink(HyperlinkType.URL); |
| link.setAddress("https://poi.apache.org/"); |
| cell.setHyperlink(link); |
| cell.setCellStyle(hlinkStyle); |
| |
| //link to a file in the current directory |
| cell = sheet.createRow(1).createCell(0); |
| cell.setCellValue("File Link"); |
| link = helper.createHyperlink(HyperlinkType.FILE); |
| link.setAddress("link1.xls"); |
| cell.setHyperlink(link); |
| cell.setCellStyle(hlinkStyle); |
| |
| //e-mail link |
| cell = sheet.createRow(2).createCell(0); |
| cell.setCellValue("Email Link"); |
| link = helper.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); |
| cell.setCellStyle(hlinkStyle); |
| |
| //link to a place in this workbook |
| |
| //create a target sheet and cell |
| HSSFSheet sheet2 = wb.createSheet("Target Sheet"); |
| sheet2.createRow(0).createCell(0).setCellValue("Target Cell"); |
| |
| cell = sheet.createRow(3).createCell(0); |
| cell.setCellValue("Worksheet Link"); |
| link = helper.createHyperlink(HyperlinkType.DOCUMENT); |
| link.setAddress("'Target Sheet'!A1"); |
| cell.setHyperlink(link); |
| cell.setCellStyle(hlinkStyle); |
| |
| try (FileOutputStream out = new FileOutputStream("hssf-links.xls")) { |
| wb.write(out); |
| } |
| } |
| } |
| } |