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

public final Class WindowTwoRecord

extends StandardRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.util.BitField, .BitFieldFactory, .GenericRecordUtil, .LittleEndianOutput
Sheet window settings
Version
2.0-pre

Field Summary

Modifier and TypeField and Description
private static final BitField
active

private static final BitField
arabic

private static final BitField
defaultHeader

if false use color in field 4 if true use default foreground for headers

private static final BitField
displayFormulas

private static final BitField
displayGridlines

private static final BitField
displayGuts

private static final BitField
displayRowColHeadings

private static final BitField
displayZeros

private short
field_1_options

private short
field_2_top_row

private short
field_3_left_col

private int
field_4_header_color

private short
field_5_page_break_zoom

private short
field_6_normal_zoom

private int
field_7_reserved

private static final BitField
freezePanes

private static final BitField
freezePanesNoSplit

private static final BitField
savedInPageBreakPreview

private static final BitField
selected

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
WindowTwoRecord()

public
WindowTwoRecord(WindowTwoRecord other)

public
WindowTwoRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public WindowTwoRecord
copy()

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

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

public boolean

Returns:

arabic or not
getArabic()

is this arabic?

protected int
getDataSize()

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

public boolean

Returns:

header or not
getDefaultHeader()

get whether the window should display a default header

public boolean

Returns:

formulas or not
getDisplayFormulas()

get whether the window should display formulas

public boolean

Returns:

gridlines or not
getDisplayGridlines()

get whether the window should display gridlines

public boolean

Returns:

symbols or not
getDisplayGuts()

get whether the outline symbols are displaed

public boolean

Returns:

headings or not
getDisplayRowColHeadings()

get whether the window should display row and column headings

public boolean

Returns:

zeros or not
getDisplayZeros()

get whether the window should display zero values

public boolean

Returns:

freeze panes or not
getFreezePanes()

get whether the window should freeze panes

public boolean

Returns:

freeze or not
getFreezePanesNoSplit()

freeze unsplit panes or not

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 int

Returns:

color
getHeaderColor()

get the palette index for the header color

public short

Returns:

leftmost
getLeftCol()

get the leftmost column displayed in the window

public short

Returns:

zoom
getNormalZoom()

get the zoom magnification in normal view

public short

Returns:

options
getOptions()

get the options bitmask or just use the bit setters.

public short

Returns:

zoom
getPageBreakZoom()

zoom magification in page break view

public int

Returns:

reserved stuff -probably garbage
getReserved()

get the reserved bits - why would you do this?

public boolean

Returns:

pagebreaksaved or not
getSavedInPageBreakPreview()

was the sheet saved in page break view

public boolean

Returns:

selected or not
getSelected()

sheet tab is selected

public short
getSid()

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

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

public short

Returns:

toprow
getTopRow()

get the top row visible in the window

public boolean

Returns:

displayed or not
isActive()

is the sheet currently displayed in the window

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
setActive(boolean
displayed or not
p)

is the sheet currently displayed in the window

public void
setArabic(boolean
arabic or not
isarabic)

is this arabic?

public void
setDefaultHeader(boolean
or not
header)

set whether the window should display a default header

public void
setDisplayFormulas(boolean
or not
formulas)

set whether the window should display formulas

public void
setDisplayGridlines(boolean
or not
gridlines)

set whether the window should display gridlines

public void
setDisplayGuts(boolean
symbols or not
guts)

set whether the outline symbols are displaed

public void
setDisplayRowColHeadings(boolean
or not
headings)

set whether the window should display row and column headings

public void
setDisplayZeros(boolean
or not
zeros)

set whether the window should display zero values

public void
setFreezePanes(boolean
freeze panes or not
freezepanes)

set whether the window should freeze panes

public void
setFreezePanesNoSplit(boolean
or not
freeze)

freeze unsplit panes or not

public void
setHeaderColor(int
Which color to use for the header, see the specification for details
color)

set the palette index for the header color

