Top Description Fields Constructors Methods
org.apache.poi.hssf.record

public final Class ExternalNameRecord

extends StandardRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.ss.formula.Formula, org.apache.poi.ss.formula.constant.ConstantValueParser, org.apache.poi.ss.formula.ptg.Ptg, org.apache.poi.util.GenericRecordUtil, .LittleEndianOutput, .StringUtil
EXTERNALNAME (0x0023)

Field Summary

Modifier and TypeField and Description
private Object[]
_ddeValues

'rgoper' / 'Last received results of the DDE link' (seems to be only applicable to DDE links) Logically this is a 2-D array, which has been flattened into 1-D array here.

private int
_nColumns

(logical) number of columns in the _ddeValues array

private int
_nRows

(logical) number of rows in the _ddeValues array

private short
field_1_option_flag

private short
field_2_ixals

private short
field_3_not_used

private String
field_4_name

private Formula
field_5_name_definition

private static final int
OPT_AUTOMATIC_LINK

private static final int
OPT_BUILTIN_NAME

private static final int
OPT_ICONIFIED_PICTURE_LINK

private static final int
OPT_OLE_LINK

private static final int
OPT_PICTURE_LINK

private static final int
OPT_STD_DOCUMENT_NAME

private static final int[]
OPTION_FLAGS

private static final String[]
OPTION_NAMES

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
ExternalNameRecord()

public
ExternalNameRecord(ExternalNameRecord other)

public
ExternalNameRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public ExternalNameRecord
copy()

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

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

protected int
getDataSize()

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

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.

public short

Returns:

the index of the name of the Sheet this refers to
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.

public Ptg[]
getParsedExpression()

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

Returns:

the standard String representation of this name
getText()

public boolean

Returns:

true if the name is a built-in name
isBuiltInName()

public boolean

Returns:

true if this denotes the 'StdDocumentName'
isStdDocumentNameIdentifier()

DDE links only.

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
setIx(short ix)

public void
setParsedExpression(Ptg[] ptgs)

public void
setText(String str)

Inherited from org.apache.poi.hssf.record.StandardRecord:
getRecordSizeserialize

Field Detail

_ddeValuesback to summary
private Object[] _ddeValues

'rgoper' / 'Last received results of the DDE link' (seems to be only applicable to DDE links)
Logically this is a 2-D array, which has been flattened into 1-D array here.

_nColumnsback to summary
private int _nColumns

(logical) number of columns in the _ddeValues array

_nRowsback to summary
private int _nRows

(logical) number of rows in the _ddeValues array

field_1_option_flagback to summary
private short field_1_option_flag
field_2_ixalsback to summary
private short field_2_ixals
field_3_not_usedback to summary
private short field_3_not_used
field_4_nameback to summary
private String field_4_name
field_5_name_definitionback to summary
private Formula field_5_name_definition
OPT_BUILTIN_NAMEback to summary
private static final int OPT_BUILTIN_NAME
OPT_STD_DOCUMENT_NAMEback to summary
private static final int OPT_STD_DOCUMENT_NAME
OPTION_FLAGSback to summary
private static final int[] OPTION_FLAGS
OPTION_NAMESback to summary
private static final String[] OPTION_NAMES
sidback to summary
public static final short sid

Constructor Detail

ExternalNameRecordback to summary
public ExternalNameRecord()
ExternalNameRecordback to summary
public ExternalNameRecord(ExternalNameRecord other)
ExternalNameRecordback to summary
public ExternalNameRecord(RecordInputStream in)

Method Detail

copyback to summary
public ExternalNameRecord copy()

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

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

Returns:ExternalNameRecord

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

a deep copy of the implementing class / instance

Annotations
@Override
getDataSizeback to summary
protected int getDataSize()

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

Annotations
@Override
getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

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

Annotations
@Override
getGenericRecordTypeback 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
getIxback to summary
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:short

the index of the name of the Sheet this refers to

getParsedExpressionback to summary
public Ptg[] getParsedExpression()
getSidback 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
getTextback to summary
public String getText()
Returns:String

the standard String representation of this name

isAutomaticLinkback to summary
public boolean isAutomaticLink()

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

Returns:boolean

true if this is an automatic link

isBuiltInNameback to summary
public boolean isBuiltInName()
Returns:boolean

true if the name is a built-in name

isIconifiedPictureLinkback to summary
public boolean isIconifiedPictureLink()
isOLELinkback to summary
public boolean isOLELink()
isPicureLinkback to summary
public boolean isPicureLink()

only for OLE and DDE

Returns:boolean

true if this is a picture link

isStdDocumentNameIdentifierback to summary
public boolean isStdDocumentNameIdentifier()

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

Returns:boolean

true if this denotes the 'StdDocumentName'

serializeback 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
setIxback to summary
public void setIx(short ix)
setParsedExpressionback to summary
public void setParsedExpression(Ptg[] ptgs)
setTextback to summary
public void setText(String str)