Apache POI - Common 5.3.0 · org.apache.poi.hssf.record.HyperlinkRecord

Field Summary

Modifier and Type	Field and Description
private String	_address Link
private int	_fileOpts Some sort of options for file links.
private ClassID	_guid 16-byte GUID
private String	_label Test label
private int	_linkOpts Link options.
private ClassID	_moniker Moniker.
private CellRangeAddress	_range cell range of this hyperlink
private String	_shortFilename in 8:3 DOS format No Unicode string header, always 8-bit characters, zero-terminated
private String	_targetFrame
private String	_textMark Text describing a place in document.
private byte[]	_uninterpretedTail
private static final byte[]	FILE_TAIL expected Tail of a file link
pack-priv static final int	HLINK_ABS
pack-priv static final int	HLINK_LABEL
pack-priv static final int	HLINK_PLACE Place in worksheet.
private static final int	HLINK_TARGET_FRAME
private static final int	HLINK_UNC_PATH
pack-priv static final int	HLINK_URL
private static final Logger	LOG
public static final short	sid
private static final int	TAIL_SIZE
private static final byte[]	URL_TAIL expected Tail of a URL link

Constructor Summary

Access	Constructor and Description
public	HyperlinkRecord() Create a new hyperlink
public	HyperlinkRecord(HyperlinkRecord other)
public	HyperlinkRecord(RecordInputStream in)

Method Summary

Modifier and Type	Method and Description
private static String	appendNullTerm(String s)
private static String	cleanString(String s)
public HyperlinkRecord	copy() Implements abstract org.apache.poi.hssf.record.StandardRecord.copy. Implements org.apache.poi.common.Duplicatable.copy.
public String	Returns: the address of this hyperlink getAddress() Hyperlink address.
protected int	getDataSize() Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.
public int	Returns: Options for a file link getFileOptions()
public int	Returns: the 0-based column of the first cell that contains this hyperlink getFirstColumn()
public int	Returns: the 0-based row of the first cell that contains this hyperlink getFirstRow()
public Map<String, Supplier<?>>	getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.
public HSSFRecordTypes	getGenericRecordType() Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType. Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.
pack-priv ClassID	Returns: 16-byte guid identifier Seems to always equal `ClassIDPredefined#STD_MONIKER` getGuid()
public String	Returns: text to display getLabel() Return text label for this hyperlink
public int	Returns: Label options getLabelOptions()
public int	Returns: the 0-based column of the last cell that contains this hyperlink getLastColumn()
public int	Returns: the 0-based row of the last cell that contains this hyperlink getLastRow()
pack-priv int	Returns: Link options getLinkOptions() Link options.
pack-priv ClassID	Returns: 16-byte moniker getMoniker()
public String	getShortFilename()
public short	getSid() Implements abstract org.apache.poi.hssf.record.Record.getSid. return the non static version of the id for this record.
public String	getTargetFrame()
public String	getTextMark()
public boolean	Returns: true, if this is a docment link isDocumentLink() Based on the link options, is this a document?
public boolean	Returns: true, if this is a file link isFileLink() Based on the link options, is this a file?
public boolean	Returns: true, if this is a url link isUrlLink() Based on the link options, is this a url?
public void	newDocumentLink() Initialize a new document link
public void	newFileLink() Initialize a new file link
public void	newUrlLink() Initialize a new url link
private static byte[]	readTail(byte[] expectedTail, LittleEndianInput in)
public void	serialize(LittleEndianOutput the output object out) Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize. Write the data content of this BIFF record.
public void	setAddress(String the address of this hyperlink address) Hyperlink address.
public void	setFirstColumn(int the first column (zero-based) firstCol) Set the first column (zero-based) of the range that contains this hyperlink
public void	setFirstRow(int the first row (zero-based) firstRow) Set the first row (zero-based) of the range that contains this hyperlink
public void	setLabel(String text label for this hyperlink label) Sets text label for this hyperlink
public void	setLastColumn(int the last column (zero-based) lastCol) Set the last column (zero-based) of the range that contains this hyperlink
public void	setLastRow(int the last row (zero-based) lastRow) Set the last row (zero-based) of the range that contains this hyperlink
public void	setShortFilename(String shortFilename)
public void	setTextMark(String textMark)
private static void	writeTail(byte[] tail, LittleEndianOutput out)

