Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.poi.hssf.record
Class WSBoolRecord

    java.lang.Object
      org.apache.poi.hssf.record.RecordBase
          org.apache.poi.hssf.record.Record
              org.apache.poi.hssf.record.StandardRecord
                  org.apache.poi.hssf.record.WSBoolRecord

    public final class WSBoolRecord

extends StandardRecord

Title: WSBOOL (0x0081) (called SHEETPR in OOO doc)

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(RecordInputStream in)`

Method Summary
`java.lang.Object` | `clone()`
`boolean` | `getAlternateExpression()` whether alternate expression evaluation is on
`boolean` | `getAlternateFormula()` whether alternative formula entry is on
`boolean` | `getAutobreaks()` show automatic page breaks or not
`protected int` | `getDataSize()`
`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
`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)
`void` | `serialize(LittleEndianOutput out)` Write the data content of this BIFF record.
`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)

Methods inherited from class org.apache.poi.hssf.record.StandardRecord
`getRecordSize, serialize`

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

### sid

    public static final short sid

See Also:
  Constant Field Values

Constructor Detail

### WSBoolRecord

    public WSBoolRecord()

### WSBoolRecord

    public WSBoolRecord(RecordInputStream in)

Method Detail

### 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

    public java.lang.String toString()

  Description copied from class: `Record`
  get a string representation of the record (for biffview/debugging)

  Overrides:
    `toString` in class `Record`

### serialize

    public void serialize(LittleEndianOutput out)

  Description copied from class: `StandardRecord`
  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 `RecordBase.getRecordSize()`} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

  Specified by:
    `serialize` in class `StandardRecord`
  Parameters:
    `out` - the output object

### getDataSize

    protected int getDataSize()

  Specified by:
    `getDataSize` in class `StandardRecord`

### getSid

    public short getSid()

  Description copied from class: `Record`
  return the non static version of the id for this record.

  Specified by:
    `getSid` in class `Record`
  Returns:
    he id for this record

### clone

    public java.lang.Object clone()

  Overrides:
    `clone` in class `Record`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright 2017 The Apache Software Foundation or its licensors, as applicable.