Package 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 Description static short
sid
-
Constructor Summary
Constructors Constructor Description ExternalNameRecord()
ExternalNameRecord(ExternalNameRecord other)
ExternalNameRecord(RecordInputStream in)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ExternalNameRecord
copy()
protected int
getDataSize()
Map<String,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 precedingSupBookRecord
.Ptg[]
getParsedExpression()
short
getSid()
return the non static version of the id for this record.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 DDEboolean
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(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 an 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. Iftrue
, this denotes the 'StdDocumentName'- Returns:
true
if this denotes the 'StdDocumentName'
-
isOLELink
public boolean isOLELink()
-
isIconifiedPictureLink
public boolean isIconifiedPictureLink()
-
getText
public String getText()
- Returns:
- the standard String representation of this name
-
setText
public void setText(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 precedingSupBookRecord
. 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 classStandardRecord
-
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 classStandardRecord
- 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.
-
copy
public ExternalNameRecord copy()
- Specified by:
copy
in interfaceDuplicatable
- Specified by:
copy
in classStandardRecord
- Returns:
- a deep copy of the implementing class / instance
-
getGenericRecordType
public HSSFRecordTypes getGenericRecordType()
- Specified by:
getGenericRecordType
in interfaceGenericRecord
- Specified by:
getGenericRecordType
in classRecord
-
-