org.apache.poi.hssf.usermodel.HSSFHyperlink Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of poi Show documentation
Show all versions of poi Show documentation
Apache POI - Java API To Access Microsoft Format Files
/* ====================================================================
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.hssf.usermodel;
import org.apache.poi.hssf.record.HyperlinkRecord;
import org.apache.poi.ss.usermodel.Hyperlink;
/**
* Represents an Excel hyperlink.
*/
public class HSSFHyperlink implements Hyperlink {
/**
* Link to an existing file or web page
* May be deprecated in the future. Consider using {@link Hyperlink#LINK_URL} instead.
*/
public static final int LINK_URL = Hyperlink.LINK_URL;
/**
* Link to a place in this document
* May be deprecated in the future. Consider using {@link Hyperlink#LINK_DOCUMENT} instead.
*/
public static final int LINK_DOCUMENT = Hyperlink.LINK_DOCUMENT;
/**
* Link to an E-mail address
* May be deprecated in the future. Consider using {@link Hyperlink#LINK_EMAIL} instead.
*/
public static final int LINK_EMAIL = Hyperlink.LINK_EMAIL;
/**
* Link to a file
* May be deprecated in the future. Consider using {@link Hyperlink#LINK_FILE} instead.
*/
public static final int LINK_FILE = Hyperlink.LINK_FILE;
/**
* Low-level record object that stores the actual hyperlink data
*/
final protected HyperlinkRecord record;
/**
* If we create a new hyperlink remember its type
*/
final protected int link_type;
/**
* Construct a new hyperlink
*
* @param type the type of hyperlink to create
*/
public HSSFHyperlink( int type )
{
this.link_type = type;
record = new HyperlinkRecord();
switch(type){
case LINK_URL:
case LINK_EMAIL:
record.newUrlLink();
break;
case LINK_FILE:
record.newFileLink();
break;
case LINK_DOCUMENT:
record.newDocumentLink();
break;
default:
throw new IllegalArgumentException("Invalid type: " + type);
}
}
/**
* Initialize the hyperlink by a HyperlinkRecord record
*
* @param record
*/
protected HSSFHyperlink( HyperlinkRecord record )
{
this.record = record;
link_type = getType(record);
}
private int getType(HyperlinkRecord record) {
int link_type;
// Figure out the type
if (record.isFileLink()) {
link_type = LINK_FILE;
} else if(record.isDocumentLink()) {
link_type = LINK_DOCUMENT;
} else {
if(record.getAddress() != null &&
record.getAddress().startsWith("mailto:")) {
link_type = LINK_EMAIL;
} else {
link_type = LINK_URL;
}
}
return link_type;
}
protected HSSFHyperlink(Hyperlink other) {
if (other instanceof HSSFHyperlink) {
HSSFHyperlink hlink = (HSSFHyperlink) other;
record = hlink.record.clone();
link_type = getType(record);
}
else {
link_type = other.getType();
record = new HyperlinkRecord();
setFirstRow(other.getFirstRow());
setFirstColumn(other.getFirstColumn());
setLastRow(other.getLastRow());
setLastColumn(other.getLastColumn());
}
}
/**
* Return the row of the first cell that contains the hyperlink
*
* @return the 0-based row of the cell that contains the hyperlink
*/
@Override
public int getFirstRow(){
return record.getFirstRow();
}
/**
* Set the row of the first cell that contains the hyperlink
*
* @param row the 0-based row of the first cell that contains the hyperlink
*/
@Override
public void setFirstRow(int row){
record.setFirstRow(row);
}
/**
* Return the row of the last cell that contains the hyperlink
*
* @return the 0-based row of the last cell that contains the hyperlink
*/
@Override
public int getLastRow(){
return record.getLastRow();
}
/**
* Set the row of the last cell that contains the hyperlink
*
* @param row the 0-based row of the last cell that contains the hyperlink
*/
@Override
public void setLastRow(int row){
record.setLastRow(row);
}
/**
* Return the column of the first cell that contains the hyperlink
*
* @return the 0-based column of the first cell that contains the hyperlink
*/
@Override
public int getFirstColumn(){
return record.getFirstColumn();
}
/**
* Set the column of the first cell that contains the hyperlink
*
* @param col the 0-based column of the first cell that contains the hyperlink
*/
@Override
public void setFirstColumn(int col){
record.setFirstColumn((short)col);
}
/**
* Return the column of the last cell that contains the hyperlink
*
* @return the 0-based column of the last cell that contains the hyperlink
*/
@Override
public int getLastColumn(){
return record.getLastColumn();
}
/**
* Set the column of the last cell that contains the hyperlink
*
* @param col the 0-based column of the last cell that contains the hyperlink
*/
@Override
public void setLastColumn(int col){
record.setLastColumn((short)col);
}
/**
* Hyperlink address. Depending on the hyperlink type it can be URL, e-mail, path to a file, etc.
*
* @return the address of this hyperlink
*/
@Override
public String getAddress(){
return record.getAddress();
}
public String getTextMark(){
return record.getTextMark();
}
/**
* Convenience method equivalent to {@link #setAddress(String)}
*
* @param textMark the place in worksheet this hyperlink refers to, e.g. 'Target Sheet'!A1'
*/
public void setTextMark(String textMark) {
record.setTextMark(textMark);
}
public String getShortFilename(){
return record.getShortFilename();
}
/**
* Convenience method equivalent to {@link #setAddress(String)}
*
* @param shortFilename the path to a file this hyperlink points to, e.g. 'readme.txt'
*/
public void setShortFilename(String shortFilename) {
record.setShortFilename(shortFilename);
}
/**
* Hyperlink address. Depending on the hyperlink type it can be URL, e-mail, path to a file, etc.
*
* @param address the address of this hyperlink
*/
@Override
public void setAddress(String address){
record.setAddress(address);
}
/**
* Return text label for this hyperlink
*
* @return text to display
*/
@Override
public String getLabel(){
return record.getLabel();
}
/**
* Sets text label for this hyperlink
*
* @param label text label for this hyperlink
*/
@Override
public void setLabel(String label){
record.setLabel(label);
}
/**
* Return the type of this hyperlink
*
* @return the type of this hyperlink
*/
@Override
public int getType(){
return link_type;
}
/**
* @return whether the objects have the same HyperlinkRecord
*/
@Override
public boolean equals(Object other) {
if (this == other) return true;
if (!(other instanceof HSSFHyperlink)) return false;
HSSFHyperlink otherLink = (HSSFHyperlink) other;
return record == otherLink.record;
}
@Override
public int hashCode() {
return record.hashCode();
}
}