Top Description Fields Constructors Methods
org.apache.poi.hssf.record

public final Class WSBoolRecord

extends StandardRecord
Class Inheritance
Static Imports
org.apache.poi.util.GenericRecordUtil.getBitsAsString
Stores workbook settings (aka its a big "everything we didn't put somewhere else")

Field Summary

Modifier and TypeField and Description
private static final BitField
alternateexpression

private static final BitField
alternateformula

private static final BitField
applystyles

private static final BitField
autobreaks

private static final BitField
dialog

private static final BitField
displayguts

private byte
field_1_wsbool

private byte
field_2_wsbool

private static final BitField
fittopage

private static final BitField
rowsumsbelow

private static final BitField
rowsumsright

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
WSBoolRecord()

public
WSBoolRecord(WSBoolRecord other)

public
WSBoolRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public WSBoolRecord
copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

public boolean

Returns:

alternative expression evaluation or not
getAlternateExpression()

whether alternate expression evaluation is on

public boolean

Returns:

alternative formulas or not
getAlternateFormula()

whether alternative formula entry is on

public boolean

Returns:

whether to show auto page breaks
getAutobreaks()

show automatic page breaks or not

protected int
getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

public boolean

Returns:

isDialog or not
getDialog()

get whether sheet is a dialog sheet or not

public boolean

Returns:

guts or no guts (or glory)
getDisplayGuts()

get whether to display the guts or not

public boolean

Returns:

fit or not
getFitToPage()

fit to page option is on

public Map<String, Supplier<?>>
getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public HSSFRecordTypes
getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

public boolean

Returns:

below or not
getRowSumsBelow()

get if row summaries appear below detail in the outline

public boolean

Returns:

right or not
getRowSumsRight()

get if col summaries appear right of the detail in the outline

public short
getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

public byte

Returns:

boolean 1 of this record
getWSBool1()

get first byte (see bit getters)

public byte

Returns:

boolean 1 of this record
getWSBool2()

get the second byte (see bit getters)

public void
serialize(LittleEndianOutput
the output object
out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Write the data content of this BIFF record.

public void
setAlternateExpression(boolean
alternative expression evaluation or not
altexp)

whether alternate expression evaluation is on

public void
setAlternateFormula(boolean
alternative formulas or not
formula)

whether alternative formula entry is on

public void
setAutobreaks(boolean
whether to show auto page breaks
ab)

show automatic page breaks or not

public void
setDialog(boolean
or not
isDialog)

set whether sheet is a dialog sheet or not

public void
setDisplayGuts(boolean
or no guts (or glory)
guts)

set whether to display the guts or not

public void
setFitToPage(boolean
fit or not
fit2page)

fit to page option is on

public void
setRowSumsBelow(boolean
or not
below)

set if row summaries appear below detail in the outline

public void
setRowSumsRight(boolean
or not
right)

set if col summaries appear right of the detail in the outline

public void
setWSBool1(byte
Set boolean 1 of this record
bool1)

set first byte (see bit setters)

public void
setWSBool2(byte
Set boolean 2 of this record
bool2)

set the second byte (see bit setters)

Inherited from org.apache.poi.hssf.record.StandardRecord:
getRecordSizeserialize

Field Detail

alternateexpressionback to summary
private static final BitField alternateexpression
alternateformulaback to summary
private static final BitField alternateformula
applystylesback to summary
private static final BitField applystyles
autobreaksback to summary
private static final BitField autobreaks
dialogback to summary
private static final BitField dialog
displaygutsback to summary
private static final BitField displayguts
field_1_wsboolback to summary
private byte field_1_wsbool
field_2_wsboolback to summary
private byte field_2_wsbool
fittopageback to summary
private static final BitField fittopage
rowsumsbelowback to summary
private static final BitField rowsumsbelow
rowsumsrightback to summary
private static final BitField rowsumsright
sidback to summary
public static final short sid

Constructor Detail

WSBoolRecordback to summary
public WSBoolRecord()
WSBoolRecordback to summary
public WSBoolRecord(WSBoolRecord other)
WSBoolRecordback to summary
public WSBoolRecord(RecordInputStream in)

Method Detail

copyback to summary
public WSBoolRecord copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:WSBoolRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations
@Override
getAlternateExpressionback to summary
public boolean getAlternateExpression()

whether alternate expression evaluation is on

Returns:boolean

alternative expression evaluation or not

getAlternateFormulaback to summary
public boolean getAlternateFormula()

whether alternative formula entry is on

Returns:boolean

alternative formulas or not

getAutobreaksback to summary
public boolean getAutobreaks()

show automatic page breaks or not

Returns:boolean

whether to show auto page breaks

getDataSizeback to summary
protected int getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

getDialogback to summary
public boolean getDialog()

get whether sheet is a dialog sheet or not

Returns:boolean

isDialog or not

getDisplayGutsback to summary
public boolean getDisplayGuts()

get whether to display the guts or not

Returns:boolean

guts or no guts (or glory)

getFitToPageback to summary
public boolean getFitToPage()

fit to page option is on

Returns:boolean

fit or not

getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getGenericRecordTypeback to summary
public HSSFRecordTypes getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

Annotations
@Override
getRowSumsBelowback to summary
public boolean getRowSumsBelow()

get if row summaries appear below detail in the outline

Returns:boolean

below or not

getRowSumsRightback to summary
public boolean getRowSumsRight()

get if col summaries appear right of the detail in the outline

Returns:boolean

right or not

getSidback to summary
public short getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

Doc from org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

Returns:short

he id for this record

getWSBool1back to summary
public byte getWSBool1()

get first byte (see bit getters)

Returns:byte

boolean 1 of this record

getWSBool2back to summary
public byte getWSBool2()

get the second byte (see bit getters)

Returns:byte

boolean 1 of this record

serializeback to summary
public void serialize(LittleEndianOutput out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Doc from org.apache.poi.hssf.record.StandardRecord.serialize.

Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.

The number of bytes written must equal the record size reported by org.apache.poi.hssf.record.Record#getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Parameters
out:LittleEndianOutput

the output object

setAlternateExpressionback to summary
public void setAlternateExpression(boolean altexp)

whether alternate expression evaluation is on

Parameters
altexp:boolean

alternative expression evaluation or not

setAlternateFormulaback to summary
public void setAlternateFormula(boolean formula)

whether alternative formula entry is on

Parameters
formula:boolean

alternative formulas or not

setAutobreaksback to summary
public void setAutobreaks(boolean ab)

show automatic page breaks or not

Parameters
ab:boolean

whether to show auto page breaks

setDialogback to summary
public void setDialog(boolean isDialog)

set whether sheet is a dialog sheet or not

Parameters
isDialog:boolean

or not

setDisplayGutsback to summary
public void setDisplayGuts(boolean guts)

set whether to display the guts or not

Parameters
guts:boolean

or no guts (or glory)

setFitToPageback to summary
public void setFitToPage(boolean fit2page)

fit to page option is on

Parameters
fit2page:boolean

fit or not

setRowSumsBelowback to summary
public void setRowSumsBelow(boolean below)

set if row summaries appear below detail in the outline

Parameters
below:boolean

or not

setRowSumsRightback to summary
public void setRowSumsRight(boolean right)

set if col summaries appear right of the detail in the outline

Parameters
right:boolean

or not

setWSBool1back to summary
public void setWSBool1(byte bool1)

set first byte (see bit setters)

Parameters
bool1:byte

Set boolean 1 of this record

setWSBool2back to summary
public void setWSBool2(byte bool2)

set the second byte (see bit setters)

Parameters
bool2:byte

Set boolean 2 of this record