Package org.apache.poi.hssf.record
Class HyperlinkRecord
java.lang.Object
org.apache.poi.hssf.record.RecordBase
org.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.StandardRecord
org.apache.poi.hssf.record.HyperlinkRecord
- All Implemented Interfaces:
Cloneable
The
HyperlinkRecord
(0x01B8) wraps an HLINK-record
from the Excel-97 format.
Supports only external links for now (eg http://)-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionCreate a new hyperlink -
Method Summary
Modifier and TypeMethodDescriptionclone()
Hyperlink address.protected int
int
int
int
getLabel()
Return text label for this hyperlinkint
int
int
short
getSid()
return the non static version of the id for this record.boolean
Based on the link options, is this a document?boolean
Based on the link options, is this a file?boolean
Based on the link options, is this a url?void
Initialize a new document linkvoid
Initialize a new file linkvoid
Initialize a new url linkvoid
Write the data content of this BIFF record.void
setAddress
(String address) Hyperlink address.void
setFirstColumn
(int firstCol) Set the first column (zero-based) of the range that contains this hyperlinkvoid
setFirstRow
(int firstRow) Set the first row (zero-based) of the range that contains this hyperlinkvoid
Sets text label for this hyperlinkvoid
setLastColumn
(int lastCol) Set the last column (zero-based) of the range that contains this hyperlinkvoid
setLastRow
(int lastRow) Set the last row (zero-based) of the range that contains this hyperlinkvoid
setShortFilename
(String shortFilename) void
setTextMark
(String textMark) toString()
get a string representation of the record (for biffview/debugging)Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serialize
Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
-
Constructor Details
-
HyperlinkRecord
public HyperlinkRecord()Create a new hyperlink -
HyperlinkRecord
-
-
Method Details
-
getFirstColumn
public int getFirstColumn()- Returns:
- the 0-based column of the first cell that contains this hyperlink
-
setFirstColumn
public void setFirstColumn(int firstCol) Set the first column (zero-based) of the range that contains this hyperlink- Parameters:
firstCol
- the first column (zero-based)
-
getLastColumn
public int getLastColumn()- Returns:
- the 0-based column of the last cell that contains this hyperlink
-
setLastColumn
public void setLastColumn(int lastCol) Set the last column (zero-based) of the range that contains this hyperlink- Parameters:
lastCol
- the last column (zero-based)
-
getFirstRow
public int getFirstRow()- Returns:
- the 0-based row of the first cell that contains this hyperlink
-
setFirstRow
public void setFirstRow(int firstRow) Set the first row (zero-based) of the range that contains this hyperlink- Parameters:
firstRow
- the first row (zero-based)
-
getLastRow
public int getLastRow()- Returns:
- the 0-based row of the last cell that contains this hyperlink
-
setLastRow
public void setLastRow(int lastRow) Set the last row (zero-based) of the range that contains this hyperlink- Parameters:
lastRow
- the last row (zero-based)
-
getLabel
Return text label for this hyperlink- Returns:
- text to display
-
setLabel
Sets text label for this hyperlink- Parameters:
label
- text label for this hyperlink
-
getTargetFrame
-
getAddress
Hyperlink address. Depending on the hyperlink type it can be URL, e-mail, path to a file, etc.- Returns:
- the address of this hyperlink
-
setAddress
Hyperlink address. Depending on the hyperlink type it can be URL, e-mail, path to a file, etc.- Parameters:
address
- the address of this hyperlink
-
getShortFilename
-
setShortFilename
-
getTextMark
-
setTextMark
-
getLabelOptions
public int getLabelOptions()- Returns:
- Label options
-
getFileOptions
public int getFileOptions()- Returns:
- Options for a file link
-
serialize
Description copied from class:StandardRecord
Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.The number of bytes written must equal the record size reported by
RecordBase.getRecordSize()
} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).- Specified by:
serialize
in classStandardRecord
- Parameters:
out
- the output object
-
getDataSize
protected int getDataSize()- Specified by:
getDataSize
in classStandardRecord
-
getSid
public short getSid()Description copied from class:Record
return the non static version of the id for this record. -
toString
Description copied from class:Record
get a string representation of the record (for biffview/debugging) -
isUrlLink
public boolean isUrlLink()Based on the link options, is this a url?- Returns:
- true, if this is a url link
-
isFileLink
public boolean isFileLink()Based on the link options, is this a file?- Returns:
- true, if this is a file link
-
isDocumentLink
public boolean isDocumentLink()Based on the link options, is this a document?- Returns:
- true, if this is a docment link
-
newUrlLink
public void newUrlLink()Initialize a new url link -
newFileLink
public void newFileLink()Initialize a new file link -
newDocumentLink
public void newDocumentLink()Initialize a new document link -
clone
-