Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## 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:
  java.lang.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
`Area3DPxg(int externalWorkbookNumber, SheetIdentifier sheetName, AreaReference arearef)`
`Area3DPxg(int externalWorkbookNumber, SheetIdentifier sheetName, java.lang.String arearef)`
`Area3DPxg(SheetIdentifier sheetName, AreaReference arearef)`
`Area3DPxg(SheetIdentifier sheetName, java.lang.String arearef)`

Method Summary
`java.lang.String` | `format2DRefAsString()`
`int` | `getExternalWorkbookNumber()`
`java.lang.String` | `getLastSheetName()`
`java.lang.String` | `getSheetName()`
`int` | `getSize()`
`void` | `setLastSheetName(java.lang.String sheetName)`
`void` | `setSheetName(java.lang.String sheetName)`
`java.lang.String` | `toFormulaString()` return a string representation of this token alone
`java.lang.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
`formatReferenceAsString, getDefaultOperandClass, getFirstColumn, getFirstColumnRaw, getFirstRow, getLastColumn, getLastColumnRaw, getLastRow, isFirstColRelative, isFirstRowRelative, isLastColRelative, isLastRowRelative, notImplemented, readCoordinates, setFirstColRelative, setFirstColumn, setFirstColumnRaw, setFirstRow, setFirstRowRelative, setLastColRelative, setLastColumn, setLastColumnRaw, setLastRow, setLastRowRelative, sortTopLeftToBottomRight, writeCoordinates`

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
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

### Area3DPxg

    public Area3DPxg(int externalWorkbookNumber,
                     SheetIdentifier sheetName,
                     java.lang.String arearef)

### Area3DPxg

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

### Area3DPxg

    public Area3DPxg(SheetIdentifier sheetName,
                     java.lang.String arearef)

### Area3DPxg

    public Area3DPxg(SheetIdentifier sheetName,
                     AreaReference arearef)

Method Detail

### toString

    public java.lang.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 java.lang.String getSheetName()

  Specified by:
    `getSheetName` in interface `Pxg`

### getLastSheetName

    public java.lang.String getLastSheetName()

  Specified by:
    `getLastSheetName` in interface `Pxg3D`

### setSheetName

    public void setSheetName(java.lang.String sheetName)

  Specified by:
    `setSheetName` in interface `Pxg`

### setLastSheetName

    public void setLastSheetName(java.lang.String sheetName)

  Specified by:
    `setLastSheetName` in interface `Pxg3D`

### format2DRefAsString

    public java.lang.String format2DRefAsString()

### toFormulaString

    public java.lang.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`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright 2017 The Apache Software Foundation or its licensors, as applicable.