Package org.apache.poi.hssf.usermodel
Class HSSFHyperlink
java.lang.Object
org.apache.poi.hssf.usermodel.HSSFHyperlink
Represents an Excel hyperlink.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final HyperlinkType
If we create a new hyperlink remember its typeprotected final HyperlinkRecord
Low-level record object that stores the actual hyperlink data -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
HSSFHyperlink
(HyperlinkType type) Construct a new hyperlink This method is internal to be used only byHSSFCreationHelper.createHyperlink(HyperlinkType)
.protected
HSSFHyperlink
(HyperlinkRecord record) Initialize the hyperlink by aHyperlinkRecord
recordprotected
HSSFHyperlink
(Hyperlink other) -
Method Summary
Modifier and TypeMethodDescriptionboolean
Hyperlink address.int
Return the column of the first cell that contains the hyperlinkint
Return the row of the first cell that contains the hyperlinkgetLabel()
Return text label for this hyperlinkint
Return the column of the last cell that contains the hyperlinkint
Return the row of the last cell that contains the hyperlinkgetType()
Return the type of this hyperlinkDeprecated.int
hashCode()
void
setAddress
(String address) Hyperlink address.void
setFirstColumn
(int col) Set the column of the first cell that contains the hyperlinkvoid
setFirstRow
(int row) Set the row of the first cell that contains the hyperlinkvoid
Sets text label for this hyperlinkvoid
setLastColumn
(int col) Set the column of the last cell that contains the hyperlinkvoid
setLastRow
(int row) Set the row of the last cell that contains the hyperlinkvoid
setShortFilename
(String shortFilename) Convenience method equivalent tosetAddress(String)
void
setTextMark
(String textMark) Convenience method equivalent tosetAddress(String)
-
Field Details
-
record
Low-level record object that stores the actual hyperlink data -
link_type
If we create a new hyperlink remember its type
-
-
Constructor Details
-
HSSFHyperlink
Construct a new hyperlink This method is internal to be used only byHSSFCreationHelper.createHyperlink(HyperlinkType)
.- Parameters:
type
- the type of hyperlink to create
-
HSSFHyperlink
Initialize the hyperlink by aHyperlinkRecord
record- Parameters:
record
-
-
HSSFHyperlink
-
-
Method Details
-
getFirstRow
public int getFirstRow()Return the row of the first cell that contains the hyperlink- Specified by:
getFirstRow
in interfaceHyperlink
- Returns:
- the 0-based row of the cell that contains the hyperlink
-
setFirstRow
public void setFirstRow(int row) Set the row of the first cell that contains the hyperlink- Specified by:
setFirstRow
in interfaceHyperlink
- Parameters:
row
- the 0-based row of the first cell that contains the hyperlink
-
getLastRow
public int getLastRow()Return the row of the last cell that contains the hyperlink- Specified by:
getLastRow
in interfaceHyperlink
- Returns:
- the 0-based row of the last cell that contains the hyperlink
-
setLastRow
public void setLastRow(int row) Set the row of the last cell that contains the hyperlink- Specified by:
setLastRow
in interfaceHyperlink
- Parameters:
row
- the 0-based row of the last cell that contains the hyperlink
-
getFirstColumn
public int getFirstColumn()Return the column of the first cell that contains the hyperlink- Specified by:
getFirstColumn
in interfaceHyperlink
- Returns:
- the 0-based column of the first cell that contains the hyperlink
-
setFirstColumn
public void setFirstColumn(int col) Set the column of the first cell that contains the hyperlink- Specified by:
setFirstColumn
in interfaceHyperlink
- Parameters:
col
- the 0-based column of the first cell that contains the hyperlink
-
getLastColumn
public int getLastColumn()Return the column of the last cell that contains the hyperlink- Specified by:
getLastColumn
in interfaceHyperlink
- Returns:
- the 0-based column of the last cell that contains the hyperlink
-
setLastColumn
public void setLastColumn(int col) Set the column of the last cell that contains the hyperlink- Specified by:
setLastColumn
in interfaceHyperlink
- Parameters:
col
- the 0-based column of the last cell that contains the hyperlink
-
getAddress
Hyperlink address. Depending on the hyperlink type it can be URL, e-mail, path to a file, etc.- Specified by:
getAddress
in interfaceHyperlink
- Returns:
- the address of this hyperlink
-
getTextMark
-
setTextMark
Convenience method equivalent tosetAddress(String)
- Parameters:
textMark
- the place in worksheet this hyperlink refers to, e.g. 'Target Sheet'!A1'
-
getShortFilename
-
setShortFilename
Convenience method equivalent tosetAddress(String)
- Parameters:
shortFilename
- the path to a file this hyperlink points to, e.g. 'readme.txt'
-
setAddress
Hyperlink address. Depending on the hyperlink type it can be URL, e-mail, path to a file, etc.- Specified by:
setAddress
in interfaceHyperlink
- Parameters:
address
- the address of this hyperlink
-
getLabel
Return text label for this hyperlink -
setLabel
Sets text label for this hyperlink -
getType
Return the type of this hyperlink -
getTypeEnum
Deprecated.usegetType()
insteadReturn the type of this hyperlink- Specified by:
getTypeEnum
in interfaceHyperlink
- Returns:
- the type of this hyperlink
-
equals
-
hashCode
public int hashCode()
-
getType()
instead