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

Class TablePtg

java.lang.Object

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

org.apache.poi.ss.formula.ptg.OperandPtg

org.apache.poi.ss.formula.ptg.AreaPtgBase

org.apache.poi.ss.formula.ptg.Area3DPtg

org.apache.poi.ss.formula.ptg.TablePtg

All Implemented Interfaces:

Serializable, Duplicatable, GenericRecord, ExternSheetReferenceToken, AreaI, WorkbookDependentFormula

public class TablePtg
extends Area3DPtg

TODO: XSSF only

Since:

3.9.7

Author:

henri

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TablePtg.Item

Nested classes/interfaces inherited from interface org.apache.poi.ss.formula.ptg.AreaI

AreaI.OffsetArea

Field Summary

Fields

Modifier and Type	Field	Description
static short	sid

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

field_1_index_extern_sheet

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
TablePtg(int extIdx, int firstRow, int lastRow, int firstColumn, int lastColumn, String tableName, TablePtg.Item[] items, String[] columns, boolean inTable)
TablePtg(LittleEndianInput in)

Method Summary

Modifier and Type	Method	Description
static String	formatAsFormulaString(String tableName, TablePtg.Item item1, TablePtg.Item item2, String column1, String column2, boolean inTable)
String	getColumn1()
String	getColumn2()
byte	getDefaultOperandClass()
TablePtg.Item	getItem1()
TablePtg.Item	getItem2()
int	getSize(SpreadsheetVersion version)
String	getTableName()
void	setColumn1(String column)
void	setColumn2(String column)
void	setTableName(String tableName)
String	toCopyFormulaString()
String	toFormulaString(FormulaRenderingWorkbook book)
String	toInternalFormulaString(FormulaRenderingWorkbook book)
void	write(LittleEndianOutput out, SpreadsheetVersion version)

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

copy, equals, format2DRefAsString, getExternSheetIndex, getGenericProperties, getSid, hashCode, setExternSheetIndex, toFormulaString

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

formatReferenceAsString, getFirstColumn, getFirstColumnRaw, getFirstRow, getLastColumn, getLastColumnRaw, getLastRow, isFirstColRelative, isFirstRowRelative, isLastColRelative, isLastRowRelative, readCoordinates, setFirstColRelative, setFirstColumn, setFirstColumnRaw, setFirstRow, setFirstRowRelative, setLastColRelative, setLastColumn, setLastColumnRaw, setLastRow, setLastRowRelative, sortTopLeftToBottomRight, writeCoordinates

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

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, finalize, getClass, 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

TablePtg

public TablePtg(int extIdx,
                int firstRow,
                int lastRow,
                int firstColumn,
                int lastColumn,
                String tableName,
                TablePtg.Item[] items,
                String[] columns,
                boolean inTable)

TablePtg

public TablePtg(LittleEndianInput in)

Method Detail

getTableName

public String getTableName()

setTableName

public void setTableName(String tableName)

getItem1

public TablePtg.Item getItem1()

getItem2

public TablePtg.Item getItem2()

getColumn1

public String getColumn1()

setColumn1

public void setColumn1(String column)

getColumn2

public String getColumn2()

setColumn2

public void setColumn2(String column)

write

public void write(LittleEndianOutput out,
                  SpreadsheetVersion version)

Overrides:

write in class Area3DPtg

getSize

public int getSize(SpreadsheetVersion version)

Overrides:

getSize in class Area3DPtg

Returns:

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

formatAsFormulaString

public static String formatAsFormulaString(String tableName,
                                           TablePtg.Item item1,
                                           TablePtg.Item item2,
                                           String column1,
                                           String column2,
                                           boolean inTable)

toFormulaString

public String toFormulaString(FormulaRenderingWorkbook book)

Specified by:

toFormulaString in interface WorkbookDependentFormula

Overrides:

toFormulaString in class Area3DPtg

Returns:

text representation of this area reference that can be used in text formulas. The sheet name will get properly delimited if required.

toInternalFormulaString

public String toInternalFormulaString(FormulaRenderingWorkbook book)

Specified by:

toInternalFormulaString in interface WorkbookDependentFormula

Overrides:

toInternalFormulaString in class Area3DPtg

Returns:

text representation of this area reference that can be used in text formulas. The sheet name will get properly delimited if required.

getDefaultOperandClass

public byte getDefaultOperandClass()

Overrides:

getDefaultOperandClass in class AreaPtgBase

toCopyFormulaString

public String toCopyFormulaString()