TblPtg (Keikai Spreadsheet Build 6.1.0.1 API)

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:

Serializable, 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.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

static 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

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

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, createPtg, doesFormulaReferToDeletedCell, getEncodedSize, getEncodedSize, getEncodedSizeWithoutArrayData, getEncodedSizeWithoutArrayData, getPtgClass, getRVAType, readTokens, readTokens, serializePtgs, serializePtgs, setClass, 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, getGenericRecordType

- Field Detail
  - sid
```
public static final short sid
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TblPtg
```
public TblPtg(LittleEndianInput in)
```
- Method Detail
  - write
```
public void write(LittleEndianOutput out,
                  SpreadsheetVersion version)
```
    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(SpreadsheetVersion version)
```
    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 Duplicatable
    
    Specified by:
    
    copy in class Ptg
    
    Returns:
    
    a deep copy of the implementing class / instance
  - getGenericProperties
```
public Map<String,Supplier<?>> getGenericProperties()
```