Package org.apache.poi.hssf.record
Class WindowOneRecord
- 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.WindowOneRecord
-
public final class WindowOneRecord extends StandardRecord
Title: Window1 RecordDescription: 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)
-
-
Field Summary
Fields Modifier and Type Field Description static short
sid
-
Constructor Summary
Constructors Constructor Description WindowOneRecord()
WindowOneRecord(RecordInputStream in)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getActiveSheetIndex()
boolean
getDisplayHorizontalScrollbar()
get whether to display the horizontal scrollbar or notboolean
getDisplayTabs()
get whether to display the tabs or notboolean
getDisplayVerticalScrollbar()
get whether to display the vertical scrollbar or notint
getFirstVisibleTab()
short
getHeight()
get the height of the windowboolean
getHidden()
get whether the window is hidden or notshort
getHorizontalHold()
get the horizontal position of the window (in 1/20ths of a point)boolean
getIconic()
get whether the window has been iconized or notshort
getNumSelectedTabs()
get the number of selected tabsshort
getOptions()
get the options bitmask (see bit setters)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 scrollbarshort
getVerticalHold()
get the vertical position of the window (in 1/20ths of a point)short
getWidth()
get the width of the windowvoid
serialize(LittleEndianOutput out)
void
setActiveSheetIndex(int index)
void
setDisplayHorizonalScrollbar(boolean scroll)
set whether to display the horizontal scrollbar or notvoid
setDisplayTabs(boolean disptabs)
set whether to display the tabs or notvoid
setDisplayVerticalScrollbar(boolean scroll)
set whether to display the vertical scrollbar or notvoid
setFirstVisibleTab(int t)
Sets the first visible sheet in the worksheet tab-bar.void
setHeight(short h)
set teh height of the windowvoid
setHidden(boolean ishidden)
set whether the window is hidden or notvoid
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 notvoid
setNumSelectedTabs(short n)
set the number of selected tabsvoid
setOptions(short o)
set the options bitmask (see bit setters)void
setTabWidthRatio(short r)
ratio of the width of the tabs to the horizontal scrollbarvoid
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 windowString
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
clone, cloneViaReserialise, serialize
-
-
-
-
Field Detail
-
sid
public static final short sid
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
WindowOneRecord
public WindowOneRecord()
-
WindowOneRecord
public WindowOneRecord(RecordInputStream in)
-
-
Method Detail
-
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)
-
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
-
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
-
getFirstVisibleTab
public int getFirstVisibleTab()
- Returns:
- the first visible sheet in the worksheet tab-bar. I.E. the scroll position of the tab-bar.
-
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 String toString()
Description copied from class:Record
get a string representation of the record (for biffview/debugging)
-
serialize
public void serialize(LittleEndianOutput out)
-
-