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

public final Class WindowOneRecord

extends StandardRecord
Class Inheritance
Static Imports
org.apache.poi.util.GenericRecordUtil.getBitsAsString
Stores the attributes of the workbook window. This is basically so the gui knows how big to make the window holding the spreadsheet document.
Version
2.0-pre

Field Summary

Modifier and TypeField and Description
private short
field_1_h_hold

private short
field_2_v_hold

private short
field_3_width

private short
field_4_height

private short
field_5_options

private int
field_6_active_sheet

private int
field_7_first_visible_tab

private short
field_8_num_selected_tabs

private short
field_9_tab_width_ratio

private static final BitField
hidden

private static final BitField
hscroll

private static final BitField
iconic

private static final BitField
reserved

public static final short
sid

private static final BitField
tabs

private static final BitField
vscroll

Constructor Summary

AccessConstructor and Description
public
WindowOneRecord()

public
WindowOneRecord(WindowOneRecord other)

public
WindowOneRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public WindowOneRecord
copy()

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

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

public int

Returns:

the index of the currently displayed sheet
getActiveSheetIndex()

protected int
getDataSize()

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

public boolean

Returns:

display or not
getDisplayHorizontalScrollbar()

get whether to display the horizontal scrollbar or not

public boolean

Returns:

display or not
getDisplayTabs()

get whether to display the tabs or not

public boolean

Returns:

display or not
getDisplayVerticalScrollbar()

get whether to display the vertical scrollbar or not

public int

Returns:

the first visible sheet in the worksheet tab-bar. I.E. the scroll position of the tab-bar.
getFirstVisibleTab()

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 short

Returns:

height
getHeight()

get the height of the window

public boolean

Returns:

ishidden or not
getHidden()

get whether the window is hidden or not

public short

Returns:

h - horizontal location
getHorizontalHold()

get the horizontal position of the window (in 1/20ths of a point)

public boolean

Returns:

iconize or not
getIconic()

get whether the window has been iconized or not

public short

Returns:

number of tabs
getNumSelectedTabs()

get the number of selected tabs

public short

Returns:

o - the bitmask
getOptions()

get the options bitmask (see bit setters)

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:

ratio
getTabWidthRatio()

ratio of the width of the tabs to the horizontal scrollbar

public short

Returns:

v - vertical location
getVerticalHold()

get the vertical position of the window (in 1/20ths of a point)

public short

Returns:

width
getWidth()

get the width of 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
setActiveSheetIndex(int index)

public void
setDisplayHorizonalScrollbar(boolean
display or not
scroll)

set whether to display the horizontal scrollbar or not

public void
setDisplayTabs(boolean
display or not
disptabs)

set whether to display the tabs or not

public void
setDisplayVerticalScrollbar(boolean
display or not
scroll)

set whether to display the vertical scrollbar or not

public void
setFirstVisibleTab(int
the sheet index of the tab that will become the first in the tab-bar
t)

Sets the first visible sheet in the worksheet tab-bar.

public void
setHeight(short
height
h)

set teh height of the window

public void
setHidden(boolean
or not
ishidden)

set whether the window is hidden or not

public void
setHorizontalHold(short
- horizontal location
h)

set the horizontal position of the window (in 1/20ths of a point)

public void
setIconic(boolean
iconize or not
isiconic)

set whether the window has been iconized or not

public void
setNumSelectedTabs(short
number of tabs
n)

set the number of selected tabs

public void
setOptions(short
- the bitmask
o)

set the options bitmask (see bit setters)

public void
setTabWidthRatio(short
ratio
r)

ratio of the width of the tabs to the horizontal scrollbar

public void
setVerticalHold(short
- vertical location
v)

set the vertical position of the window (in 1/20ths of a point)

public void
setWidth(short
width
w)

set the width of the window

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

Field Detail

field_1_h_holdback to summary
private short field_1_h_hold
field_2_v_holdback to summary
private short field_2_v_hold
field_3_widthback to summary
private short field_3_width
field_4_heightback to summary
private short field_4_height
field_5_optionsback to summary
private short field_5_options
field_6_active_sheetback to summary
private int field_6_active_sheet
field_7_first_visible_tabback to summary
private int field_7_first_visible_tab
field_8_num_selected_tabsback to summary
private short field_8_num_selected_tabs
field_9_tab_width_ratioback to summary
private short field_9_tab_width_ratio
hiddenback to summary
private static final BitField hidden
hscrollback to summary
private static final BitField hscroll
iconicback to summary
private static final BitField iconic
reservedback to summary
private static final BitField reserved
Annotations
@SuppressWarnings:unused
sidback to summary
public static final short sid
tabsback to summary
private static final BitField tabs
vscrollback to summary
private static final BitField vscroll