Inherited from org.apache.poi.hssf.record.StandardRecord:: getRecordSize serialize

Field Detail

_address	back to summary
private String _address Link

_fileOpts	back to summary
private int _fileOpts Some sort of options for file links.

_guid	back to summary
private ClassID _guid 16-byte GUID

_label	back to summary
private String _label Test label

_linkOpts	back to summary
private int _linkOpts Link options. Can include any of HLINK_* flags.

_moniker	back to summary
private ClassID _moniker Moniker. Makes sense only for URL and file links

_range	back to summary
private CellRangeAddress _range cell range of this hyperlink

_shortFilename	back to summary
private String _shortFilename in 8:3 DOS format No Unicode string header, always 8-bit characters, zero-terminated

_targetFrame	back to summary
private String _targetFrame

_textMark	back to summary
private String _textMark Text describing a place in document. In Excel UI, this is appended to the address, (after a '#' delimiter). This field is optional. If present, the `HLINK_PLACE` must be set.

_uninterpretedTail	back to summary
private byte[] _uninterpretedTail

FILE_TAIL	back to summary
private static final byte[] FILE_TAIL expected Tail of a file link

HLINK_ABS	back to summary
pack-priv static final int HLINK_ABS

HLINK_LABEL	back to summary
pack-priv static final int HLINK_LABEL

HLINK_PLACE	back to summary
pack-priv static final int HLINK_PLACE Place in worksheet. If set, the `_textMark` field will be present

HLINK_TARGET_FRAME	back to summary
private static final int HLINK_TARGET_FRAME

HLINK_UNC_PATH	back to summary
private static final int HLINK_UNC_PATH

HLINK_URL	back to summary
pack-priv static final int HLINK_URL

LOG	back to summary
private static final Logger LOG

sid	back to summary
public static final short sid

TAIL_SIZE	back to summary
private static final int TAIL_SIZE

URL_TAIL	back to summary
private static final byte[] URL_TAIL expected Tail of a URL link

Constructor Detail

HyperlinkRecord	back to summary
public HyperlinkRecord() Create a new hyperlink

HyperlinkRecord	back to summary
public HyperlinkRecord(HyperlinkRecord other)

HyperlinkRecord	back to summary
public HyperlinkRecord(RecordInputStream in)

Method Detail

appendNullTerm	back to summary
private static String appendNullTerm(String s)

cleanString	back to summary
private static String cleanString(String s)

copy	back to summary
public HyperlinkRecord copy() Implements abstract org.apache.poi.hssf.record.StandardRecord.copy. Implements org.apache.poi.common.Duplicatable.copy. Returns:HyperlinkRecord Doc from org.apache.poi.common.Duplicatable.copy. a deep copy of the implementing class / instance Annotations @Override

copy

back to summary

public HyperlinkRecord copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:HyperlinkRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations

@Override

getAddress	back to summary
public String getAddress() Hyperlink address. Depending on the hyperlink type it can be URL, e-mail, path to a file, etc. Returns:String the address of this hyperlink

getAddress

back to summary

public String getAddress()

Hyperlink address. Depending on the hyperlink type it can be URL, e-mail, path to a file, etc.

Returns:String: the address of this hyperlink

getDataSize	back to summary
protected int getDataSize() Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize. Annotations @Override

getDataSize

back to summary

protected int getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

Annotations

@Override

getFileOptions	back to summary
public int getFileOptions() Returns:int Options for a file link

getFirstColumn	back to summary
public int getFirstColumn() Returns:int the 0-based column of the first cell that contains this hyperlink

getFirstRow	back to summary
public int getFirstRow() Returns:int the 0-based row of the first cell that contains this hyperlink

getGenericProperties	back to summary
public Map<String, Supplier<?>> getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties. Annotations @Override

getGenericProperties

back to summary

public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations

@Override

getGenericRecordType	back to summary
public HSSFRecordTypes getGenericRecordType() Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType. Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType. Annotations @Override

getGenericRecordType

back to summary

public HSSFRecordTypes getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

Annotations

