Package loci.poi.hssf.record
Class WSBoolRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.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)
- Version:
- 2.0-pre
- Author:
- Andrew C. Oliver (acoliver at apache dot org), Glen Stampoultzis (gstamp@iprimus.com.au), Jason Height (jheight at chariot dot net dot au)
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a WSBool record and sets its fields appropriately. -
Method Summary
Modifier and TypeMethodDescriptionclone()protected voidcalled by the constructor, should set class level fields.booleanwhether alternate expression evaluation is onbooleanwhether alternative formula entry is onbooleanshow automatic page breaks or notbooleanget whether sheet is a dialog sheet or notbooleanget whether to display the guts or notbooleanfit to page option is onintgives the current serialized size of the record.booleanget if row summaries appear below detail in the outlinebooleanget if col summaries appear right of the detail in the outlineshortgetSid()return the non static version of the id for this record.byteget first byte (see bit getters)byteget the second byte (see bit getters)intserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.voidsetAlternateExpression(boolean altexp) whether alternate expression evaluation is onvoidsetAlternateFormula(boolean formula) whether alternative formula entry is onvoidsetAutobreaks(boolean ab) show automatic page breaks or notvoidsetDialog(boolean isDialog) set whether sheet is a dialog sheet or notvoidsetDisplayGuts(boolean guts) set whether to display the guts or notvoidsetFitToPage(boolean fit2page) fit to page option is onvoidsetRowSumsBelow(boolean below) set if row summaries appear below detail in the outlinevoidsetRowSumsRight(boolean right) set if col summaries appear right of the detail in the outlinevoidsetWSBool1(byte bool1) set first byte (see bit setters)voidsetWSBool2(byte bool2) set the second byte (see bit setters)toString()get a string representation of the record (for biffview/debugging)protected voidvalidateSid(short id) called by constructor, should throw runtime exception in the event of a record passed with a differing ID.Methods inherited from class loci.poi.hssf.record.Record
isInValueSection, isValue, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
-
Constructor Details
-
WSBoolRecord
public WSBoolRecord() -
WSBoolRecord
Constructs a WSBool record and sets its fields appropriately.- Parameters:
in- the RecordInputstream to read the record from
-
-
Method Details
-
validateSid
protected void validateSid(short id) Description copied from class:Recordcalled by constructor, should throw runtime exception in the event of a record passed with a differing ID.- Specified by:
validateSidin classRecord- Parameters:
id- alleged id for this record
-
fillFields
Description copied from class:Recordcalled by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.- Specified by:
fillFieldsin classRecord- Parameters:
in- the RecordInputstream to read the record from
-
setWSBool1
public void setWSBool1(byte bool1) set first byte (see bit setters) -
setAutobreaks
public void setAutobreaks(boolean ab) show automatic page breaks or not- Parameters:
ab- whether to show auto page breaks
-
setDialog
public void setDialog(boolean isDialog) set whether sheet is a dialog sheet or not- Parameters:
isDialog- or not
-
setRowSumsBelow
public void setRowSumsBelow(boolean below) set if row summaries appear below detail in the outline- Parameters:
below- or not
-
setRowSumsRight
public void setRowSumsRight(boolean right) set if col summaries appear right of the detail in the outline- Parameters:
right- or not
-
setWSBool2
public void setWSBool2(byte bool2) set the second byte (see bit setters) -
setFitToPage
public void setFitToPage(boolean fit2page) fit to page option is on- Parameters:
fit2page- fit or not
-
setDisplayGuts
public void setDisplayGuts(boolean guts) set whether to display the guts or not- Parameters:
guts- or no guts (or glory)
-
setAlternateExpression
public void setAlternateExpression(boolean altexp) whether alternate expression evaluation is on- Parameters:
altexp- alternative expression evaluation or not
-
setAlternateFormula
public void setAlternateFormula(boolean formula) whether alternative formula entry is on- Parameters:
formula- alternative formulas or not
-
getWSBool1
public byte getWSBool1()get first byte (see bit getters) -
getAutobreaks
public boolean getAutobreaks()show automatic page breaks or not- Returns:
- whether to show auto page breaks
-
getDialog
public boolean getDialog()get whether sheet is a dialog sheet or not- Returns:
- isDialog or not
-
getRowSumsBelow
public boolean getRowSumsBelow()get if row summaries appear below detail in the outline- Returns:
- below or not
-
getRowSumsRight
public boolean getRowSumsRight()get if col summaries appear right of the detail in the outline- Returns:
- right or not
-
getWSBool2
public byte getWSBool2()get the second byte (see bit getters) -
getFitToPage
public boolean getFitToPage()fit to page option is on- Returns:
- fit or not
-
getDisplayGuts
public boolean getDisplayGuts()get whether to display the guts or not- Returns:
- guts or no guts (or glory)
-
getAlternateExpression
public boolean getAlternateExpression()whether alternate expression evaluation is on- Returns:
- alternative expression evaluation or not
-
getAlternateFormula
public boolean getAlternateFormula()whether alternative formula entry is on- Returns:
- alternative formulas or not
-
toString
Description copied from class:Recordget a string representation of the record (for biffview/debugging) -
serialize
public int serialize(int offset, byte[] data) Description copied from class:Recordcalled by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array. -
getRecordSize
public int getRecordSize()Description copied from class:Recordgives the current serialized size of the record. Should include the sid and reclength (4 bytes).- Overrides:
getRecordSizein classRecord
-
getSid
public short getSid()Description copied from class:Recordreturn the non static version of the id for this record. -
clone
-