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:

Cloneable, ExternSheetReferenceToken, WorkbookDependentFormula

public final class Ref3DPtg
extends RefPtgBase
implements WorkbookDependentFormula, ExternSheetReferenceToken

Title: Reference 3D Ptg

Description: Defined a cell in extern sheet.

REFERENCE:

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

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(String cellref, int externIdx)
Ref3DPtg(CellReference c, int externIdx)
Ref3DPtg(LittleEndianInput in)

Method Summary

Modifier and Type	Method	Description
String	format2DRefAsString()
int	getExternSheetIndex()
int	getSize()
void	setExternSheetIndex(int index)
String	toFormulaString()	return a string representation of this token alone
String	toFormulaString(FormulaRenderingWorkbook book)
String	toString()	Overridden toString method to ensure object hash is not printed.
void	write(LittleEndianOutput out)

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

getColumn, getDefaultOperandClass, getRow, isColRelative, isRowRelative, setColRelative, setColumn, setRow, setRowRelative

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

copy, isBaseToken

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

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

Methods inherited from class java.lang.Object

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

Field Detail

sid

public static final byte sid

See Also:

Constant Field Values

Constructor Detail

Ref3DPtg

public Ref3DPtg(LittleEndianInput in)

Ref3DPtg

public Ref3DPtg(String cellref,
                int externIdx)

Ref3DPtg

public Ref3DPtg(CellReference c,
                int externIdx)

Method Detail

toString

public String toString()

Description copied from class: Ptg

Overridden toString method to ensure object hash is not printed. This helps get rid of gratuitous diffs when comparing two dumps Subclasses may output more relevant information by overriding this method

Overrides:

toString in class Ptg

write

public void write(LittleEndianOutput out)

Specified by:

write in class Ptg

getSize

public int getSize()

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