Package loci.poi.hssf.record
Class WindowOneRecord
- java.lang.Object
-
- loci.poi.hssf.record.Record
-
- loci.poi.hssf.record.WindowOneRecord
-
public class WindowOneRecord extends Record
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)
- Version:
- 2.0-pre
- Author:
- Andrew C. Oliver (acoliver at apache dot org)
-
-
Field Summary
Fields Modifier and Type Field Description static short
sid
-
Constructor Summary
Constructors Constructor Description WindowOneRecord()
WindowOneRecord(RecordInputStream in)
Constructs a WindowOne record and sets its fields appropriately.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
fillFields(RecordInputStream in)
called by the constructor, should set class level fields.short
getDisplayedTab()
get the displayed tab numberboolean
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 notshort
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)int
getRecordSize()
gives the current serialized size of the record.short
getSelectedTab()
get the selected tab numbershort
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 windowint
serialize(int offset, byte[] data)
called by the class that is responsible for writing this sucker.void
setDisplayedTab(short t)
set the displayed tab numbervoid
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
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
setSelectedTab(short s)
set the selected tab numbervoid
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)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 loci.poi.hssf.record.Record
clone, isInValueSection, isValue, serialize
-
-
-
-
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 classRecord
- 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 classRecord
- 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
-
setSelectedTab
public void setSelectedTab(short s)
set the selected tab number- Parameters:
s
- tab number
-
setDisplayedTab
public void setDisplayedTab(short t)
set the displayed tab number- Parameters:
t
- tab number
-
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
-
getSelectedTab
public short getSelectedTab()
get the selected tab number- Returns:
- Tab number
-
getDisplayedTab
public short getDisplayedTab()
get the displayed tab number- Returns:
- Tab number
-
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 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.
-
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 classRecord
-
-