Package org.apache.poi.ss.formula.ptg
Class Area3DPtg
- 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
-
- All Implemented Interfaces:
org.apache.poi.common.Duplicatable
,GenericRecord
,ExternSheetReferenceToken
,AreaI
,WorkbookDependentFormula
public final class Area3DPtg extends AreaPtgBase implements WorkbookDependentFormula, ExternSheetReferenceToken
Area 3D Ptg - 3D reference (Sheet + Area)Defined an area 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
Area3DPxg
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.apache.poi.ss.formula.ptg.AreaI
AreaI.OffsetArea
-
-
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 Area3DPtg(int firstRow, int lastRow, int firstColumn, int lastColumn, boolean firstRowRelative, boolean lastRowRelative, boolean firstColRelative, boolean lastColRelative, int externalSheetIndex)
Area3DPtg(java.lang.String arearef, int externIdx)
Area3DPtg(Area3DPtg other)
Area3DPtg(AreaReference arearef, int externIdx)
Area3DPtg(LittleEndianInput in)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Area3DPtg
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.AreaPtgBase
getDefaultOperandClass, getFirstColumn, getFirstColumnRaw, getFirstRow, getLastColumn, getLastColumnRaw, getLastRow, isFirstColRelative, isFirstRowRelative, isLastColRelative, isLastRowRelative, setFirstColRelative, setFirstColumn, setFirstColumnRaw, setFirstRow, setFirstRowRelative, setLastColRelative, setLastColumn, setLastColumnRaw, setLastRow, setLastRowRelative, sortTopLeftToBottomRight
-
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
-
Area3DPtg
public Area3DPtg(java.lang.String arearef, int externIdx)
-
Area3DPtg
public Area3DPtg(Area3DPtg other)
-
Area3DPtg
public Area3DPtg(LittleEndianInput in)
-
Area3DPtg
public Area3DPtg(int firstRow, int lastRow, int firstColumn, int lastColumn, boolean firstRowRelative, boolean lastRowRelative, boolean firstColRelative, boolean lastColRelative, int externalSheetIndex)
-
Area3DPtg
public Area3DPtg(AreaReference arearef, 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 area 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- Overrides:
toFormulaString
in classAreaPtgBase
-
copy
public Area3DPtg 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 classAreaPtgBase
-
-