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:
Cloneable
,ExternSheetReferenceToken
,AreaI
,WorkbookDependentFormula
public final class Area3DPtg
extends AreaPtgBase
implements WorkbookDependentFormula, ExternSheetReferenceToken
Title: Area 3D Ptg - 3D reference (Sheet + Area)
Description: Defined an area 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 Area3DPxg
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.poi.ss.formula.ptg.AreaI
AreaI.OffsetArea
-
Field Summary
FieldsFields inherited from class org.apache.poi.ss.formula.ptg.Ptg
CLASS_ARRAY, CLASS_REF, CLASS_VALUE, EMPTY_PTG_ARRAY
-
Constructor Summary
ConstructorsConstructorDescriptionArea3DPtg
(int firstRow, int lastRow, int firstColumn, int lastColumn, boolean firstRowRelative, boolean lastRowRelative, boolean firstColRelative, boolean lastColRelative, int externalSheetIndex) Area3DPtg
(AreaReference arearef, int externIdx) -
Method Summary
Modifier and TypeMethodDescriptionint
int
getSize()
void
setExternSheetIndex
(int index) return a string representation of this token alonetoString()
Overridden toString method to ensure object hash is not printed.void
write
(LittleEndianOutput out) Methods inherited from class org.apache.poi.ss.formula.ptg.AreaPtgBase
formatReferenceAsString, getDefaultOperandClass, getFirstColumn, getFirstColumnRaw, getFirstRow, getLastColumn, getLastColumnRaw, getLastRow, isFirstColRelative, isFirstRowRelative, isLastColRelative, isLastRowRelative, notImplemented, readCoordinates, setFirstColRelative, setFirstColumn, setFirstColumnRaw, setFirstRow, setFirstRowRelative, setLastColRelative, setLastColumn, setLastColumnRaw, setLastRow, setLastRowRelative, sortTopLeftToBottomRight, writeCoordinates
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
-
Field Details
-
sid
public static final byte sid- See Also:
-
-
Constructor Details
-
Area3DPtg
-
Area3DPtg
-
Area3DPtg
public Area3DPtg(int firstRow, int lastRow, int firstColumn, int lastColumn, boolean firstRowRelative, boolean lastRowRelative, boolean firstColRelative, boolean lastColRelative, int externalSheetIndex) -
Area3DPtg
-
-
Method Details
-
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 -
write
-
getSize
public int getSize() -
getExternSheetIndex
public int getExternSheetIndex()- Specified by:
getExternSheetIndex
in interfaceExternSheetReferenceToken
-
setExternSheetIndex
public void setExternSheetIndex(int index) -
format2DRefAsString
- Specified by:
format2DRefAsString
in interfaceExternSheetReferenceToken
- Returns:
- formula text for this reference token without the qualifying sheet name
-
toFormulaString
- 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
Description copied from class:Ptg
return a string representation of this token alone- Overrides:
toFormulaString
in classAreaPtgBase
-