|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.poi.hssf.record.RecordBase
org.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.FormulaRecord
public final class FormulaRecord
Formula Record (0x0006). REFERENCE: PG 317/444 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
| Field Summary | |
|---|---|
static short |
sid
|
| Constructor Summary | |
|---|---|
FormulaRecord()
Creates new FormulaRecord |
|
FormulaRecord(RecordInputStream in)
|
|
| Method Summary | |
|---|---|
java.lang.Object |
clone()
|
boolean |
getCachedBooleanValue()
|
int |
getCachedErrorValue()
|
int |
getCachedResultType()
|
short |
getColumn()
|
short |
getOptions()
get the option flags |
Ptg[] |
getParsedExpression()
|
int |
getRecordSize()
gives the current serialized size of the record. |
int |
getRow()
|
short |
getSid()
return the non static version of the id for this record. |
double |
getValue()
get the calculated value of the formula |
short |
getXFIndex()
|
boolean |
hasCachedResultString()
|
boolean |
isAlwaysCalc()
|
boolean |
isCalcOnLoad()
|
boolean |
isSharedFormula()
|
int |
serialize(int offset,
byte[] data)
called by the class that is responsible for writing this sucker. |
void |
setAlwaysCalc(boolean flag)
|
void |
setCachedResultBoolean(boolean value)
|
void |
setCachedResultErrorCode(int errorCode)
|
void |
setCachedResultTypeEmptyString()
|
void |
setCachedResultTypeString()
|
void |
setCalcOnLoad(boolean flag)
|
void |
setColumn(short column)
|
void |
setOptions(short options)
set the option flags |
void |
setParsedExpression(Ptg[] ptgs)
|
void |
setRow(int row)
|
void |
setSharedFormula(boolean flag)
|
void |
setValue(double value)
set the calculated value of the formula |
void |
setXFIndex(short xf)
|
java.lang.String |
toString()
get a string representation of the record (for biffview/debugging) |
| Methods inherited from class org.apache.poi.hssf.record.Record |
|---|
cloneViaReserialise, serialize |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final short sid
| Constructor Detail |
|---|
public FormulaRecord()
public FormulaRecord(RecordInputStream in)
| Method Detail |
|---|
public void setRow(int row)
setRow in interface CellValueRecordInterfacerow - the row this cell occurs withinpublic void setColumn(short column)
setColumn in interface CellValueRecordInterfacecolumn - the column this cell definespublic void setXFIndex(short xf)
setXFIndex in interface CellValueRecordInterfacepublic void setValue(double value)
value - calculated valuepublic void setCachedResultTypeEmptyString()
public void setCachedResultTypeString()
public void setCachedResultErrorCode(int errorCode)
public void setCachedResultBoolean(boolean value)
public boolean hasCachedResultString()
true if this FormulaRecord is followed by a
StringRecord representing the cached text result of the formula
evaluation.public int getCachedResultType()
public boolean getCachedBooleanValue()
public int getCachedErrorValue()
public void setOptions(short options)
options - bitmaskpublic int getRow()
getRow in interface CellValueRecordInterfacepublic short getColumn()
getColumn in interface CellValueRecordInterfacepublic short getXFIndex()
getXFIndex in interface CellValueRecordInterfacepublic double getValue()
public short getOptions()
public boolean isSharedFormula()
public void setSharedFormula(boolean flag)
public boolean isAlwaysCalc()
public void setAlwaysCalc(boolean flag)
public boolean isCalcOnLoad()
public void setCalcOnLoad(boolean flag)
public Ptg[] getParsedExpression()
nullpublic void setParsedExpression(Ptg[] ptgs)
public short getSid()
Record
getSid in class Record
public int serialize(int offset,
byte[] data)
RecordBase
serialize in class RecordBaseoffset - to begin writing atdata - byte array containing instance data
public int getRecordSize()
Record
getRecordSize in class Recordpublic java.lang.String toString()
Record
toString in class Recordpublic java.lang.Object clone()
clone in class Record
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||