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:

Cloneable, AreaI, Pxg, Pxg3D

public final class Area3DPxg
extends AreaPtgBase
implements Pxg3D

Title: XSSF Area 3D Reference (Sheet + Area)

Description: Defined an area in an external or different sheet.

REFERENCE:

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, String arearef)
Area3DPxg(int externalWorkbookNumber, SheetIdentifier sheetName, AreaReference arearef)
Area3DPxg(SheetIdentifier sheetName, String arearef)
Area3DPxg(SheetIdentifier sheetName, AreaReference arearef)

Method Summary

Modifier and Type	Method	Description
String	format2DRefAsString()
int	getExternalWorkbookNumber()
String	getLastSheetName()
String	getSheetName()
int	getSize()
void	setLastSheetName(String sheetName)
void	setSheetName(String sheetName)
String	toFormulaString()	return a string representation of this token alone
String	toString()	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

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

copy, isBaseToken

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

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Area3DPxg

public Area3DPxg(int externalWorkbookNumber,
                 SheetIdentifier sheetName,
                 String arearef)

Area3DPxg

public Area3DPxg(int externalWorkbookNumber,
                 SheetIdentifier sheetName,
                 AreaReference arearef)

Area3DPxg

public Area3DPxg(SheetIdentifier sheetName,
                 String arearef)

Area3DPxg

public Area3DPxg(SheetIdentifier sheetName,
                 AreaReference arearef)

Method Detail

toString

public String 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

Overrides:

toString in class Ptg

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

Overrides:

toFormulaString in class AreaPtgBase

getSize

public int getSize()

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)

Specified by:

write in class Ptg