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:
org.apache.poi.common.Duplicatable
,GenericRecord
,ExternSheetReferenceToken
,WorkbookDependentFormula
public final class Ref3DPtg extends RefPtgBase implements WorkbookDependentFormula, ExternSheetReferenceToken
Reference 3D PtgDefined 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
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(java.lang.String cellref, int externIdx)
Ref3DPtg(Ref3DPtg other)
Ref3DPtg(CellReference c, int externIdx)
Ref3DPtg(LittleEndianInput in)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Ref3DPtg
copy()
java.lang.String
format2DRefAsString()
int
getExternSheetIndex()
java.util.Map<java.lang.String,java.util.function.Supplier<?>>
getGenericProperties()
byte
getSid()
int
getSize()
void
setExternSheetIndex(int index)
java.lang.String
toFormulaString()
return a string representation of this token alonejava.lang.String
toFormulaString(FormulaRenderingWorkbook book)
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
isBaseToken
-
Methods inherited from class org.apache.poi.ss.formula.ptg.Ptg
createPtg, doesFormulaReferToDeletedCell, getEncodedSize, getEncodedSizeWithoutArrayData, getPtgClass, getRVAType, readTokens, serializePtgs, setClass, toString
-
Methods inherited from class java.lang.Object
equals, 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 byte sid
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
Ref3DPtg
public Ref3DPtg(Ref3DPtg other)
-
Ref3DPtg
public Ref3DPtg(LittleEndianInput in)
-
Ref3DPtg
public Ref3DPtg(java.lang.String cellref, int externIdx)
-
Ref3DPtg
public Ref3DPtg(CellReference c, int externIdx)
-
-
Method Detail
-
write
public void write(LittleEndianOutput out)
-
getSid
public byte getSid()
-
getSize
public int getSize()
-
getExternSheetIndex
public int getExternSheetIndex()
- Specified by:
getExternSheetIndex
in interfaceExternSheetReferenceToken
-
setExternSheetIndex
public void setExternSheetIndex(int index)
-
format2DRefAsString
public java.lang.String format2DRefAsString()
- Specified by:
format2DRefAsString
in interfaceExternSheetReferenceToken
- Returns:
- formula text for this reference token without the qualifying sheet name
-
toFormulaString
public java.lang.String toFormulaString(FormulaRenderingWorkbook book)
- Specified by:
toFormulaString
in interfaceWorkbookDependentFormula
- 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 java.lang.String toFormulaString()
Description copied from class:Ptg
return a string representation of this token alone- Specified by:
toFormulaString
in classPtg
-
copy
public Ref3DPtg copy()
- Specified by:
copy
in interfaceorg.apache.poi.common.Duplicatable
- Specified by:
copy
in classOperandPtg
-
getGenericProperties
public java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()
- Specified by:
getGenericProperties
in interfaceGenericRecord
- Overrides:
getGenericProperties
in classRefPtgBase
-
-