Top Description Fields Constructors Methods
org.apache.poi.ss.formula.ptg

public final Class Ref3DPtg

extends RefPtgBase
implements WorkbookDependentFormula, ExternSheetReferenceToken
Class Inheritance
All Implemented Interfaces
org.apache.poi.ss.formula.ExternSheetReferenceToken, org.apache.poi.ss.formula.WorkbookDependentFormula
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.ss.formula.ExternSheetReferenceToken, .FormulaRenderingWorkbook, .WorkbookDependentFormula, org.apache.poi.ss.util.CellReference, org.apache.poi.util.GenericRecordUtil, .LittleEndianInput, .LittleEndianOutput
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

Field Summary

Modifier and TypeField and Description
private int
field_1_index_extern_sheet

public static final byte
sid

private static final int
SIZE

Constructor Summary

AccessConstructor and Description
public
Ref3DPtg(Ref3DPtg other)

public
Ref3DPtg(LittleEndianInput in)

public
Ref3DPtg(String cellref, int externIdx)

public
Ref3DPtg(CellReference c, int externIdx)

Method Summary

Modifier and TypeMethod and Description
public Ref3DPtg
copy()

Implements abstract org.apache.poi.ss.formula.ptg.OperandPtg.copy.

Implements org.apache.poi.common.Duplicatable.copy.

public String
format2DRefAsString()

Implements org.apache.poi.ss.formula.ExternSheetReferenceToken.format2DRefAsString.

public int
getExternSheetIndex()

Implements org.apache.poi.ss.formula.ExternSheetReferenceToken.getExternSheetIndex.

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

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

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public byte
getSid()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSid.

public int
getSize()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSize.

public void
setExternSheetIndex(int index)

public String

Returns:

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

Implements org.apache.poi.ss.formula.WorkbookDependentFormula.toFormulaString.

public String
toFormulaString()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.toFormulaString.

return a string representation of this token alone

public void
write(LittleEndianOutput out)

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.write.

Inherited from org.apache.poi.ss.formula.ptg.RefPtgBase:
formatReferenceAsStringgetColumngetDefaultOperandClassgetRowisColRelativeisRowRelativereadCoordinatessetColRelativesetColumnsetRowsetRowRelativewriteCoordinates

Field Detail

field_1_index_extern_sheetback to summary
private int field_1_index_extern_sheet
sidback to summary
public static final byte sid
SIZEback to summary
private static final int SIZE

Constructor Detail

Ref3DPtgback to summary
public Ref3DPtg(Ref3DPtg other)
Ref3DPtgback to summary
public Ref3DPtg(LittleEndianInput in)
Ref3DPtgback to summary
public Ref3DPtg(String cellref, int externIdx)
Ref3DPtgback to summary
public Ref3DPtg(CellReference c, int externIdx)

Method Detail

copyback to summary
public Ref3DPtg copy()

Implements abstract org.apache.poi.ss.formula.ptg.OperandPtg.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:Ref3DPtg

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations
@Override
format2DRefAsStringback to summary
public String format2DRefAsString()

Implements org.apache.poi.ss.formula.ExternSheetReferenceToken.format2DRefAsString.

Returns:String

Doc from org.apache.poi.ss.formula.ExternSheetReferenceToken.format2DRefAsString.

formula text for this reference token without the qualifying sheet name

getExternSheetIndexback to summary
public int getExternSheetIndex()

Implements org.apache.poi.ss.formula.ExternSheetReferenceToken.getExternSheetIndex.

getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

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

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getSidback to summary
public byte getSid()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSid.

Returns:byte

Doc from org.apache.poi.ss.formula.ptg.Ptg.getSid.

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

Annotations
@Override
getSizeback to summary
public int getSize()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSize.

Returns:int

Doc from org.apache.poi.ss.formula.ptg.Ptg.getSize.

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

setExternSheetIndexback to summary
public void setExternSheetIndex(int index)
toFormulaStringback to summary
public String toFormulaString(FormulaRenderingWorkbook book)

Implements org.apache.poi.ss.formula.WorkbookDependentFormula.toFormulaString.

Returns:String

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

toFormulaStringback to summary
public String toFormulaString()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.toFormulaString.

Doc from org.apache.poi.ss.formula.ptg.Ptg.toFormulaString.

return a string representation of this token alone

writeback to summary
public void write(LittleEndianOutput out)

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.write.