org.apache.poi.hssf.record
Class WindowOneRecord

java.lang.Object
  org.apache.poi.hssf.record.Record
      org.apache.poi.hssf.record.WindowOneRecord

public class WindowOneRecord
extends Record

Title: Window1 Record

Description: Stores the attributes of the workbook window. This is basically so the gui knows how big to make the window holding the spreadsheet document.

REFERENCE: PG 421 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

Version:

2.0-pre

Author:

Andrew C. Oliver (acoliver at apache dot org)

Field Summary

static short

sid

Constructor Summary

WindowOneRecord()

WindowOneRecord(RecordInputStream in)
Constructs a WindowOne record and sets its fields appropriately.

Method Summary

protected void	fillFields(RecordInputStream in) called by the constructor, should set class level fields.
int	getActiveSheetIndex()
short	getDisplayedTab() Deprecated. - Misleading name - use getFirstVisibleTab()
boolean	getDisplayHorizontalScrollbar() get whether to display the horizontal scrollbar or not
boolean	getDisplayTabs() get whether to display the tabs or not
boolean	getDisplayVerticalScrollbar() get whether to display the vertical scrollbar or not
int	getFirstVisibleTab()
short	getHeight() get the height of the window
boolean	getHidden() get whether the window is hidden or not
short	getHorizontalHold() get the horizontal position of the window (in 1/20ths of a point)
boolean	getIconic() get whether the window has been iconized or not
short	getNumSelectedTabs() get the number of selected tabs
short	getOptions() get the options bitmask (see bit setters)
int	getRecordSize() gives the current serialized size of the record.
short	getSelectedTab() Deprecated. - Misleading name - use getActiveSheetIndex()
short	getSid() return the non static version of the id for this record.
short	getTabWidthRatio() ratio of the width of the tabs to the horizontal scrollbar
short	getVerticalHold() get the vertical position of the window (in 1/20ths of a point)
short	getWidth() get the width of the window
int	serialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.
void	setActiveSheetIndex(int index)
void	setDisplayedTab(short t) Deprecated. - Misleading name - use setFirstVisibleTab()
void	setDisplayHorizonalScrollbar(boolean scroll) set whether to display the horizontal scrollbar or not
void	setDisplayTabs(boolean disptabs) set whether to display the tabs or not
void	setDisplayVerticalScrollbar(boolean scroll) set whether to display the vertical scrollbar or not
void	setFirstVisibleTab(int t) Sets the first visible sheet in the worksheet tab-bar.
void	setHeight(short h) set teh height of the window
void	setHidden(boolean ishidden) set whether the window is hidden or not
void	setHorizontalHold(short h) set the horizontal position of the window (in 1/20ths of a point)
void	setIconic(boolean isiconic) set whether the window has been iconized or not
void	setNumSelectedTabs(short n) set the number of selected tabs
void	setOptions(short o) set the options bitmask (see bit setters)
void	setSelectedTab(short s) Deprecated. - Misleading name - use setActiveSheetIndex()
void	setTabWidthRatio(short r) ratio of the width of the tabs to the horizontal scrollbar
void	setVerticalHold(short v) set the vertical position of the window (in 1/20ths of a point)
void	setWidth(short w) set the width of the window
java.lang.String	toString() get a string representation of the record (for biffview/debugging)
protected void	validateSid(short id) called by constructor, should throw runtime exception in the event of a record passed with a differing ID.

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

clone, cloneViaReserialise, isInValueSection, isValue, 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

WindowOneRecord

public WindowOneRecord()

WindowOneRecord

public WindowOneRecord(RecordInputStream in)

Constructs a WindowOne record and sets its fields appropriately.

Parameters:

in - the RecordInputstream to read the record from

Method Detail

validateSid

protected void validateSid(short id)

Description copied from class: Record

called by constructor, should throw runtime exception in the event of a record passed with a differing ID.

Specified by:

validateSid in class Record

Parameters:

id - alleged id for this record

fillFields

protected void fillFields(RecordInputStream in)

Description copied from class: Record

called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.

Specified by:

fillFields in class Record

Parameters:

in - the RecordInputstream to read the record from