@Override

getGuid	back to summary
pack-priv ClassID getGuid() Returns:ClassID 16-byte guid identifier Seems to always equal `ClassIDPredefined#STD_MONIKER`

getLabel	back to summary
public String getLabel() Return text label for this hyperlink Returns:String text to display

getLabel

back to summary

public String getLabel()

Return text label for this hyperlink

Returns:String: text to display

getLabelOptions	back to summary
public int getLabelOptions() Returns:int Label options

getLastColumn	back to summary
public int getLastColumn() Returns:int the 0-based column of the last cell that contains this hyperlink

getLastRow	back to summary
public int getLastRow() Returns:int the 0-based row of the last cell that contains this hyperlink

getLinkOptions	back to summary
pack-priv int getLinkOptions() Link options. Must be a combination of HLINK_* constants. For testing only Returns:int Link options

getLinkOptions

back to summary

pack-priv int getLinkOptions()

Link options. Must be a combination of HLINK_* constants. For testing only

Returns:int: Link options

getMoniker	back to summary
pack-priv ClassID getMoniker() Returns:ClassID 16-byte moniker

getShortFilename	back to summary
public String getShortFilename()

getSid	back to summary
public short getSid() Implements abstract org.apache.poi.hssf.record.Record.getSid. Doc from org.apache.poi.hssf.record.Record.getSid. return the non static version of the id for this record. Returns:short he id for this record Annotations @Override

getSid

back to summary

public short getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

Doc from org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

Returns:short

he id for this record

Annotations

@Override

getTargetFrame	back to summary
public String getTargetFrame()

getTextMark	back to summary
public String getTextMark()

isDocumentLink	back to summary
public boolean isDocumentLink() Based on the link options, is this a document? Returns:boolean true, if this is a docment link

isDocumentLink

back to summary

public boolean isDocumentLink()

Based on the link options, is this a document?

Returns:boolean: true, if this is a docment link

isFileLink

back to summary

public boolean isFileLink()

Based on the link options, is this a file?

Returns:boolean: true, if this is a file link

isUrlLink

back to summary

public boolean isUrlLink()

Based on the link options, is this a url?

Returns:boolean

true, if this is a url link

Annotations

@SuppressWarnings:unused

newDocumentLink	back to summary
public void newDocumentLink() Initialize a new document link

newFileLink	back to summary
public void newFileLink() Initialize a new file link

newUrlLink	back to summary
public void newUrlLink() Initialize a new url link

readTail	back to summary
private static byte[] readTail(byte[] expectedTail, LittleEndianInput in)

serialize back to summary

public void serialize(LittleEndianOutput out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Doc from org.apache.poi.hssf.record.StandardRecord.serialize.

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 org.apache.poi.hssf.record.Record#getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Parameters

out:LittleEndianOutput: the output object

Annotations

@Override

setAddress

back to summary

public void setAddress(String address)

Hyperlink address. Depending on the hyperlink type it can be URL, e-mail, path to a file, etc.

Parameters

address:String: the address of this hyperlink

setFirstColumn

back to summary

public void setFirstColumn(int firstCol)

Set the first column (zero-based) of the range that contains this hyperlink

Parameters

firstCol:int: the first column (zero-based)

setFirstRow

back to summary

public void setFirstRow(int firstRow)

Set the first row (zero-based) of the range that contains this hyperlink

Parameters

firstRow:int: the first row (zero-based)

setLabel

back to summary

public void setLabel(String label)

Sets text label for this hyperlink

Parameters

label:String: text label for this hyperlink

setLastColumn

back to summary

public void setLastColumn(int lastCol)

Set the last column (zero-based) of the range that contains this hyperlink

Parameters

lastCol:int: the last column (zero-based)

setLastRow

back to summary

public void setLastRow(int lastRow)

Set the last row (zero-based) of the range that contains this hyperlink

Parameters

lastRow:int: the last row (zero-based)

setShortFilename	back to summary
public void setShortFilename(String shortFilename)

setTextMark	back to summary
public void setTextMark(String textMark)

writeTail	back to summary
private static void writeTail(byte[] tail, LittleEndianOutput out)

public final Class HyperlinkRecord

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail