Top Description Fields Constructors Methods
org.apache.poi.ss.formula.ptg

public final Class Ref3DPxg

extends RefPtgBase
implements Pxg3D
Class Inheritance
All Implemented Interfaces
org.apache.poi.ss.formula.ptg.Pxg3D, org.apache.poi.ss.formula.ptg.Pxg
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.ss.formula.SheetIdentifier, .SheetRangeAndWorkbookIndexFormatter, .SheetRangeIdentifier, org.apache.poi.ss.util.CellReference, org.apache.poi.util.GenericRecordUtil, .LittleEndianOutput
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

Field Summary

Modifier and TypeField and Description
private int
externalWorkbookNumber

private String
firstSheetName

private String
lastSheetName

Constructor Summary

AccessConstructor and Description
public
Ref3DPxg(Ref3DPxg other)

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

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

public
Ref3DPxg(SheetIdentifier sheetName, String cellref)

public
Ref3DPxg(SheetIdentifier sheetName, CellReference c)

Method Summary

Modifier and TypeMethod and Description
public Ref3DPxg
copy()

Implements abstract org.apache.poi.ss.formula.ptg.OperandPtg.copy.

Implements org.apache.poi.common.Duplicatable.copy.

public String
format2DRefAsString()

public int
getExternalWorkbookNumber()

Implements org.apache.poi.ss.formula.ptg.Pxg.getExternalWorkbookNumber.

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

Overrides org.apache.poi.ss.formula.ptg.RefPtgBase.getGenericProperties.

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public String
getLastSheetName()

Implements org.apache.poi.ss.formula.ptg.Pxg3D.getLastSheetName.

public String
getSheetName()

Implements org.apache.poi.ss.formula.ptg.Pxg.getSheetName.

public byte
getSid()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSid.

public int
getSize()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSize.

public void
setLastSheetName(String sheetName)

Implements org.apache.poi.ss.formula.ptg.Pxg3D.setLastSheetName.

public void
setSheetName(String sheetName)

Implements org.apache.poi.ss.formula.ptg.Pxg.setSheetName.

public String
toFormulaString()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.toFormulaString.

Implements org.apache.poi.ss.formula.ptg.Pxg.toFormulaString.

return a string representation of this token alone

public void
write(LittleEndianOutput out)

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.write.

Inherited from org.apache.poi.ss.formula.ptg.RefPtgBase:
formatReferenceAsStringgetColumngetDefaultOperandClassgetRowisColRelativeisRowRelativereadCoordinatessetColRelativesetColumnsetRowsetRowRelativewriteCoordinates

Field Detail

externalWorkbookNumberback to summary
private int externalWorkbookNumber
firstSheetNameback to summary
private String firstSheetName
lastSheetNameback to summary
private String lastSheetName

Constructor Detail

Ref3DPxgback to summary
public Ref3DPxg(Ref3DPxg other)
Ref3DPxgback to summary
public Ref3DPxg(int externalWorkbookNumber, SheetIdentifier sheetName, String cellref)
Ref3DPxgback to summary
public Ref3DPxg(int externalWorkbookNumber, SheetIdentifier sheetName, CellReference c)
Ref3DPxgback to summary
public Ref3DPxg(SheetIdentifier sheetName, String cellref)
Ref3DPxgback to summary
public Ref3DPxg(SheetIdentifier sheetName, CellReference c)

Method Detail

copyback to summary
public Ref3DPxg copy()

Implements abstract org.apache.poi.ss.formula.ptg.OperandPtg.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:Ref3DPxg

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations
@Override
format2DRefAsStringback to summary
public String format2DRefAsString()
getExternalWorkbookNumberback to summary
public int getExternalWorkbookNumber()

Implements org.apache.poi.ss.formula.ptg.Pxg.getExternalWorkbookNumber.

getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Overrides org.apache.poi.ss.formula.ptg.RefPtgBase.getGenericProperties.

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getLastSheetNameback to summary
public String getLastSheetName()

Implements org.apache.poi.ss.formula.ptg.Pxg3D.getLastSheetName.

getSheetNameback to summary
public String getSheetName()

Implements org.apache.poi.ss.formula.ptg.Pxg.getSheetName.

getSidback to summary
public byte getSid()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSid.

Returns:byte

Doc from org.apache.poi.ss.formula.ptg.Ptg.getSid.

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

Annotations
@Override
getSizeback to summary
public int getSize()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSize.

Returns:int

Doc from org.apache.poi.ss.formula.ptg.Ptg.getSize.

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

setLastSheetNameback to summary
public void setLastSheetName(String sheetName)

Implements org.apache.poi.ss.formula.ptg.Pxg3D.setLastSheetName.

setSheetNameback to summary
public void setSheetName(String sheetName)

Implements org.apache.poi.ss.formula.ptg.Pxg.setSheetName.

toFormulaStringback to summary
public String toFormulaString()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.toFormulaString.

Implements org.apache.poi.ss.formula.ptg.Pxg.toFormulaString.

Doc from org.apache.poi.ss.formula.ptg.Ptg.toFormulaString.

return a string representation of this token alone

writeback to summary
public void write(LittleEndianOutput out)

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.write.