Package org.apache.poi.ss.formula.ptg

Class Ref3DPxg

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.Ref3DPxg

All Implemented Interfaces:

Serializable, Duplicatable, GenericRecord, Pxg, Pxg3D

public final class Ref3DPxg
extends RefPtgBase
implements Pxg3D

XSSF 3D Reference

Defines a cell 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 Ref3DPtg

See Also:

Serialized Form

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
Ref3DPxg(int externalWorkbookNumber, SheetIdentifier sheetName, String cellref)
Ref3DPxg(int externalWorkbookNumber, SheetIdentifier sheetName, CellReference c)
Ref3DPxg(Ref3DPxg other)
Ref3DPxg(SheetIdentifier sheetName, String cellref)
Ref3DPxg(SheetIdentifier sheetName, CellReference c)

Method Summary

Modifier and Type	Method	Description
Ref3DPxg	copy()
String	format2DRefAsString()
int	getExternalWorkbookNumber()
Map<String,Supplier<?>>	getGenericProperties()
String	getLastSheetName()
String	getSheetName()
byte	getSid()
int	getSize(SpreadsheetVersion version)
void	setLastSheetName(String sheetName)
void	setSheetName(String sheetName)
String	toFormulaString()	return a string representation of this token alone
void	write(LittleEndianOutput out, SpreadsheetVersion version)

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

equals, formatReferenceAsString, getColumn, getDefaultOperandClass, getRow, hashCode, isColRelative, isRowRelative, readCoordinates, setColRelative, setColumn, setRow, setRowRelative, 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

Constructor Detail

Ref3DPxg

public Ref3DPxg(Ref3DPxg other)

Ref3DPxg

public Ref3DPxg(int externalWorkbookNumber,
                SheetIdentifier sheetName,
                String cellref)

Ref3DPxg

public Ref3DPxg(int externalWorkbookNumber,
                SheetIdentifier sheetName,
                CellReference c)

Ref3DPxg

public Ref3DPxg(SheetIdentifier sheetName,
                String cellref)

Ref3DPxg

public Ref3DPxg(SheetIdentifier sheetName,
                CellReference c)

Method Detail

getExternalWorkbookNumber

public int getExternalWorkbookNumber()

Specified by:

getExternalWorkbookNumber in interface Pxg

getSheetName

public String getSheetName()

Specified by:

getSheetName in interface Pxg

getLastSheetName

public String getLastSheetName()

Specified by:

getLastSheetName in interface Pxg3D

setSheetName

public void setSheetName(String sheetName)

Specified by:

setSheetName in interface Pxg

setLastSheetName

public void setLastSheetName(String sheetName)

Specified by:

setLastSheetName in interface Pxg3D

format2DRefAsString

public String format2DRefAsString()

toFormulaString

public String toFormulaString()

Description copied from class: Ptg

return a string representation of this token alone

Specified by:

toFormulaString in interface Pxg

Specified by:

toFormulaString 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.

write

public void write(LittleEndianOutput out,
                  SpreadsheetVersion version)

Specified by:

write in class Ptg

copy

public Ref3DPxg copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class OperandPtg

Returns:

a deep copy of the implementing class / instance

getGenericProperties

public Map<String,Supplier<?>> getGenericProperties()

Specified by:

getGenericProperties in interface GenericRecord

Overrides:

getGenericProperties in class RefPtgBase