Constructor Detail

WindowOneRecordback to summary
public WindowOneRecord()
WindowOneRecordback to summary
public WindowOneRecord(WindowOneRecord other)
WindowOneRecordback to summary
public WindowOneRecord(RecordInputStream in)

Method Detail

copyback to summary
public WindowOneRecord copy()

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

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

Returns:WindowOneRecord

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

a deep copy of the implementing class / instance

Annotations
@Override
getActiveSheetIndexback to summary
public int getActiveSheetIndex()
Returns:int

the index of the currently displayed sheet

getDataSizeback to summary
protected int getDataSize()

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

getDisplayHorizontalScrollbarback to summary
public boolean getDisplayHorizontalScrollbar()

get whether to display the horizontal scrollbar or not

Returns:boolean

display or not

getDisplayTabsback to summary
public boolean getDisplayTabs()

get whether to display the tabs or not

Returns:boolean

display or not

getDisplayVerticalScrollbarback to summary
public boolean getDisplayVerticalScrollbar()

get whether to display the vertical scrollbar or not

Returns:boolean

display or not

getFirstVisibleTabback to summary
public int getFirstVisibleTab()
Returns:int

the first visible sheet in the worksheet tab-bar. I.E. the scroll position of the tab-bar.

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
getHeightback to summary
public short getHeight()

get the height of the window

Returns:short

height

getHiddenback to summary
public boolean getHidden()

get whether the window is hidden or not

Returns:boolean

ishidden or not

getHorizontalHoldback to summary
public short getHorizontalHold()

get the horizontal position of the window (in 1/20ths of a point)

Returns:short

h - horizontal location

getIconicback to summary
public boolean getIconic()

get whether the window has been iconized or not

Returns:boolean

iconize or not

getNumSelectedTabsback to summary
public short getNumSelectedTabs()

get the number of selected tabs

Returns:short

number of tabs

getOptionsback to summary
public short getOptions()

get the options bitmask (see bit setters)

Returns:short

o - the bitmask

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

getTabWidthRatioback to summary
public short getTabWidthRatio()

ratio of the width of the tabs to the horizontal scrollbar

Returns:short

ratio

getVerticalHoldback to summary
public short getVerticalHold()

get the vertical position of the window (in 1/20ths of a point)

Returns:short

v - vertical location

getWidthback to summary
public short getWidth()

get the width of the window

Returns:short

width

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

setActiveSheetIndexback to summary
public void setActiveSheetIndex(int index)
setDisplayHorizonalScrollbarback to summary
public void setDisplayHorizonalScrollbar(boolean scroll)

set whether to display the horizontal scrollbar or not

Parameters
scroll:boolean

display or not

setDisplayTabsback to summary
public void setDisplayTabs(boolean disptabs)

set whether to display the tabs or not

Parameters
disptabs:boolean

display or not

setDisplayVerticalScrollbarback to summary
public void setDisplayVerticalScrollbar(boolean scroll)

set whether to display the vertical scrollbar or not

Parameters
scroll:boolean

display or not

setFirstVisibleTabback to summary
public void setFirstVisibleTab(int t)

Sets the first visible sheet in the worksheet tab-bar. This method does not hide, select or focus sheets. It just sets the scroll position in the tab-bar.

Parameters
t:int

the sheet index of the tab that will become the first in the tab-bar

setHeightback to summary
public void setHeight(short h)

set teh height of the window

Parameters
h:short

height

setHiddenback to summary
public void setHidden(boolean ishidden)

set whether the window is hidden or not

Parameters
ishidden:boolean

or not

setHorizontalHoldback to summary
public void setHorizontalHold(short h)

set the horizontal position of the window (in 1/20ths of a point)

Parameters
h:short

- horizontal location

setIconicback to summary
public void setIconic(boolean isiconic)

set whether the window has been iconized or not

Parameters
isiconic:boolean

iconize or not

setNumSelectedTabsback to summary
public void setNumSelectedTabs(short n)

set the number of selected tabs

Parameters
n:short

number of tabs

setOptionsback to summary
public void setOptions(short o)

set the options bitmask (see bit setters)

Parameters
o:short

- the bitmask

setTabWidthRatioback to summary
public void setTabWidthRatio(short r)

ratio of the width of the tabs to the horizontal scrollbar

Parameters
r:short

ratio

setVerticalHoldback to summary
public void setVerticalHold(short v)

set the vertical position of the window (in 1/20ths of a point)

Parameters
v:short

- vertical location

setWidthback to summary
public void setWidth(short w)

set the width of the window

Parameters
w:short

width