WindowTwoRecord (POI API Documentation)

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.WindowTwoRecord

All Implemented Interfaces:

Duplicatable, GenericRecord
```
public final class WindowTwoRecord
extends StandardRecord
```
Sheet window settings

Version:

2.0-pre

Field Summary

Fields
Modifier and Type Field and Description

static short sid

Fields
Modifier and Type	Field and Description
`static short`	`sid`

Constructor Summary

Constructors
Constructor and Description

WindowTwoRecord()

WindowTwoRecord(RecordInputStream in)

WindowTwoRecord(WindowTwoRecord other)

Constructors
Constructor and Description
`WindowTwoRecord()`
`WindowTwoRecord(RecordInputStream in)`
`WindowTwoRecord(WindowTwoRecord other)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WindowTwoRecord`	`copy()`
`boolean`	`getArabic()` is this arabic?
`protected int`	`getDataSize()`
`boolean`	`getDefaultHeader()` get whether the window should display a default header
`boolean`	`getDisplayFormulas()` get whether the window should display formulas
`boolean`	`getDisplayGridlines()` get whether the window should display gridlines
`boolean`	`getDisplayGuts()` get whether the outline symbols are displaed
`boolean`	`getDisplayRowColHeadings()` get whether the window should display row and column headings
`boolean`	`getDisplayZeros()` get whether the window should display zero values
`boolean`	`getFreezePanes()` get whether the window should freeze panes
`boolean`	`getFreezePanesNoSplit()` freeze unsplit panes or not
`java.util.Map<java.lang.String,java.util.function.Supplier<?>>`	`getGenericProperties()`
`HSSFRecordTypes`	`getGenericRecordType()`
`int`	`getHeaderColor()` get the palette index for the header color
`short`	`getLeftCol()` get the leftmost column displayed in the window
`short`	`getNormalZoom()` get the zoom magnification in normal view
`short`	`getOptions()` get the options bitmask or just use the bit setters.
`short`	`getPageBreakZoom()` zoom magification in page break view
`int`	`getReserved()` get the reserved bits - why would you do this?
`boolean`	`getSavedInPageBreakPreview()` was the sheet saved in page break view
`boolean`	`getSelected()` sheet tab is selected
`short`	`getSid()` return the non static version of the id for this record.
`short`	`getTopRow()` get the top row visible in the window
`boolean`	`isActive()` is the sheet currently displayed in the window
`void`	`serialize(LittleEndianOutput out)` Write the data content of this BIFF record.
`void`	`setActive(boolean p)` is the sheet currently displayed in the window
`void`	`setArabic(boolean isarabic)` is this arabic?
`void`	`setDefaultHeader(boolean header)` set whether the window should display a default header
`void`	`setDisplayFormulas(boolean formulas)` set whether the window should display formulas
`void`	`setDisplayGridlines(boolean gridlines)` set whether the window should display gridlines
`void`	`setDisplayGuts(boolean guts)` set whether the outline symbols are displaed
`void`	`setDisplayRowColHeadings(boolean headings)` set whether the window should display row and column headings
`void`	`setDisplayZeros(boolean zeros)` set whether the window should display zero values
`void`	`setFreezePanes(boolean freezepanes)` set whether the window should freeze panes
`void`	`setFreezePanesNoSplit(boolean freeze)` freeze unsplit panes or not
`void`	`setHeaderColor(int color)` set the palette index for the header color
`void`	`setLeftCol(short leftCol)` set the leftmost column displayed in the window
`void`	`setNormalZoom(short zoom)` set the zoom magnification in normal view
`void`	`setOptions(short options)` set the options bitmask or just use the bit setters.
`void`	`setPageBreakZoom(short zoom)` zoom magnification in page break view
`void`	`setReserved(int reserved)` set the reserved (don't do this) value
`void`	`setSavedInPageBreakPreview(boolean p)` was the sheet saved in page break view
`void`	`setSelected(boolean sel)` sheet tab is selected
`void`	`setTopRow(short topRow)` set the top row visible in the window

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

Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord
getGenericChildren

- Field Detail
  - sid
```
public static final short sid
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - WindowTwoRecord
```
public WindowTwoRecord()
```
  - WindowTwoRecord
```
public WindowTwoRecord(WindowTwoRecord other)
```
  - WindowTwoRecord
```
public WindowTwoRecord(RecordInputStream in)
```
- Method Detail
  - setOptions
```
public void setOptions(short options)
```
    set the options bitmask or just use the bit setters.
    
    Parameters:
    
    options - Which options to set for this record
  - setDisplayFormulas
```
public void setDisplayFormulas(boolean formulas)
```
    set whether the window should display formulas
    
    Parameters:
    
    formulas - or not
  - setDisplayGridlines
```
public void setDisplayGridlines(boolean gridlines)
```
    set whether the window should display gridlines
    
    Parameters:
    
    gridlines - or not
  - setDisplayRowColHeadings
```
public void setDisplayRowColHeadings(boolean headings)
```
    set whether the window should display row and column headings
    
    Parameters:
    
    headings - or not
  - setFreezePanes
```
public void setFreezePanes(boolean freezepanes)
```
    set whether the window should freeze panes
    
    Parameters:
    
    freezepanes - freeze panes or not
  - setDisplayZeros
```
public void setDisplayZeros(boolean zeros)
```
    set whether the window should display zero values
    
    Parameters:
    
    zeros - or not
  - setDefaultHeader
```
public void setDefaultHeader(boolean header)
```
    set whether the window should display a default header
    
    Parameters:
    
    header - or not
  - setArabic
```
public void setArabic(boolean isarabic)
```
    is this arabic?
    
    Parameters:
    
    isarabic - arabic or not
  - setDisplayGuts
```
public void setDisplayGuts(boolean guts)
```
    set whether the outline symbols are displaed
    
    Parameters:
    
    guts - symbols or not
  - setFreezePanesNoSplit
```
public void setFreezePanesNoSplit(boolean freeze)
```
    freeze unsplit panes or not
    
    Parameters:
    
    freeze - or not
  - setSelected
```
public void setSelected(boolean sel)
```
    sheet tab is selected
    
    Parameters:
    
    sel - selected or not
  - setActive
```
public void setActive(boolean p)
```
    is the sheet currently displayed in the window
    
    Parameters:
    
    p - displayed or not
  - setSavedInPageBreakPreview
```
public void setSavedInPageBreakPreview(boolean p)
```
    was the sheet saved in page break view
    
    Parameters:
    
    p - pagebreaksaved or not
  - setTopRow
```
public void setTopRow(short topRow)
```
    set the top row visible in the window
    
    Parameters:
    
    topRow - top row visible
  - setLeftCol
```
public void setLeftCol(short leftCol)
```
    set the leftmost column displayed in the window
    
    Parameters:
    
    leftCol - leftmost column
  - setHeaderColor
```
public void setHeaderColor(int color)
```
    set the palette index for the header color
    
    Parameters:
    
    color - Which color to use for the header, see the specification for details
  - setPageBreakZoom
```
public void setPageBreakZoom(short zoom)
```
    zoom magnification in page break view
    
    Parameters:
    
    zoom - The zoom-level to use for the page-break view
  - setNormalZoom
```
public void setNormalZoom(short zoom)
```
    set the zoom magnification in normal view
    
    Parameters:
    
    zoom - The zoom-level to use for the normal view
  - setReserved
```
public void setReserved(int reserved)
```
    set the reserved (don't do this) value
    
    Parameters:
    
    reserved - reserved value usually does not need to be set
  - getOptions
```
public short getOptions()
```
    get the options bitmask or just use the bit setters.
    
    Returns:
    
    options
  - getDisplayFormulas
```
public boolean getDisplayFormulas()
```
    get whether the window should display formulas
    
    Returns:
    
    formulas or not
  - getDisplayGridlines
```
public boolean getDisplayGridlines()
```
    get whether the window should display gridlines
    
    Returns:
    
    gridlines or not
  - getDisplayRowColHeadings
```
public boolean getDisplayRowColHeadings()
```
    get whether the window should display row and column headings
    
    Returns:
    
    headings or not
  - getFreezePanes
```
public boolean getFreezePanes()
```
    get whether the window should freeze panes
    
    Returns:
    
    freeze panes or not
  - getDisplayZeros
```
public boolean getDisplayZeros()
```
    get whether the window should display zero values
    
    Returns:
    
    zeros or not
  - getDefaultHeader
```
public boolean getDefaultHeader()
```
    get whether the window should display a default header
    
    Returns:
    
    header or not
  - getArabic
```
public boolean getArabic()
```
    is this arabic?
    
    Returns:
    
    arabic or not
  - getDisplayGuts
```
public boolean getDisplayGuts()
```
    get whether the outline symbols are displaed
    
    Returns:
    
    symbols or not
  - getFreezePanesNoSplit
```
public boolean getFreezePanesNoSplit()
```
    freeze unsplit panes or not
    
    Returns:
    
    freeze or not
  - getSelected
```
public boolean getSelected()
```
    sheet tab is selected
    
    Returns:
    
    selected or not
  - isActive
```
public boolean isActive()
```
    is the sheet currently displayed in the window
    
    Returns:
    
    displayed or not
  - getSavedInPageBreakPreview
```
public boolean getSavedInPageBreakPreview()
```
    was the sheet saved in page break view
    
    Returns:
    
    pagebreaksaved or not
  - getTopRow
```
public short getTopRow()
```
    get the top row visible in the window
    
    Returns:
    
    toprow
  - getLeftCol
```
public short getLeftCol()
```
    get the leftmost column displayed in the window
    
    Returns:
    
    leftmost
  - getHeaderColor
```
public int getHeaderColor()
```
    get the palette index for the header color
    
    Returns:
    
    color
  - getPageBreakZoom
```
public short getPageBreakZoom()
```
    zoom magification in page break view
    
    Returns:
    
    zoom
  - getNormalZoom
```
public short getNormalZoom()
```
    get the zoom magnification in normal view
    
    Returns:
    
    zoom
  - getReserved
```
public int getReserved()
```
    get the reserved bits - why would you do this?
    
    Returns:
    
    reserved stuff -probably garbage
  - 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
  - copy
```
public WindowTwoRecord copy()
```
    Specified by:
    
    copy in interface Duplicatable
    
    Specified by:
    
    copy in class StandardRecord
    
    Returns:
    
    a deep copy of the implementing class / instance
  - getGenericRecordType
```
public HSSFRecordTypes getGenericRecordType()
```
    Specified by:
    
    getGenericRecordType in interface GenericRecord
    
    Specified by:
    
    getGenericRecordType in class Record
  - getGenericProperties
```
public java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()
```

Class WindowTwoRecord

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.poi.hssf.record.StandardRecord

Methods inherited from class org.apache.poi.hssf.record.Record

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord

Field Detail

sid

Constructor Detail

WindowTwoRecord

WindowTwoRecord

WindowTwoRecord

Method Detail

setOptions

setDisplayFormulas

setDisplayGridlines

setDisplayRowColHeadings

setFreezePanes

setDisplayZeros

setDefaultHeader

setArabic

setDisplayGuts

setFreezePanesNoSplit

setSelected

setActive

setSavedInPageBreakPreview

setTopRow

setLeftCol

setHeaderColor

setPageBreakZoom

setNormalZoom

setReserved

getOptions

getDisplayFormulas

getDisplayGridlines

getDisplayRowColHeadings

getFreezePanes

getDisplayZeros

getDefaultHeader

getArabic

getDisplayGuts

getFreezePanesNoSplit

getSelected

isActive

getSavedInPageBreakPreview

getTopRow

getLeftCol

getHeaderColor

getPageBreakZoom

getNormalZoom

getReserved

serialize

getDataSize

getSid

copy

getGenericRecordType

getGenericProperties