src/java/org/apache/poi/hssf/usermodel/HSSFHyperlink.java

   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
   9        http://www.apache.org/licenses/LICENSE-2.0
  10
  11    Unless required by applicable law or agreed to in writing, software
  12    distributed under the License is distributed on an "AS IS" BASIS,
  13    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14    See the License for the specific language governing permissions and
  15    limitations under the License.
  16 ==================================================================== */
  17 package org.apache.poi.hssf.usermodel;
  18
  19 import org.apache.poi.hssf.record.EscherAggregate;
  20 import org.apache.poi.hssf.record.NoteRecord;
  21 import org.apache.poi.hssf.record.TextObjectRecord;
  22 import org.apache.poi.hssf.record.HyperlinkRecord;
  23 import org.apache.poi.ddf.*;
  24
  25 import java.util.Map;
  26 import java.util.List;
  27 import java.util.Iterator;
  28
  29 /**
  30  * Represents an Excel hyperlink.
  31  *
  32  * @author Yegor Kozlov (yegor at apache dot org)
  33  */
  34 public class HSSFHyperlink {
  35
  36     /**
  37      * Link to a existing file or web page
  38      */
  39     public static final int LINK_URL = 1;
  40
  41     /**
  42      * Link to a place in this document
  43      */
  44     public static final int LINK_DOCUMENT = 2;
  45
  46     /**
  47      * Link to an E-mail address
  48      */
  49     public static final int LINK_EMAIL = 3;
  50
  51     /**
  52      * Link to a file
  53      */
  54     public static final int LINK_FILE = 4;
  55
  56     /**
  57      * Low-level record object that stores the actual hyperlink data
  58      */
  59     protected HyperlinkRecord record = null;
  60
  61     /**
  62      * If we create a new hypelrink remember its type
  63      */
  64     protected int link_type;
  65
  66     /**
  67      * Construct a new hyperlink
  68      *
  69      * @param type the type of hyperlink to create
  70      */
  71     public HSSFHyperlink( int type )
  72     {
  73         this.link_type = type;
  74         record = new HyperlinkRecord();
  75         switch(type){
  76             case LINK_URL:
  77             case LINK_EMAIL:
  78                 record.newUrlLink();
  79                 break;
  80             case LINK_FILE:
  81                 record.newFileLink();
  82                 break;
  83             case LINK_DOCUMENT:
  84                 record.newDocumentLink();
  85                 break;
  86         }
  87     }
  88
  89     /**
  90      * Initialize the hyperlink by a <code>HyperlinkRecord</code> record
  91      *
  92      * @param record
  93      */
  94     protected HSSFHyperlink( HyperlinkRecord record )
  95     {
  96         this.record = record;
  97     }
  98
  99     /**
 100      * Return the row of the first cell that contains the hyperlink
 101      *
 102      * @return the 0-based row of the cell that contains the hyperlink
 103      */
 104     public int getFirstRow(){
 105         return record.getFirstRow();
 106     }
 107
 108     /**
 109      * Set the row of the first cell that contains the hyperlink
 110      *
 111      * @param row the 0-based row of the first cell that contains the hyperlink
 112      */
 113     public void setFirstRow(int row){
 114         record.setFirstRow(row);
 115     }
 116
 117     /**
 118      * Return the row of the last cell that contains the hyperlink
 119      *
 120      * @return the 0-based row of the last cell that contains the hyperlink
 121      */
 122     public int getLastRow(){
 123         return record.getLastRow();
 124     }
 125
 126     /**
 127      * Set the row of the last cell that contains the hyperlink
 128      *
 129      * @param row the 0-based row of the last cell that contains the hyperlink
 130      */
 131     public void setLastRow(int row){
 132         record.setLastRow(row);
 133     }
 134
 135     /**
 136      * Return the column of the first cell that contains the hyperlink
 137      *
 138      * @return the 0-based column of the first cell that contains the hyperlink
 139      */
 140     public short getFirstColumn(){
 141         return record.getFirstColumn();
 142     }
 143
 144     /**
 145      * Set the column of the first cell that contains the hyperlink
 146      *
 147      * @param col the 0-based column of the first cell that contains the hyperlink
 148      */
 149     public void setFirstColumn(short col){
 150         record.setFirstColumn(col);
 151     }
 152
 153     /**
 154      * Return the column of the last cell that contains the hyperlink
 155      *
 156      * @return the 0-based column of the last cell that contains the hyperlink
 157      */
 158     public short getLastColumn(){
 159         return record.getLastColumn();
 160     }
 161
 162     /**
 163      * Set the column of the last cell that contains the hyperlink
 164      *
 165      * @param col the 0-based column of the last cell that contains the hyperlink
 166      */
 167     public void setLastColumn(short col){
 168         record.setLastColumn(col);
 169     }
 170
 171     /**
 172      * Hypelink address. Depending on the hyperlink type it can be URL, e-mail, patrh to a file, etc.
 173      *
 174      * @return  the address of this hyperlink
 175      */
 176     public String getAddress(){
 177         return record.getAddress();
 178     }
 179
 180     /**
 181      * Hypelink address. Depending on the hyperlink type it can be URL, e-mail, patrh to a file, etc.
 182      *
 183      * @param address  the address of this hyperlink
 184      */
 185     public void setAddress(String address){
 186         record.setAddress(address);
 187     }
 188
 189     /**
 190      * Return text label for this hyperlink
 191      *
 192      * @return  text to display
 193      */
 194     public String getLabel(){
 195         return record.getLabel();
 196     }
 197
 198     /**
 199      * Sets text label for this hyperlink
 200      *
 201      * @param label text label for this hyperlink
 202      */
 203     public void setLabel(String label){
 204         record.setLabel(label);
 205     }
 206
 207     /**
 208      * Return the type of this hyperlink
 209      *
 210      * @return the type of this hyperlink
 211      */
 212     protected int getType(){
 213         return link_type;
 214     }
 215 }