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

Class AreaPtg

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

org.apache.poi.ss.formula.ptg.AreaPtg

All Implemented Interfaces:

Serializable, Duplicatable, GenericRecord, AreaI

public final class AreaPtg
extends Area2DPtgBase

Specifies a rectangular area of cells A1:A4 for instance.

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
static short	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
AreaPtg(int firstRow, int lastRow, int firstColumn, int lastColumn, boolean firstRowRelative, boolean lastRowRelative, boolean firstColRelative, boolean lastColRelative)
AreaPtg(AreaPtg other)
AreaPtg(AreaReference arearef)
AreaPtg(LittleEndianInput in, SpreadsheetVersion version)

Method Summary

Modifier and Type	Method	Description
AreaPtg	copy()
byte	getSid()

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

getSize, toFormulaString, write

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

equals, formatReferenceAsString, getDefaultOperandClass, getFirstColumn, getFirstColumnRaw, getFirstRow, getGenericProperties, getLastColumn, getLastColumnRaw, getLastRow, hashCode, 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 short sid

See Also:

Constant Field Values

Constructor Detail

AreaPtg

public AreaPtg(int firstRow,
               int lastRow,
               int firstColumn,
               int lastColumn,
               boolean firstRowRelative,
               boolean lastRowRelative,
               boolean firstColRelative,
               boolean lastColRelative)

AreaPtg

public AreaPtg(AreaPtg other)

AreaPtg

public AreaPtg(LittleEndianInput in,
               SpreadsheetVersion version)

AreaPtg

public AreaPtg(AreaReference arearef)

Method Detail

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

copy

public AreaPtg copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class OperandPtg

Returns:

a deep copy of the implementing class / instance