Package org.apache.poi.hssf.record
Class WindowTwoRecord
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.WindowTwoRecord
Title: Window Two Record
Description: sheet window settings
REFERENCE: PG 422 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
- Version:
- 2.0-pre
- Author:
- Andrew C. Oliver (acoliver at apache dot org), Jason Height (jheight at chariot dot net dot au)
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
is this arabic?protected int
boolean
get whether the window should display a default headerboolean
get whether the window should display formulasboolean
get whether the window should display gridlinesboolean
get whether the outline symbols are displaedboolean
get whether the window should display row and column headingsboolean
get whether the window should display zero valuesboolean
get whether the window should freeze panesboolean
freeze unsplit panes or notint
get the palette index for the header colorshort
get the leftmost column displayed in the windowshort
get the zoom magnification in normal viewshort
get the options bitmask or just use the bit setters.short
zoom magification in page break viewint
get the reserved bits - why would you do this?boolean
was the sheet saved in page break viewboolean
sheet tab is selectedshort
getSid()
return the non static version of the id for this record.short
get the top row visible in the windowboolean
isActive()
is the sheet currently displayed in the windowvoid
Write the data content of this BIFF record.void
setActive
(boolean p) is the sheet currently displayed in the windowvoid
setArabic
(boolean isarabic) is this arabic?void
setDefaultHeader
(boolean header) set whether the window should display a default headervoid
setDisplayFormulas
(boolean formulas) set whether the window should display formulasvoid
setDisplayGridlines
(boolean gridlines) set whether the window should display gridlinesvoid
setDisplayGuts
(boolean guts) set whether the outline symbols are displaedvoid
setDisplayRowColHeadings
(boolean headings) set whether the window should display row and column headingsvoid
setDisplayZeros
(boolean zeros) set whether the window should display zero valuesvoid
setFreezePanes
(boolean freezepanes) set whether the window should freeze panesvoid
setFreezePanesNoSplit
(boolean freeze) freeze unsplit panes or notvoid
setHeaderColor
(int color) set the palette index for the header colorvoid
setLeftCol
(short leftCol) set the leftmost column displayed in the windowvoid
setNormalZoom
(short zoom) set the zoom magnification in normal viewvoid
setOptions
(short options) set the options bitmask or just use the bit setters.void
setPageBreakZoom
(short zoom) zoom magification in page break viewvoid
setReserved
(int reserved) set the reserved (don't do this) valuevoid
setSavedInPageBreakPreview
(boolean p) was the sheet saved in page break viewvoid
setSelected
(boolean sel) sheet tab is selectedvoid
setTopRow
(short topRow) set the top row visible in the windowtoString()
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
cloneViaReserialise, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
-
Constructor Details
-
WindowTwoRecord
public WindowTwoRecord() -
WindowTwoRecord
-
-
Method Details
-
setOptions
public void setOptions(short options) set the options bitmask or just use the bit setters.- Parameters:
options
-
-
setDisplayFormulas
public void setDisplayFormulas(boolean formulas) set whether the window should display formulas- Parameters:
formulas
- or not
-
setDisplayGridlines
public void setDisplayGridlines(boolean gridlines) set whether the window should display gridlines- Parameters:
gridlines
- or not
-
setDisplayRowColHeadings
public void setDisplayRowColHeadings(boolean headings) set whether the window should display row and column headings- Parameters:
headings
- or not
-
setFreezePanes
public void setFreezePanes(boolean freezepanes) set whether the window should freeze panes- Parameters:
freezepanes
- freeze panes or not
-
setDisplayZeros
public void setDisplayZeros(boolean zeros) set whether the window should display zero values- Parameters:
zeros
- or not
-
setDefaultHeader
public void setDefaultHeader(boolean header) set whether the window should display a default header- Parameters:
header
- or not
-
setArabic
public void setArabic(boolean isarabic) is this arabic?- Parameters:
isarabic
- arabic or not
-
setDisplayGuts
public void setDisplayGuts(boolean guts) set whether the outline symbols are displaed- Parameters:
guts
- symbols or not
-
setFreezePanesNoSplit
public void setFreezePanesNoSplit(boolean freeze) freeze unsplit panes or not- Parameters:
freeze
- or not
-
setSelected
public void setSelected(boolean sel) sheet tab is selected- Parameters:
sel
- selected or not
-
setActive
public void setActive(boolean p) is the sheet currently displayed in the window- Parameters:
p
- displayed or not
-
setSavedInPageBreakPreview
public void setSavedInPageBreakPreview(boolean p) was the sheet saved in page break view- Parameters:
p
- pagebreaksaved or not
-
setTopRow
public void setTopRow(short topRow) set the top row visible in the window- Parameters:
topRow
- top row visible
-
setLeftCol
public void setLeftCol(short leftCol) set the leftmost column displayed in the window- Parameters:
leftCol
- leftmost column
-
setHeaderColor
public void setHeaderColor(int color) set the palette index for the header color- Parameters:
color
-
-
setPageBreakZoom
public void setPageBreakZoom(short zoom) zoom magification in page break view- Parameters:
zoom
-
-
setNormalZoom
public void setNormalZoom(short zoom) set the zoom magnification in normal view- Parameters:
zoom
-
-
setReserved
public void setReserved(int reserved) set the reserved (don't do this) value -
getOptions
public short getOptions()get the options bitmask or just use the bit setters.- Returns:
- options
-
getDisplayFormulas
public boolean getDisplayFormulas()get whether the window should display formulas- Returns:
- formulas or not
-
getDisplayGridlines
public boolean getDisplayGridlines()get whether the window should display gridlines- Returns:
- gridlines or not
-
getDisplayRowColHeadings
public boolean getDisplayRowColHeadings()get whether the window should display row and column headings- Returns:
- headings or not
-
getFreezePanes
public boolean getFreezePanes()get whether the window should freeze panes- Returns:
- freeze panes or not
-
getDisplayZeros
public boolean getDisplayZeros()get whether the window should display zero values- Returns:
- zeros or not
-
getDefaultHeader
public boolean getDefaultHeader()get whether the window should display a default header- Returns:
- header or not
-
getArabic
public boolean getArabic()is this arabic?- Returns:
- arabic or not
-
getDisplayGuts
public boolean getDisplayGuts()get whether the outline symbols are displaed- Returns:
- symbols or not
-
getFreezePanesNoSplit
public boolean getFreezePanesNoSplit()freeze unsplit panes or not- Returns:
- freeze or not
-
getSelected
public boolean getSelected()sheet tab is selected- Returns:
- selected or not
-
isActive
public boolean isActive()is the sheet currently displayed in the window- Returns:
- displayed or not
-
getSavedInPageBreakPreview
public boolean getSavedInPageBreakPreview()was the sheet saved in page break view- Returns:
- pagebreaksaved or not
-
getTopRow
public short getTopRow()get the top row visible in the window- Returns:
- toprow
-
getLeftCol
public short getLeftCol()get the leftmost column displayed in the window- Returns:
- leftmost
-
getHeaderColor
public int getHeaderColor()get the palette index for the header color- Returns:
- color
-
getPageBreakZoom
public short getPageBreakZoom()zoom magification in page break view- Returns:
- zoom
-
getNormalZoom
public short getNormalZoom()get the zoom magnification in normal view- Returns:
- zoom
-
getReserved
public int getReserved()get the reserved bits - why would you do this?- Returns:
- reserved stuff -probably garbage
-
toString
Description copied from class:Record
get a string representation of the record (for biffview/debugging) -
serialize
Description copied from class:StandardRecord
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
RecordBase.getRecordSize()
} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).- Specified by:
serialize
in classStandardRecord
- Parameters:
out
- the output object
-
getDataSize
protected int getDataSize()- Specified by:
getDataSize
in classStandardRecord
-
getSid
public short getSid()Description copied from class:Record
return the non static version of the id for this record. -
clone
-