|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.poi.hssf.record.Record | +--org.apache.poi.hssf.record.WSBoolRecord
Title: WSBool Record.
Description: stores workbook settings (aka its a big "everything we didn't put somewhere else")
REFERENCE: PG 425 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
Field Summary | |
static short |
sid
|
Constructor Summary | |
WSBoolRecord()
|
|
WSBoolRecord(short id,
short size,
byte[] data)
Constructs a WSBool record and sets its fields appropriately. |
|
WSBoolRecord(short id,
short size,
byte[] data,
int offset)
Constructs a WSBool record and sets its fields appropriately. |
Method Summary | |
protected void |
fillFields(byte[] data,
short size,
int offset)
called by the constructor, should set class level fields. |
boolean |
getAlternateExpression()
whether alternate expression evaluation is on |
boolean |
getAlternateFormula()
whether alternative formula entry is on |
boolean |
getAutobreaks()
show automatic page breaks or not |
boolean |
getDialog()
get whether sheet is a dialog sheet or not |
boolean |
getDisplayGuts()
get whether to display the guts or not |
boolean |
getFitToPage()
fit to page option is on |
int |
getRecordSize()
gives the current serialized size of the record. |
boolean |
getRowSumsBelow()
get if row summaries appear below detail in the outline |
boolean |
getRowSumsRight()
get if col summaries appear right of the detail in the outline |
short |
getSid()
return the non static version of the id for this record. |
byte |
getWSBool1()
get first byte (see bit getters) |
byte |
getWSBool2()
get the second byte (see bit getters) |
int |
serialize(int offset,
byte[] data)
called by the class that is responsible for writing this sucker. |
void |
setAlternateExpression(boolean altexp)
whether alternate expression evaluation is on |
void |
setAlternateFormula(boolean formula)
whether alternative formula entry is on |
void |
setAutobreaks(boolean ab)
show automatic page breaks or not |
void |
setDialog(boolean isDialog)
set whether sheet is a dialog sheet or not |
void |
setDisplayGuts(boolean guts)
set whether to display the guts or not |
void |
setFitToPage(boolean fit2page)
fit to page option is on |
void |
setRowSumsBelow(boolean below)
set if row summaries appear below detail in the outline |
void |
setRowSumsRight(boolean right)
set if col summaries appear right of the detail in the outline |
void |
setWSBool1(byte bool1)
set first byte (see bit setters) |
void |
setWSBool2(byte bool2)
set the second byte (see bit setters) |
java.lang.String |
toString()
get a string representation of the record (for biffview/debugging) |
protected void |
validateSid(short id)
called by constructor, should throw runtime exception in the event of a record passed with a differing ID. |
Methods inherited from class org.apache.poi.hssf.record.Record |
fillFields, isInValueSection, isValue, processContinueRecord, serialize |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final short sid
Constructor Detail |
public WSBoolRecord()
public WSBoolRecord(short id, short size, byte[] data)
id
- id must be 0x81 or an exception will be throw upon validationsize
- the size of the data area of the recorddata
- data of the record (should not contain sid/len)public WSBoolRecord(short id, short size, byte[] data, int offset)
id
- id must be 0x81 or an exception will be throw upon validationsize
- the size of the data area of the recorddata
- data of the record (should not contain sid/len)Method Detail |
protected void validateSid(short id)
Record
validateSid
in class Record
org.apache.poi.hssf.record.Record
id
- alleged id for this recordprotected void fillFields(byte[] data, short size, int offset)
Record
fillFields
in class Record
org.apache.poi.hssf.record.Record
data
- raw datasize
- size of dataoffset
- of the record's data (provided a big array of the file)public void setWSBool1(byte bool1)
public void setAutobreaks(boolean ab)
ab
- whether to show auto page breakspublic void setDialog(boolean isDialog)
isDialog
- or notpublic void setRowSumsBelow(boolean below)
below
- or notpublic void setRowSumsRight(boolean right)
right
- or notpublic void setWSBool2(byte bool2)
public void setFitToPage(boolean fit2page)
fit2page
- fit or notpublic void setDisplayGuts(boolean guts)
guts
- or no guts (or glory)public void setAlternateExpression(boolean altexp)
altexp
- alternative expression evaluation or notpublic void setAlternateFormula(boolean formula)
formula
- alternative formulas or notpublic byte getWSBool1()
public boolean getAutobreaks()
public boolean getDialog()
public boolean getRowSumsBelow()
public boolean getRowSumsRight()
public byte getWSBool2()
public boolean getFitToPage()
public boolean getDisplayGuts()
public boolean getAlternateExpression()
public boolean getAlternateFormula()
public java.lang.String toString()
Record
toString
in class Record
public int serialize(int offset, byte[] data)
Record
serialize
in class Record
org.apache.poi.hssf.record.Record
offset
- to begin writing atdata
- byte array containing instance datapublic int getRecordSize()
Record
getRecordSize
in class Record
public short getSid()
Record
getSid
in class Record
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |