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:

java.io.Serializable, Duplicatable, GenericRecord, ExternSheetReferenceToken, AreaI, WorkbookDependentFormula

Direct Known Subclasses:

TablePtg

public 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

See Also:

Serialized Form

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
protected int	field_1_index_extern_sheet
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, SpreadsheetVersion version)

Method Summary

Modifier and Type	Method	Description
Area3DPtg	copy()
boolean	equals(java.lang.Object o)
java.lang.String	format2DRefAsString()
int	getExternSheetIndex()
java.util.Map<java.lang.String,java.util.function.Supplier<?>>	getGenericProperties()
byte	getSid()
int	getSize(SpreadsheetVersion version)
int	hashCode()
void	setExternSheetIndex(int index)
java.lang.String	toFormulaString()	return a string representation of this token alone
java.lang.String	toFormulaString(FormulaRenderingWorkbook book)
java.lang.String	toInternalFormulaString(FormulaRenderingWorkbook book)
void	write(LittleEndianOutput out, SpreadsheetVersion version)

Methods inherited from class org.apache.poi.ss.formula.ptg.AreaPtgBase

formatReferenceAsString, getDefaultOperandClass, getFirstColumn, getFirstColumnRaw, getFirstRow, getLastColumn, getLastColumnRaw, getLastRow, isFirstColRelative, isFirstRowRelative, isLastColRelative, isLastRowRelative, readCoordinates, setFirstColRelative, setFirstColumn, setFirstColumnRaw, setFirstRow, setFirstRowRelative, setLastColRelative, setLastColumn, setLastColumnRaw, setLastRow, setLastRowRelative, sortTopLeftToBottomRight, writeCoordinates

Methods inherited from class org.apache.poi.ss.formula.ptg.OperandPtg

isBaseToken

Methods inherited from class org.apache.poi.ss.formula.ptg.Ptg

createPtg, createPtg, doesFormulaReferToDeletedCell, getEncodedSize, getEncodedSize, getEncodedSizeWithoutArrayData, getEncodedSizeWithoutArrayData, getPtgClass, getRVAType, readTokens, readTokens, serializePtgs, serializePtgs, setClass, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, 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

field_1_index_extern_sheet

protected int field_1_index_extern_sheet

Constructor Detail

Area3DPtg

public Area3DPtg(java.lang.String arearef,
                 int externIdx)

Area3DPtg

public Area3DPtg(Area3DPtg other)

Area3DPtg

public Area3DPtg(LittleEndianInput in,
                 SpreadsheetVersion version)

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,
                  SpreadsheetVersion version)

Specified by:

write in class Ptg

getSid

public byte getSid()

Specified by:

getSid in class Ptg

Returns:

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

getSize

public int getSize(SpreadsheetVersion version)

Specified by:

getSize in class Ptg

Returns:

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

getExternSheetIndex

public int getExternSheetIndex()

Specified by:

getExternSheetIndex in interface ExternSheetReferenceToken

setExternSheetIndex

public void setExternSheetIndex(int index)

format2DRefAsString

public java.lang.String format2DRefAsString()

Specified by:

format2DRefAsString in interface ExternSheetReferenceToken

Returns:

formula text for this reference token without the qualifying sheet name

toFormulaString

public java.lang.String toFormulaString(FormulaRenderingWorkbook book)

Specified by:

toFormulaString in interface WorkbookDependentFormula

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 class AreaPtgBase

copy

public Area3DPtg copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class OperandPtg

Returns:

a deep copy of the implementing class / instance

getGenericProperties

public java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()

Specified by:

getGenericProperties in interface GenericRecord

Overrides:

getGenericProperties in class AreaPtgBase

hashCode

public int hashCode()

Overrides:

hashCode in class AreaPtgBase

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class AreaPtgBase

toInternalFormulaString

public java.lang.String toInternalFormulaString(FormulaRenderingWorkbook book)

Specified by:

toInternalFormulaString in interface WorkbookDependentFormula

Returns:

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