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

Class Ref3DPtg

java.lang.Object

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

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

org.apache.poi.ss.formula.ptg.RefPtgBase

org.apache.poi.ss.formula.ptg.Ref3DPtg

All Implemented Interfaces:

Serializable, Duplicatable, GenericRecord, ExternSheetReferenceToken, WorkbookDependentFormula

public final class Ref3DPtg
extends RefPtgBase
implements WorkbookDependentFormula, ExternSheetReferenceToken

Reference 3D Ptg

Defined a cell in extern sheet.

This is HSSF only, as it matches the HSSF file format way of referring to the sheet by an extern index. The XSSF equivalent is Ref3DPxg

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static byte	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
Ref3DPtg(int row, int column, boolean isRowRelative, boolean isColumnRelative, int externIdx)
Ref3DPtg(String cellref, int externIdx)
Ref3DPtg(Ref3DPtg other)
Ref3DPtg(CellReference c, int externIdx)
Ref3DPtg(LittleEndianInput in, SpreadsheetVersion version)

Method Summary

Modifier and Type	Method	Description
Ref3DPtg	copy()
boolean	equals(Object o)
String	format2DRefAsString()
int	getExternSheetIndex()
Map<String,Supplier<?>>	getGenericProperties()
byte	getSid()
int	getSize(SpreadsheetVersion version)
int	hashCode()
void	setExternSheetIndex(int index)
String	toFormulaString()	return a string representation of this token alone
String	toFormulaString(FormulaRenderingWorkbook book)
String	toInternalFormulaString(FormulaRenderingWorkbook book)
void	write(LittleEndianOutput out, SpreadsheetVersion version)

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

formatReferenceAsString, getColumn, getDefaultOperandClass, getRow, isColRelative, isRowRelative, readCoordinates, setColRelative, setColumn, setRow, setRowRelative, 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 byte sid

See Also:

Constant Field Values

Constructor Detail

Ref3DPtg

public Ref3DPtg(Ref3DPtg other)

Ref3DPtg

public Ref3DPtg(LittleEndianInput in,
                SpreadsheetVersion version)

Ref3DPtg

public Ref3DPtg(String cellref,
                int externIdx)

Ref3DPtg

public Ref3DPtg(CellReference c,
                int externIdx)

Ref3DPtg

public Ref3DPtg(int row,
                int column,
                boolean isRowRelative,
                boolean isColumnRelative,
                int externIdx)

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.

getExternSheetIndex

public int getExternSheetIndex()

Specified by:

getExternSheetIndex in interface ExternSheetReferenceToken

setExternSheetIndex

public void setExternSheetIndex(int index)

format2DRefAsString

public String format2DRefAsString()

Specified by:

format2DRefAsString in interface ExternSheetReferenceToken

Returns:

formula text for this reference token without the qualifying sheet name

toFormulaString

public String toFormulaString(FormulaRenderingWorkbook book)

Specified by:

toFormulaString in interface WorkbookDependentFormula

Returns:

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

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 Ref3DPtg copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class OperandPtg

Returns:

a deep copy of the implementing class / instance

getGenericProperties

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

Specified by:

getGenericProperties in interface GenericRecord

Overrides:

getGenericProperties in class RefPtgBase

hashCode

public int hashCode()

Overrides:

hashCode in class RefPtgBase

equals

public boolean equals(Object o)

Overrides:

equals in class RefPtgBase

toInternalFormulaString

public String toInternalFormulaString(FormulaRenderingWorkbook book)

Specified by:

toInternalFormulaString in interface WorkbookDependentFormula