loci.poi.hssf.record.formula

Class Area3DPtg

java.lang.Object

loci.poi.hssf.record.formula.Ptg

loci.poi.hssf.record.formula.Area3DPtg

Direct Known Subclasses:

DeletedArea3DPtg

public class Area3DPtg
extends Ptg

Title: Area 3D Ptg - 3D referecnce (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)

Field Summary

Fields

Modifier and Type	Field and Description
private BitField	colRelative
private short	field_1_index_extern_sheet
private short	field_2_first_row
private short	field_3_last_row
private short	field_4_first_column
private short	field_5_last_column
private BitField	rowRelative
static byte	sid
private static int	SIZE

Fields inherited from class loci.poi.hssf.record.formula.Ptg

CLASS_ARRAY, CLASS_REF, CLASS_VALUE, ptgClass

Constructor Summary

Constructors

Constructor and Description
Area3DPtg() Creates new AreaPtg
Area3DPtg(RecordInputStream in)
Area3DPtg(String arearef, short externIdx)

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone()
boolean	equals(Object o)
byte	getDefaultOperandClass()
short	getExternSheetIndex()
short	getFirstColumn()
short	getFirstColumnRaw()
short	getFirstRow()
short	getLastColumn()
short	getLastColumnRaw()
short	getLastRow()
int	getSize()
int	hashCode()
boolean	isFirstColRelative()
boolean	isFirstRowRelative()
boolean	isLastColRelative()
boolean	isLastRowRelative()
void	setArea(String ref)
void	setExternSheetIndex(short index)
void	setFirstColRelative(boolean rel) set whether the first column is relative
void	setFirstColumn(short column)
void	setFirstColumnRaw(short column)
void	setFirstRow(short row)
void	setFirstRowRelative(boolean rel) sets the first row to relative or not
void	setLastColRelative(boolean rel) set whether the last column should be relative or not
void	setLastColumn(short column)
void	setLastColumnRaw(short column)
void	setLastRow(short row)
void	setLastRowRelative(boolean rel) set whether the last row is relative or not
String	toFormulaString(Workbook book) return a string representation of this token alone
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 loci.poi.hssf.record.formula.Ptg

createParsedExpressionTokens, createPtg, getBytes, getPtgClass, serializePtgStack, setClass, toDebugString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

sid

public static final byte sid

See Also:

Constant Field Values

SIZE

private static final int SIZE

See Also:

Constant Field Values

field_1_index_extern_sheet

private short field_1_index_extern_sheet

field_2_first_row

private short field_2_first_row

field_3_last_row

private short field_3_last_row

field_4_first_column

private short field_4_first_column

field_5_last_column

private short field_5_last_column

rowRelative

private BitField rowRelative

colRelative

private BitField colRelative

Constructor Detail

Area3DPtg

public Area3DPtg()

Creates new AreaPtg

Area3DPtg

public Area3DPtg(String arearef,
         short externIdx)

Area3DPtg

public Area3DPtg(RecordInputStream in)

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

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

getExternSheetIndex

public short getExternSheetIndex()

setExternSheetIndex

public void setExternSheetIndex(short index)

getFirstRow

public short getFirstRow()

setFirstRow

public void setFirstRow(short row)

getLastRow

public short getLastRow()

setLastRow

public void setLastRow(short row)

getFirstColumn

public short getFirstColumn()

getFirstColumnRaw

public short getFirstColumnRaw()

isFirstRowRelative

public boolean isFirstRowRelative()

isFirstColRelative

public boolean isFirstColRelative()

setFirstColumn

public void setFirstColumn(short column)

setFirstColumnRaw

public void setFirstColumnRaw(short column)

getLastColumn

public short getLastColumn()

getLastColumnRaw

public short getLastColumnRaw()

isLastRowRelative

public boolean isLastRowRelative()

isLastColRelative

public boolean isLastColRelative()

setLastColumn

public void setLastColumn(short column)

setLastColumnRaw

public void setLastColumnRaw(short column)

setFirstRowRelative

public void setFirstRowRelative(boolean rel)

sets the first row to relative or not

Parameters:

rel - FIXME: Document this!

setFirstColRelative

public void setFirstColRelative(boolean rel)

set whether the first column is relative

setLastRowRelative

public void setLastRowRelative(boolean rel)

set whether the last row is relative or not

Parameters:

rel - FIXME: Document this!

setLastColRelative

public void setLastColRelative(boolean rel)

set whether the last column should be relative or not

setArea

public void setArea(String ref)

toFormulaString

public String toFormulaString(Workbook book)

Description copied from class: Ptg

return a string representation of this token alone

Specified by:

toFormulaString in class Ptg

getDefaultOperandClass

public byte getDefaultOperandClass()

Specified by:

getDefaultOperandClass in class Ptg

clone

public Object clone()

Specified by:

clone in class Ptg

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object