public final class HyperlinkRecord extends StandardRecord
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(HyperlinkRecord other) |
HyperlinkRecord(RecordInputStream in) |
Modifier and Type | Method and Description |
---|---|
HyperlinkRecord |
copy() |
java.lang.String |
getAddress()
Hyperlink address.
|
protected int |
getDataSize() |
int |
getFileOptions() |
int |
getFirstColumn() |
int |
getFirstRow() |
java.util.Map<java.lang.String,java.util.function.Supplier<?>> |
getGenericProperties() |
HSSFRecordTypes |
getGenericRecordType() |
java.lang.String |
getLabel()
Return text label for this hyperlink
|
int |
getLabelOptions() |
int |
getLastColumn() |
int |
getLastRow() |
java.lang.String |
getShortFilename() |
short |
getSid()
return the non static version of the id for this record.
|
java.lang.String |
getTargetFrame() |
java.lang.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(java.lang.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(java.lang.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(java.lang.String shortFilename) |
void |
setTextMark(java.lang.String textMark) |
getRecordSize, serialize
cloneViaReserialise, serialize, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getGenericChildren
public static final short sid
public HyperlinkRecord()
public HyperlinkRecord(HyperlinkRecord other)
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 java.lang.String getLabel()
public void setLabel(java.lang.String label)
label
- text label for this hyperlinkpublic java.lang.String getTargetFrame()
public java.lang.String getAddress()
public void setAddress(java.lang.String address)
address
- the address of this hyperlinkpublic java.lang.String getShortFilename()
public void setShortFilename(java.lang.String shortFilename)
public java.lang.String getTextMark()
public void setTextMark(java.lang.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).
serialize
in class StandardRecord
out
- the output objectprotected int getDataSize()
getDataSize
in class StandardRecord
public short getSid()
Record
public boolean isUrlLink()
public boolean isFileLink()
public boolean isDocumentLink()
public void newUrlLink()
public void newFileLink()
public void newDocumentLink()
public HyperlinkRecord copy()
copy
in interface Duplicatable
copy
in class StandardRecord
public HSSFRecordTypes getGenericRecordType()
getGenericRecordType
in interface GenericRecord
getGenericRecordType
in class Record
public java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()
Copyright 2022 The Apache Software Foundation or its licensors, as applicable.