public final class HyperlinkRecord extends StandardRecord implements Cloneable
HyperlinkRecord
(0x01B8) wraps an HLINK-record
from the Excel-97 format.
Supports only external links for now (eg http://)Modifier and Type | Field and Description |
---|---|
static short |
sid |
Constructor and Description |
---|
HyperlinkRecord()
Create a new hyperlink
|
HyperlinkRecord(RecordInputStream in) |
Modifier and Type | Method and Description |
---|---|
HyperlinkRecord |
clone() |
String |
getAddress()
Hyperlink address.
|
int |
getFileOptions() |
int |
getFirstColumn() |
int |
getFirstRow() |
String |
getLabel()
Return text label for this hyperlink
|
int |
getLabelOptions() |
int |
getLastColumn() |
int |
getLastRow() |
String |
getShortFilename() |
short |
getSid()
return the non static version of the id for this record.
|
String |
getTargetFrame() |
String |
getTextMark() |
boolean |
isDocumentLink()
Based on the link options, is this a document?
|
boolean |
isFileLink()
Based on the link options, is this a file?
|
boolean |
isUrlLink()
Based on the link options, is this a url?
|
void |
newDocumentLink()
Initialize a new document link
|
void |
newFileLink()
Initialize a new file link
|
void |
newUrlLink()
Initialize a new url link
|
void |
serialize(LittleEndianOutput out)
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 hyperlink
|
void |
setFirstRow(int firstRow)
Set the first row (zero-based) of the range that contains this hyperlink
|
void |
setLabel(String label)
Sets text label for this hyperlink
|
void |
setLastColumn(int lastCol)
Set the last column (zero-based) of the range that contains this hyperlink
|
void |
setLastRow(int lastRow)
Set the last row (zero-based) of the range that contains this hyperlink
|
void |
setShortFilename(String shortFilename) |
void |
setTextMark(String textMark) |
String |
toString()
get a string representation of the record (for biffview/debugging)
|
getRecordSize, serialize
cloneViaReserialise, serialize
public static final short sid
public HyperlinkRecord()
public HyperlinkRecord(RecordInputStream in)
public int getFirstColumn()
public void setFirstColumn(int firstCol)
firstCol
- the first column (zero-based)public int getLastColumn()
public void setLastColumn(int lastCol)
lastCol
- the last column (zero-based)public int getFirstRow()
public void setFirstRow(int firstRow)
firstRow
- the first row (zero-based)public int getLastRow()
public void setLastRow(int lastRow)
lastRow
- the last row (zero-based)public String getLabel()
public void setLabel(String label)
label
- text label for this hyperlinkpublic String getTargetFrame()
public String getAddress()
public void setAddress(String address)
address
- the address of this hyperlinkpublic String getShortFilename()
public void setShortFilename(String shortFilename)
public String getTextMark()
public void setTextMark(String textMark)
public int getLabelOptions()
public int getFileOptions()
public void serialize(LittleEndianOutput out)
StandardRecord
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).
out
- the output objectpublic short getSid()
Record
public String toString()
Record
public boolean isUrlLink()
public boolean isFileLink()
public boolean isDocumentLink()
public void newUrlLink()
public void newFileLink()
public void newDocumentLink()
public HyperlinkRecord clone()
Copyright © 2010 - 2020 Adobe. All Rights Reserved