public void
setLeftCol(short
leftmost column
leftCol)

set the leftmost column displayed in the window

public void
setNormalZoom(short
The zoom-level to use for the normal view
zoom)

set the zoom magnification in normal view

public void
setOptions(short
Which options to set for this record
options)

set the options bitmask or just use the bit setters.

public void
setPageBreakZoom(short
The zoom-level to use for the page-break view
zoom)

zoom magnification in page break view

public void
setReserved(int
reserved value usually does not need to be set
reserved)

set the reserved (don't do this) value

public void
setSavedInPageBreakPreview(boolean
pagebreaksaved or not
p)

was the sheet saved in page break view

public void
setSelected(boolean
selected or not
sel)

sheet tab is selected

public void
setTopRow(short
top row visible
topRow)

set the top row visible in the window

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

Field Detail

activeback to summary
private static final BitField active
arabicback to summary
private static final BitField arabic
defaultHeaderback to summary
private static final BitField defaultHeader

if false use color in field 4 if true use default foreground for headers

displayFormulasback to summary
private static final BitField displayFormulas
displayGridlinesback to summary
private static final BitField displayGridlines
displayGutsback to summary
private static final BitField displayGuts
displayRowColHeadingsback to summary
private static final BitField displayRowColHeadings
displayZerosback to summary
private static final BitField displayZeros
field_1_optionsback to summary
private short field_1_options
field_2_top_rowback to summary
private short field_2_top_row
field_3_left_colback to summary
private short field_3_left_col
field_4_header_colorback to summary
private int field_4_header_color
field_5_page_break_zoomback to summary
private short field_5_page_break_zoom
field_6_normal_zoomback to summary
private short field_6_normal_zoom
field_7_reservedback to summary
private int field_7_reserved
freezePanesback to summary
private static final BitField freezePanes
freezePanesNoSplitback to summary
private static final BitField freezePanesNoSplit
savedInPageBreakPreviewback to summary
private static final BitField savedInPageBreakPreview
selectedback to summary
private static final BitField selected
sidback to summary
public static final short sid

Constructor Detail

WindowTwoRecordback to summary
public WindowTwoRecord()
WindowTwoRecordback to summary
public WindowTwoRecord(WindowTwoRecord other)
WindowTwoRecordback to summary
public WindowTwoRecord(RecordInputStream in)

Method Detail

copyback to summary
public WindowTwoRecord copy()

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

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

Returns:WindowTwoRecord

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

a deep copy of the implementing class / instance

Annotations
@Override
getArabicback to summary
public boolean getArabic()

is this arabic?

Returns:boolean

arabic or not

getDataSizeback to summary
protected int getDataSize()

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

getDefaultHeaderback to summary
public boolean getDefaultHeader()

get whether the window should display a default header

Returns:boolean

header or not

getDisplayFormulasback to summary
public boolean getDisplayFormulas()

get whether the window should display formulas

Returns:boolean

formulas or not

getDisplayGridlinesback to summary
public boolean getDisplayGridlines()

get whether the window should display gridlines

Returns:boolean

gridlines or not

getDisplayGutsback to summary
public boolean getDisplayGuts()

get whether the outline symbols are displaed

Returns:boolean

symbols or not

getDisplayRowColHeadingsback to summary
public boolean getDisplayRowColHeadings()

get whether the window should display row and column headings

Returns:boolean

headings or not

getDisplayZerosback to summary
public boolean getDisplayZeros()

get whether the window should display zero values

Returns:boolean

zeros or not

getFreezePanesback to summary
public boolean getFreezePanes()

get whether the window should freeze panes

Returns:boolean

freeze panes or not

getFreezePanesNoSplitback to summary
public boolean getFreezePanesNoSplit()

freeze unsplit panes or not

Returns:boolean

freeze 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
getHeaderColorback to summary
public int getHeaderColor()

get the palette index for the header color

Returns:int

color

getLeftColback to summary
public short getLeftCol()

get the leftmost column displayed in the window

Returns:short

leftmost

getNormalZoomback to summary
public short getNormalZoom()

get the zoom magnification in normal view

Returns:short

zoom

getOptionsback to summary
public short getOptions()

get the options bitmask or just use the bit setters.

Returns:short

options

getPageBreakZoomback to summary
public short getPageBreakZoom()

zoom magification in page break view

Returns:short

zoom

getReservedback to summary
public int getReserved()

get the reserved bits - why would you do this?

Returns:int

reserved stuff -probably garbage

getSavedInPageBreakPreviewback to summary
public boolean getSavedInPageBreakPreview()

was the sheet saved in page break view

Returns:boolean

pagebreaksaved or not

getSelectedback to summary
public boolean getSelected()

sheet tab is selected

Returns:boolean

selected 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

getTopRowback to summary
public short getTopRow()

get the top row visible in the window

Returns:short

toprow

isActiveback to summary
public boolean isActive()

is the sheet currently displayed in the window

Returns:boolean

displayed or not

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

setActiveback to summary
public void setActive(boolean p)

is the sheet currently displayed in the window

Parameters
p:boolean

displayed or not

setArabicback to summary
public void setArabic(boolean isarabic)

is this arabic?

Parameters
isarabic:boolean

arabic or not

setDefaultHeaderback to summary
public void setDefaultHeader(boolean header)

set whether the window should display a default header

Parameters
header:boolean

or not

setDisplayFormulasback to summary
public void setDisplayFormulas(boolean formulas)

set whether the window should display formulas

Parameters
formulas:boolean

or not

setDisplayGridlinesback to summary
public void setDisplayGridlines(boolean gridlines)

set whether the window should display gridlines

Parameters
gridlines:boolean

or not

setDisplayGutsback to summary
public void setDisplayGuts(boolean guts)

set whether the outline symbols are displaed

Parameters
guts:boolean

symbols or not

setDisplayRowColHeadingsback to summary
public void setDisplayRowColHeadings(boolean headings)

set whether the window should display row and column headings

Parameters
headings:boolean

or not

setDisplayZerosback to summary
public void setDisplayZeros(boolean zeros)

set whether the window should display zero values

Parameters
zeros:boolean

or not

setFreezePanesback to summary
public void setFreezePanes(boolean freezepanes)

set whether the window should freeze panes

Parameters
freezepanes:boolean

freeze panes or not

setFreezePanesNoSplitback to summary
public void setFreezePanesNoSplit(boolean freeze)

freeze unsplit panes or not

Parameters
freeze:boolean

or not

setHeaderColorback to summary
public void setHeaderColor(int color)

set the palette index for the header color

Parameters
color:int

Which color to use for the header, see the specification for details

setLeftColback to summary
public void setLeftCol(short leftCol)

set the leftmost column displayed in the window

Parameters
leftCol:short

leftmost column

setNormalZoomback to summary
public void setNormalZoom(short zoom)

set the zoom magnification in normal view

Parameters
zoom:short

The zoom-level to use for the normal view

setOptionsback to summary
public void setOptions(short options)

set the options bitmask or just use the bit setters.

Parameters
options:short

Which options to set for this record

setPageBreakZoomback to summary
public void setPageBreakZoom(short zoom)

zoom magnification in page break view

Parameters
zoom:short

The zoom-level to use for the page-break view

setReservedback to summary
public void setReserved(int reserved)

set the reserved (don't do this) value

Parameters
reserved:int

reserved value usually does not need to be set

setSavedInPageBreakPreviewback to summary
public void setSavedInPageBreakPreview(boolean p)

was the sheet saved in page break view

Parameters
p:boolean

pagebreaksaved or not

setSelectedback to summary
public void setSelected(boolean sel)

sheet tab is selected

Parameters
sel:boolean

selected or not

setTopRowback to summary
public void setTopRow(short topRow)

set the top row visible in the window

Parameters
topRow:short

top row visible