Modifier and Type | Field and Description |
---|---|
static int |
LINK_DOCUMENT
Link to a place in this document
May be deprecated in the future.
|
static int |
LINK_EMAIL
Link to an E-mail address
May be deprecated in the future.
|
static int |
LINK_FILE
Link to a file
May be deprecated in the future.
|
protected int |
link_type
If we create a new hyperlink remember its type
|
static int |
LINK_URL
Link to an existing file or web page
May be deprecated in the future.
|
protected HyperlinkRecord |
record
Low-level record object that stores the actual hyperlink data
|
Modifier | Constructor and Description |
---|---|
protected |
HSSFHyperlink(Hyperlink other) |
protected |
HSSFHyperlink(HyperlinkRecord record)
Initialize the hyperlink by a
HyperlinkRecord record |
|
HSSFHyperlink(int type)
Construct a new hyperlink
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object other) |
java.lang.String |
getAddress()
Hyperlink address.
|
int |
getFirstColumn()
Return the column of the first cell that contains the hyperlink
|
int |
getFirstRow()
Return the row of the first cell that contains the hyperlink
|
java.lang.String |
getLabel()
Return text label for this hyperlink
|
int |
getLastColumn()
Return the column of the last cell that contains the hyperlink
|
int |
getLastRow()
Return the row of the last cell that contains the hyperlink
|
java.lang.String |
getShortFilename() |
java.lang.String |
getTextMark() |
int |
getType()
Return the type of this hyperlink
|
int |
hashCode() |
void |
setAddress(java.lang.String address)
Hyperlink address.
|
void |
setFirstColumn(int col)
Set the column of the first cell that contains the hyperlink
|
void |
setFirstRow(int row)
Set the row of the first cell that contains the hyperlink
|
void |
setLabel(java.lang.String label)
Sets text label for this hyperlink
|
void |
setLastColumn(int col)
Set the column of the last cell that contains the hyperlink
|
void |
setLastRow(int row)
Set the row of the last cell that contains the hyperlink
|
void |
setShortFilename(java.lang.String shortFilename)
Convenience method equivalent to
setAddress(String) |
void |
setTextMark(java.lang.String textMark)
Convenience method equivalent to
setAddress(String) |
public static final int LINK_URL
Hyperlink.LINK_URL
instead.public static final int LINK_DOCUMENT
Hyperlink.LINK_DOCUMENT
instead.public static final int LINK_EMAIL
Hyperlink.LINK_EMAIL
instead.public static final int LINK_FILE
Hyperlink.LINK_FILE
instead.protected final HyperlinkRecord record
protected final int link_type
public HSSFHyperlink(int type)
type
- the type of hyperlink to createprotected HSSFHyperlink(HyperlinkRecord record)
HyperlinkRecord
recordrecord
- protected HSSFHyperlink(Hyperlink other)
public int getFirstRow()
public void setFirstRow(int row)
row
- the 0-based row of the first cell that contains the hyperlinkpublic int getLastRow()
public void setLastRow(int row)
row
- the 0-based row of the last cell that contains the hyperlinkpublic int getFirstColumn()
public void setFirstColumn(int col)
col
- the 0-based column of the first cell that contains the hyperlinkpublic int getLastColumn()
public void setLastColumn(int col)
col
- the 0-based column of the last cell that contains the hyperlinkpublic java.lang.String getAddress()
getAddress
in interface Hyperlink
public java.lang.String getTextMark()
public void setTextMark(java.lang.String textMark)
setAddress(String)
textMark
- the place in worksheet this hyperlink refers to, e.g. 'Target Sheet'!A1'public java.lang.String getShortFilename()
public void setShortFilename(java.lang.String shortFilename)
setAddress(String)
shortFilename
- the path to a file this hyperlink points to, e.g. 'readme.txt'public void setAddress(java.lang.String address)
setAddress
in interface Hyperlink
address
- the address of this hyperlinkpublic java.lang.String getLabel()
public void setLabel(java.lang.String label)
public int getType()
public boolean equals(java.lang.Object other)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
Copyright 2016 The Apache Software Foundation or its licensors, as applicable.