org.apache.poi.hssf.record.formula
Class Area3DPtg

java.lang.Object
  extended by org.apache.poi.hssf.record.formula.Ptg
      extended by org.apache.poi.hssf.record.formula.OperandPtg
          extended by org.apache.poi.hssf.record.formula.AreaPtgBase
              extended by org.apache.poi.hssf.record.formula.Area3DPtg
All Implemented Interfaces:
java.lang.Cloneable, AreaI, ExternSheetReferenceToken, WorkbookDependentFormula

public final class Area3DPtg
extends AreaPtgBase
implements WorkbookDependentFormula, ExternSheetReferenceToken

Title: Area 3D Ptg - 3D reference (Sheet + Area)

Description: Defined a area in Extern Sheet.

REFERENCE:

Version:
1.0-pre
Author:
Libin Roman (Vista Portal LDT. Developer), avik, Jason Height (jheight at chariot dot net dot au)

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.apache.poi.hssf.record.formula.AreaI
AreaI.OffsetArea
 
Field Summary
static byte sid
           
 
Fields inherited from class org.apache.poi.hssf.record.formula.Ptg
CLASS_ARRAY, CLASS_REF, CLASS_VALUE, EMPTY_PTG_ARRAY
 
Constructor Summary
Area3DPtg(int firstRow, int lastRow, int firstColumn, int lastColumn, boolean firstRowRelative, boolean lastRowRelative, boolean firstColRelative, boolean lastColRelative, int externalSheetIndex)
           
Area3DPtg(RecordInputStream in)
           
Area3DPtg(java.lang.String arearef, int externIdx)
           
 
Method Summary
 int getExternSheetIndex()
           
 int getSize()
           
 void setExternSheetIndex(int index)
           
 java.lang.String toFormulaString()
          return a string representation of this token alone
 java.lang.String toFormulaString(FormulaRenderingWorkbook book)
           
 java.lang.String toString()
          Overridden toString method to ensure object hash is not printed.
 void writeBytes(byte[] array, int offset)
          write this Ptg to a byte array
 
Methods inherited from class org.apache.poi.hssf.record.formula.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, writeCoordinates
 
Methods inherited from class org.apache.poi.hssf.record.formula.OperandPtg
isBaseToken
 
Methods inherited from class org.apache.poi.hssf.record.formula.Ptg
clone, copy, createPtg, getBytes, getEncodedSize, getEncodedSizeWithoutArrayData, getPtgClass, getRVAType, readTokens, serializePtgs, setClass, toDebugString
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

sid

public static final byte sid
See Also:
Constant Field Values
Constructor Detail

Area3DPtg

public Area3DPtg(java.lang.String arearef,
                 int externIdx)

Area3DPtg

public Area3DPtg(RecordInputStream in)

Area3DPtg

public Area3DPtg(int firstRow,
                 int lastRow,
                 int firstColumn,
                 int lastColumn,
                 boolean firstRowRelative,
                 boolean lastRowRelative,
                 boolean firstColRelative,
                 boolean lastColRelative,
                 int externalSheetIndex)
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

writeBytes

public void writeBytes(byte[] array,
                       int offset)
Description copied from class: Ptg
write this Ptg to a byte array

Specified by:
writeBytes in class Ptg

getSize

public int getSize()
Specified by:
getSize in class Ptg
Returns:
the encoded length of this Ptg, including the initial Ptg type identifier byte.

getExternSheetIndex

public int getExternSheetIndex()
Specified by:
getExternSheetIndex in interface ExternSheetReferenceToken

setExternSheetIndex

public void setExternSheetIndex(int index)

toFormulaString

public java.lang.String toFormulaString(FormulaRenderingWorkbook book)
Specified by:
toFormulaString in interface WorkbookDependentFormula
Returns:
text representation of this area reference that can be used in text formulas. The sheet name will get properly delimited if required.

toFormulaString

public java.lang.String toFormulaString()
Description copied from class: Ptg
return a string representation of this token alone

Overrides:
toFormulaString in class AreaPtgBase


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