Package org.apache.poi.ss.formula.ptg
Class Area3DPxg
- 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.Area3DPxg
-
- All Implemented Interfaces:
org.apache.poi.common.Duplicatable
,GenericRecord
,AreaI
,Pxg
,Pxg3D
public final class Area3DPxg extends AreaPtgBase implements Pxg3D
XSSF Area 3D Reference (Sheet + Area)Defined an area in an external or different sheet.
This is XSSF only, as it stores the sheet / book references in String form. The HSSF equivalent using indexes is
Area3DPtg
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.apache.poi.ss.formula.ptg.AreaI
AreaI.OffsetArea
-
-
Field Summary
-
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 Area3DPxg(int externalWorkbookNumber, SheetIdentifier sheetName, java.lang.String arearef)
Area3DPxg(int externalWorkbookNumber, SheetIdentifier sheetName, AreaReference arearef)
Area3DPxg(Area3DPxg other)
Area3DPxg(SheetIdentifier sheetName, java.lang.String arearef)
Area3DPxg(SheetIdentifier sheetName, AreaReference arearef)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Area3DPxg
copy()
java.lang.String
format2DRefAsString()
int
getExternalWorkbookNumber()
java.util.Map<java.lang.String,java.util.function.Supplier<?>>
getGenericProperties()
java.lang.String
getLastSheetName()
java.lang.String
getSheetName()
byte
getSid()
int
getSize()
void
setLastSheetName(java.lang.String sheetName)
void
setSheetName(java.lang.String sheetName)
java.lang.String
toFormulaString()
return a string representation of this token alonevoid
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
-
-
-
-
Constructor Detail
-
Area3DPxg
public Area3DPxg(Area3DPxg other)
-
Area3DPxg
public Area3DPxg(int externalWorkbookNumber, SheetIdentifier sheetName, java.lang.String arearef)
-
Area3DPxg
public Area3DPxg(int externalWorkbookNumber, SheetIdentifier sheetName, AreaReference arearef)
-
Area3DPxg
public Area3DPxg(SheetIdentifier sheetName, java.lang.String arearef)
-
Area3DPxg
public Area3DPxg(SheetIdentifier sheetName, AreaReference arearef)
-
-
Method Detail
-
getExternalWorkbookNumber
public int getExternalWorkbookNumber()
- Specified by:
getExternalWorkbookNumber
in interfacePxg
-
getSheetName
public java.lang.String getSheetName()
- Specified by:
getSheetName
in interfacePxg
-
getLastSheetName
public java.lang.String getLastSheetName()
- Specified by:
getLastSheetName
in interfacePxg3D
-
setSheetName
public void setSheetName(java.lang.String sheetName)
- Specified by:
setSheetName
in interfacePxg
-
setLastSheetName
public void setLastSheetName(java.lang.String sheetName)
- Specified by:
setLastSheetName
in interfacePxg3D
-
format2DRefAsString
public java.lang.String format2DRefAsString()
-
toFormulaString
public java.lang.String toFormulaString()
Description copied from class:Ptg
return a string representation of this token alone- Specified by:
toFormulaString
in interfacePxg
- Overrides:
toFormulaString
in classAreaPtgBase
-
getSid
public byte getSid()
-
getSize
public int getSize()
-
write
public void write(LittleEndianOutput out)
-
copy
public Area3DPxg 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
-
-