setHorizontalHold

public void setHorizontalHold(short h)

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

Parameters:

h - - horizontal location

setVerticalHold

public void setVerticalHold(short v)

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

Parameters:

v - - vertical location

setWidth

public void setWidth(short w)

set the width of the window

Parameters:

w - width

setHeight

public void setHeight(short h)

set teh height of the window

Parameters:

h - height

setOptions

public void setOptions(short o)

set the options bitmask (see bit setters)

Parameters:

o - - the bitmask

setHidden

public void setHidden(boolean ishidden)

set whether the window is hidden or not

Parameters:

ishidden - or not

setIconic

public void setIconic(boolean isiconic)

set whether the window has been iconized or not

Parameters:

isiconic - iconize or not

setDisplayHorizonalScrollbar

public void setDisplayHorizonalScrollbar(boolean scroll)

set whether to display the horizontal scrollbar or not

Parameters:

scroll - display or not

setDisplayVerticalScrollbar

public void setDisplayVerticalScrollbar(boolean scroll)

set whether to display the vertical scrollbar or not

Parameters:

scroll - display or not

setDisplayTabs

public void setDisplayTabs(boolean disptabs)

set whether to display the tabs or not

Parameters:

disptabs - display or not

setActiveSheetIndex

public void setActiveSheetIndex(int index)

setSelectedTab

public void setSelectedTab(short s)

Deprecated. - Misleading name - use setActiveSheetIndex()

deprecated May 2008

setFirstVisibleTab

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 - the sheet index of the tab that will become the first in the tab-bar

setDisplayedTab

public void setDisplayedTab(short t)

Deprecated. - Misleading name - use setFirstVisibleTab()

deprecated May 2008

setNumSelectedTabs

public void setNumSelectedTabs(short n)

set the number of selected tabs

Parameters:

n - number of tabs

setTabWidthRatio

public void setTabWidthRatio(short r)

ratio of the width of the tabs to the horizontal scrollbar

Parameters:

r - ratio

getHorizontalHold

public short getHorizontalHold()

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

Returns:

h - horizontal location

getVerticalHold

public short getVerticalHold()

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

Returns:

v - vertical location

getWidth

public short getWidth()

get the width of the window

Returns:

width

getHeight

public short getHeight()

get the height of the window

Returns:

height

getOptions

public short getOptions()

get the options bitmask (see bit setters)

Returns:

o - the bitmask

getHidden

public boolean getHidden()

get whether the window is hidden or not

Returns:

ishidden or not

getIconic

public boolean getIconic()

get whether the window has been iconized or not

Returns:

iconize or not

getDisplayHorizontalScrollbar

public boolean getDisplayHorizontalScrollbar()

get whether to display the horizontal scrollbar or not

Returns:

display or not

getDisplayVerticalScrollbar

public boolean getDisplayVerticalScrollbar()

get whether to display the vertical scrollbar or not

Returns:

display or not

getDisplayTabs

public boolean getDisplayTabs()

get whether to display the tabs or not

Returns:

display or not

getActiveSheetIndex

public int getActiveSheetIndex()

Returns:

the index of the currently displayed sheet

getSelectedTab

public short getSelectedTab()

Deprecated. - Misleading name - use getActiveSheetIndex()

deprecated May 2008

getFirstVisibleTab

public int getFirstVisibleTab()

Returns:

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

getDisplayedTab

public short getDisplayedTab()

Deprecated. - Misleading name - use getFirstVisibleTab()

deprecated May 2008

getNumSelectedTabs

public short getNumSelectedTabs()

get the number of selected tabs

Returns:

number of tabs

getTabWidthRatio

public short getTabWidthRatio()

ratio of the width of the tabs to the horizontal scrollbar

Returns:

ratio

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 int serialize(int offset,
                     byte[] data)

Description copied from class: Record

called by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array.

Specified by:

serialize in class Record

Parameters:

offset - to begin writing at

data - byte array containing instance data

Returns:

number of bytes written

getRecordSize

public int getRecordSize()

Description copied from class: Record

gives the current serialized size of the record. Should include the sid and reclength (4 bytes).

Overrides:

getRecordSize in class Record

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