org.apache.poi.hssf.record

Class ExternalNameRecord

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.ExternalNameRecord

All Implemented Interfaces:

Duplicatable, GenericRecord

public final class ExternalNameRecord
extends StandardRecord

EXTERNALNAME (0x0023)

Field Summary

Fields

Modifier and Type	Field and Description
static short	sid

Constructor Summary

Constructors

Constructor and Description
ExternalNameRecord()
ExternalNameRecord(ExternalNameRecord other)
ExternalNameRecord(RecordInputStream in)

Method Summary

Modifier and Type	Method and Description
ExternalNameRecord	copy()
protected int	getDataSize()
java.util.Map<java.lang.String,java.util.function.Supplier<?>>	getGenericProperties()
HSSFRecordTypes	getGenericRecordType()
short	getIx() If this is a local name, then this is the (1 based) index of the name of the Sheet this refers to, as defined in the preceding SupBookRecord.
Ptg[]	getParsedExpression()
short	getSid() return the non static version of the id for this record.
java.lang.String	getText()
boolean	isAutomaticLink() For OLE and DDE, links can be either 'automatic' or 'manual'
boolean	isBuiltInName()
boolean	isIconifiedPictureLink()
boolean	isOLELink()
boolean	isPicureLink() only for OLE and DDE
boolean	isStdDocumentNameIdentifier() DDE links only.
void	serialize(LittleEndianOutput out) Write the data content of this BIFF record.
void	setIx(short ix)
void	setParsedExpression(Ptg[] ptgs)
void	setText(java.lang.String str)

Methods inherited from class org.apache.poi.hssf.record.StandardRecord

getRecordSize, serialize

Methods inherited from class org.apache.poi.hssf.record.Record

cloneViaReserialise, serialize, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord

getGenericChildren

Field Detail

sid

public static final short sid

See Also:

Constant Field Values

Constructor Detail

ExternalNameRecord

public ExternalNameRecord()

ExternalNameRecord

public ExternalNameRecord(ExternalNameRecord other)

ExternalNameRecord

public ExternalNameRecord(RecordInputStream in)

Method Detail

isBuiltInName

public boolean isBuiltInName()

Returns:

true if the name is a built-in name

isAutomaticLink

public boolean isAutomaticLink()

For OLE and DDE, links can be either 'automatic' or 'manual'

Returns:

true if this is a automatic link

isPicureLink

public boolean isPicureLink()

only for OLE and DDE

Returns:

true if this is a picture link

isStdDocumentNameIdentifier

public boolean isStdDocumentNameIdentifier()

DDE links only. If true, this denotes the 'StdDocumentName'

Returns:

true if this denotes the 'StdDocumentName'

isOLELink

public boolean isOLELink()

isIconifiedPictureLink

public boolean isIconifiedPictureLink()

getText

public java.lang.String getText()

Returns:

the standard String representation of this name

setText

public void setText(java.lang.String str)

getIx

public short getIx()

If this is a local name, then this is the (1 based) index of the name of the Sheet this refers to, as defined in the preceding SupBookRecord. If it isn't a local name, then it must be zero.

Returns:

the index of the name of the Sheet this refers to

setIx

public void setIx(short ix)

getParsedExpression

public Ptg[] getParsedExpression()

setParsedExpression

public void setParsedExpression(Ptg[] ptgs)

getDataSize

protected int getDataSize()

Specified by:

getDataSize in class StandardRecord

serialize

public void serialize(LittleEndianOutput out)

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 class StandardRecord

Parameters:

out - the output object

getSid

public short getSid()

Description copied from class: Record

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

Specified by:

getSid in class Record

Returns:

he id for this record

copy

public ExternalNameRecord copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class StandardRecord

Returns:

a deep copy of the implementing class / instance

getGenericRecordType

public HSSFRecordTypes getGenericRecordType()

Specified by:

getGenericRecordType in interface GenericRecord

Specified by:

getGenericRecordType in class Record

getGenericProperties

public java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()