Top Description Fields Constructors Methods
org.apache.poi.ss.formula.ptg

public final Class NamePtg

extends OperandPtg
implements WorkbookDependentFormula
Class Inheritance
All Implemented Interfaces
org.apache.poi.ss.formula.WorkbookDependentFormula
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.ss.formula.FormulaRenderingWorkbook, .WorkbookDependentFormula, org.apache.poi.util.GenericRecordUtil, .LittleEndianInput, .LittleEndianOutput
See the spec at 2.5.198.76 PtgName

Field Summary

Modifier and TypeField and Description
private int
field_1_label_index

one-based index to defined name record

private short
field_2_zero

public static final short
sid

private static final int
SIZE

Constructor Summary

AccessConstructor and Description
public
NamePtg(int
zero-based index to name within workbook
nameIndex)

public
NamePtg(NamePtg other)

public
NamePtg(LittleEndianInput in)

Creates new NamePtg

Method Summary

Modifier and TypeMethod and Description
public NamePtg
copy()

Implements abstract org.apache.poi.ss.formula.ptg.OperandPtg.copy.

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

public byte
getDefaultOperandClass()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getDefaultOperandClass.

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

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

public int

Returns:

zero based index to a defined name record in the LinkTable
getIndex()

public byte
getSid()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSid.

public int
getSize()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSize.

public String
toFormulaString(FormulaRenderingWorkbook book)

Implements org.apache.poi.ss.formula.WorkbookDependentFormula.toFormulaString.

public String
toFormulaString()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.toFormulaString.

return a string representation of this token alone

public void
write(LittleEndianOutput out)

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.write.

Inherited from org.apache.poi.ss.formula.ptg.OperandPtg:
isBaseToken

Field Detail

field_1_label_indexback to summary
private int field_1_label_index

one-based index to defined name record

field_2_zeroback to summary
private short field_2_zero
sidback to summary
public static final short sid
SIZEback to summary
private static final int SIZE

Constructor Detail

NamePtgback to summary
public NamePtg(int nameIndex)
Parameters
nameIndex:int

zero-based index to name within workbook

NamePtgback to summary
public NamePtg(NamePtg other)
NamePtgback to summary
public NamePtg(LittleEndianInput in)

Creates new NamePtg

Method Detail

copyback to summary
public NamePtg copy()

Implements abstract org.apache.poi.ss.formula.ptg.OperandPtg.copy.

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

Returns:NamePtg

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

a deep copy of the implementing class / instance

Annotations
@Override
getDefaultOperandClassback to summary
public byte getDefaultOperandClass()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getDefaultOperandClass.

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

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

Annotations
@Override
getIndexback to summary
public int getIndex()
Returns:int

zero based index to a defined name record in the LinkTable

getSidback to summary
public byte getSid()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSid.

Returns:byte

Doc from org.apache.poi.ss.formula.ptg.Ptg.getSid.

structure id of the parsed thing, or -1 if the record has no sid

Annotations
@Override
getSizeback to summary
public int getSize()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSize.

Returns:int

Doc from org.apache.poi.ss.formula.ptg.Ptg.getSize.

the encoded length of this Ptg, including the initial Ptg type identifier byte.

Annotations
@Override
toFormulaStringback to summary
public String toFormulaString(FormulaRenderingWorkbook book)

Implements org.apache.poi.ss.formula.WorkbookDependentFormula.toFormulaString.

Annotations
@Override
toFormulaStringback to summary
public String toFormulaString()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.toFormulaString.

Doc from org.apache.poi.ss.formula.ptg.Ptg.toFormulaString.

return a string representation of this token alone

Annotations
@Override
writeback to summary
public void write(LittleEndianOutput out)

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.write.

Annotations
@Override