Package org.apache.poi.ss.formula.ptg

Class TblPtg

java.lang.Object

org.apache.poi.ss.formula.ptg.Ptg

org.apache.poi.ss.formula.ptg.ControlPtg

org.apache.poi.ss.formula.ptg.TblPtg

All Implemented Interfaces:

org.apache.poi.common.Duplicatable, GenericRecord

public final class TblPtg
extends ControlPtg

This ptg indicates a data table. It only occurs in a FORMULA record, never in an ARRAY or NAME record. When ptgTbl occurs in a formula, it is the only token in the formula. This indicates that the cell containing the formula is an interior cell in a data table; the table description is found in a TABLE record. Rows and columns which contain input values to be substituted in the table do not contain ptgTbl. See page 811 of the june 08 binary docs.

Field Summary

Fields

Modifier and Type	Field	Description
static final short	sid

Fields inherited from class org.apache.poi.ss.formula.ptg.Ptg

CLASS_ARRAY, CLASS_REF, CLASS_VALUE, EMPTY_PTG_ARRAY

Constructor Summary

Constructors

Constructor	Description
TblPtg(LittleEndianInput in)

Method Summary

Modifier and Type	Method	Description
TblPtg	copy()
int	getColumn()
Map<String,Supplier<?>>	getGenericProperties()
int	getRow()
byte	getSid()
int	getSize()
String	toFormulaString()	return a string representation of this token alone
void	write(LittleEndianOutput out)

Methods inherited from class org.apache.poi.ss.formula.ptg.ControlPtg

getDefaultOperandClass, isBaseToken

Methods inherited from class org.apache.poi.ss.formula.ptg.Ptg

createPtg, doesFormulaReferToDeletedCell, getEncodedSize, getEncodedSizeWithoutArrayData, getPtgClass, getRVAType, readTokens, serializePtgs, setClass, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getGenericChildren, getGenericRecordType

Field Details

sid

public static final short sid

See Also:

• Constant Field Values

Constructor Details

TblPtg

public TblPtg(LittleEndianInput in)

Method Details

write

public void write(LittleEndianOutput out)

Specified by:

write in class Ptg

getSid

public byte getSid()

Specified by:

getSid in class Ptg

Returns:

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

getSize

public int getSize()

Specified by:

getSize in class Ptg

Returns:

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

getRow

public int getRow()

getColumn

public int getColumn()

toFormulaString

public String toFormulaString()

Description copied from class: Ptg

return a string representation of this token alone

Specified by:

toFormulaString in class Ptg

copy

public TblPtg copy()

Specified by:

copy in interface org.apache.poi.common.Duplicatable

Specified by:

copy in class Ptg

getGenericProperties

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