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

java.lang.Object
  org.apache.poi.hssf.record.formula.Ptg
      org.apache.poi.hssf.record.formula.OperandPtg
          org.apache.poi.hssf.record.formula.Ref3DPtg

All Implemented Interfaces:

java.lang.Cloneable

public final class Ref3DPtg
extends OperandPtg

Title: Reference 3D Ptg

Description: Defined a cell in extern sheet.

REFERENCE:

Version:

1.0-pre

Author:

Libin Roman (Vista Portal LDT. Developer), Jason Height (jheight at chariot dot net dot au)

Field Summary

static byte

sid

Fields inherited from class org.apache.poi.hssf.record.formula.Ptg

CLASS_ARRAY, CLASS_REF, CLASS_VALUE

Constructor Summary

Ref3DPtg()
Creates new AreaPtg

Ref3DPtg(RecordInputStream in)

Ref3DPtg(java.lang.String cellref, short externIdx)

Method Summary

int	getColumn()
int	getColumnRaw()
byte	getDefaultOperandClass()
short	getExternSheetIndex()
int	getRow()
int	getSize()
boolean	isColRelative()
boolean	isRowRelative()
void	setArea(java.lang.String ref)
void	setColRelative(boolean rel)
void	setColumn(short column)
void	setColumnRaw(short column)
void	setExternSheetIndex(short index)
void	setRow(int row)
void	setRowRelative(boolean rel)
java.lang.String	toFormulaString(HSSFWorkbook book) return a string representation of this token alone
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.OperandPtg

isBaseToken

Methods inherited from class org.apache.poi.hssf.record.formula.Ptg

clone, copy, createParsedExpressionTokens, createPtg, getBytes, getEncodedSize, getEncodedSize, getPtgClass, readTokens, serializePtgs, serializePtgStack, 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

Ref3DPtg

public Ref3DPtg()

Creates new AreaPtg

Ref3DPtg

public Ref3DPtg(RecordInputStream in)

Ref3DPtg

public Ref3DPtg(java.lang.String cellref,
                short externIdx)

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 short getExternSheetIndex()

setExternSheetIndex

public void setExternSheetIndex(short index)

getRow

public int getRow()

setRow

public void setRow(int row)

getColumn

public int getColumn()

getColumnRaw

public int getColumnRaw()

isRowRelative

public boolean isRowRelative()

setRowRelative

public void setRowRelative(boolean rel)

isColRelative

public boolean isColRelative()

setColRelative

public void setColRelative(boolean rel)

setColumn

public void setColumn(short column)

setColumnRaw

public void setColumnRaw(short column)

setArea

public void setArea(java.lang.String ref)

toFormulaString

public java.lang.String toFormulaString(HSSFWorkbook book)

Description copied from class: Ptg

return a string representation of this token alone

Specified by:

toFormulaString in class Ptg

Returns:

text representation of this cell reference that can be used in text formulas. The sheet name will get properly delimited if required.

getDefaultOperandClass

public byte getDefaultOperandClass()

Specified by:

getDefaultOperandClass in class Ptg