io.starter.formats.XLS

Class Pane

java.lang.Object

io.starter.formats.XLS.XLSRecord

io.starter.formats.XLS.Pane

All Implemented Interfaces:

BlockByteConsumer, BiffRec, XLSConstants, Serializable

public final class Pane
extends XLSRecord

Pane: Stores the position of window panes. (41h)
If the sheet doesn't contain any splits, this record will not occur A sheet can be split in two different ways, with unfrozen or frozen panes. A flag in the WINDOW2 record specifies if the panes are frozen.

    offset  size name           contents
    ---
                0       2       px                      Position of the vertical split (px, 0 = No vertical split):
                                                        Unfrozen pane: Width of the left pane(s) (in twips = 1/20 of a point)
                                                        Frozen pane: Number of visible columns in left pane(s)
                2       2       py                      Position of the horizontal split (py, 0 = No horizontal split):
                                                        Unfrozen pane: Height of the top pane(s) (in twips = 1/20 of a point)
                                                        Frozen pane: Number of visible rows in top pane(s)
                4       2       visRow          Index to first visible row in bottom pane(s)
                6       2       visCol          Index to first visible column in right pane(s)
                8       1       pActive         Identifier of pane with active cell cursor (see below)
                [9] 1                           Not used (BIFF5-BIFF8 only, not written in BIFF2-BIFF4)
                
                If the panes are frozen, pane 0 is always active, regardless of the cursor position. The correct identifiers for all possible
                combinations of visible panes are shown in the following pictures.
                        px = 0, py = 0          px = 0, py > 0          px > 0, py = 0          px > 0, py > 0 
                                        3                               3                                       3 1                                     3 1
                                                                        2                                                                               2 0
 
    

See Also:

Serialized Form

Field Summary

Fields inherited from class io.starter.formats.XLS.XLSRecord

col, continues, DEBUGLEVEL, hyperlink, idx, isBlank, isBoolean, isContinueMerged, isString, lastidx, myxf, offset, rw, streamer, wkbook, worksheet

Fields inherited from interface io.starter.formats.XLS.XLSConstants

AI, ALLOWDUPES, ALRUNS, AREA, AREAFORMAT, ARRAY, ATTACHEDLABEL, AUTOFILTER, AXCENT, AXESUSED, AXIS, AXISLINEFORMAT, AXISPARENT, BACKUP, BAR, BEGIN, BLANK, BOF, BOOKBOOL, BOOLERR, BOPPOP, BOPPOPCUSTOM, BOTTOM_MARGIN, BOTTOMMARGIN, BOUNDSHEET, CALC_MODE_PROP, CALCCOUNT, CALCMODE, CALCULATE_ALWAYS, CALCULATE_AUTO, CALCULATE_EXPLICIT, CATLAB, CATSERRANGE, CF, CF12, CHART, CHART3DBARSHAPE, CHARTFORMAT, CHARTFORMATLINK, CHARTFRTINFO, CHARTLINE, CODENAME, COLINFO, CONDFMT, CONDFMT12, CONTINUE, COUNTRY, CRN, CRTLAYOUT12, CRTLAYOUT12A, DAT, DATAFORMAT, DATALABEXT, DATALABEXTCONTENTS, DATE1904, DBCELL, DCON, DCONBIN, DCONNAME, DCONREF, DEBUG_HIGH, DEBUG_LOW, DEBUG_MEDIUM, DEFAULTENCODING, DEFAULTROWHEIGHT, DEFAULTTEXT, DEFCOLWIDTH, DELTA, DIMENSIONS, DROPBAR, DSF, DV, DVAL, END, ENDBLOCK, ENDEXTSST, ENDOBJECT, EOF, EXCEL2K, EXTERNCOUNT, EXTERNNAME, EXTERNSHEET, EXTSST, FBI, FEATHEADR, FILE_LOCK, FILEPASS, FONT, FONTBASIS, FONTX, FOOTERREC, FORMAT, FORMULA, FRAME, FRTFONTLIST, FRTWRAPPER, GARBAGE, GELFRAME, GUTS, HCENTER, HEADERREC, HLINK, HORIZONTAL_PAGE_BREAKS, IFMT, INDEX, INTERFACE_HDR, ITERATION, LABEL, LABELSST, LEFT_MARGIN, LEFTMARGIN, LEGEND, LEGENDXN, LINE, LINEFORMAT, MARKERFORMAT, MAXCOLS, MAXCOLS_BIFF8, MAXRECLEN, MAXROWS, MAXROWS_BIFF8, MERGEDCELLS, MSODRAWING, MSODRAWINGGROUP, MSODRAWINGSELECTION, MULBLANK, MULRK, NAME, NOTE, NUMBER, OBJ, OBJECTLINK, OBJPROTECT, OBPROJ, PALETTE, PANE, PASSWORD, PHONETIC, PICF, PIE, PIEFORMAT, PIVOTCHARTBITS, PIVOTCHARTLINK, PLOTAREA, PLOTGROWTH, PLS, PLV, POS, PRECISION, PRINT_GRIDLINES, PRINT_ROW_HEADERS, PRINTGRID, PRINTROWCOL, PROT4REV, PROTECT, QSISXTAG, RADAR, RADARAREA, RANGEPROTECTION, REFMODE, REFTRACK_PROP, RIGHT_MARGIN, RIGHTMARGIN, RK, ROW, RRD_HEAD, RRD_INFO, RSTRING, RTENTEXU, RTMERGECELLS, SBASEREF, SCATTER, SCENPROTECT, SCL, SELECTION, SERAUXERRBAR, SERAUXTREND, SERFMT, SERIES, SERIESLIST, SERIESTEXT, SERPARENT, SERTOCRT, SETUP, SHAREDUPES, SHEETLAYOUT, SHEETPROTECTION, SHRFMLA, SHTPROPS, SIIINDEX, SST, STARTBLOCK, STARTOBJECT, STRING_ENCODING_AUTO, STRING_ENCODING_COMPRESSED, STRING_ENCODING_UNICODE, STRINGREC, STYLE, SUPBOOK, SURFACE, SXADDL, SXBOOL, SXDB, SXDBB, SXDBEX, SXDI, SXEX, SXFDB, SXFDBTYPE, SXFORMAT, SXIVD, SXLI, SXNUM, SXPI, SXSTREAMID, SXSTRING, SXVD, SXVDEX, SXVI, SXVIEW, SXVIEWEX9, SXVIEWLINK, SXVS, TABID, TABLE, TABLESTYLES, TEXTDISP, THREED, TICK, TOP_MARGIN, TOPMARGIN, TXO, TYPE_BLANK, TYPE_BOOLEAN, TYPE_DOUBLE, TYPE_FORMULA, TYPE_FP, TYPE_INT, TYPE_STRING, UNICODEENCODING, UNITS, USERBVIEW, USERSVIEWBEGIN, USERSVIEWEND, USETEMPFILE_PROP, USR_EXCL, VALIDATEWORKBOOK, VALUERANGE, VB_MODULE, VCENTER, VERTICAL_PAGE_BREAKS, WINDOW_PROTECT, WINDOW1, WINDOW2, WK_CHART, WK_FILE, WK_GLOBALS, WK_MACROSHEET, WK_WORKSHEET, WSBOOL, XCT, XF, XLS_MAX_COLS, YMULT

Constructor Summary

Constructors

Constructor and Description
Pane()

Method Summary

Modifier and Type	Method and Description
static XLSRecord	getPrototype()
int	getRowSplitLoc() Returns the position of the row split in twips
String	getTopLeftCell() return the address of the TopLeft visible Cell
int	getVisibleCol() gets the first visible col of the split pane this is 0 based
int	getVisibleRow() Gets the first visible row of the split pane this is 0 based
void	init() perform record initialization
void	setFrozenColumn(int col) sets split columm + freezes panes
void	setFrozenRow(int row) sets the split row + freezes pane
void	setSplitColumn(int col, int nCols) sets the 1st visible column height in twips + sets frozen panes off
void	setSplitRow(int row, int rsz) sets the first visible row + width in twips + sets frozen panes off
void	setWindow2(Window2 win2)
protected void	updateData()

Methods inherited from class io.starter.formats.XLS.XLSRecord

addContinue, clone, close, copyFormat, getBooleanVal, getByteAt, getByteReader, getBytes, getBytesAt, getCellAddress, getCellAddressWithSheet, getCellType, getColNumber, getColorTable, getContinueVect, getData, getDataType, getDblVal, getDefaultVal, getEncryptedByteReader, getFirstBlock, getFloatVal, getFont, getFormatPattern, getFormulaRec, getHyperlink, getInternalVal, getIntLocation, getIntVal, getIxfe, getLastBlock, getLength, getMergeRange, getOffset, getOpcode, getRealRecordIndex, getRecDesc, getRecordIndex, getRow, getRowNumber, getSheet, getStreamer, getStringVal, getStringVal, getWorkBook, getXfRec, hasContinues, initRowCol, isFormula, isNumber, isReadOnly, isValueForCell, mergeContinues, postStream, preStream, remove, removeContinues, resetCacheBytes, setBooleanVal, setByteReader, setCol, setData, setDebugLevel, setDoubleVal, setEncryptedByteReader, setFirstBlock, setFloatVal, setHyperlink, setIndex, setIntVal, setIsValueForCell, setIxfe, setLastBlock, setLength, setMergeRange, setOffset, setOpcode, setRow, setRowCol, setRowNumber, setSheet, setStreamer, setStringVal, setValueForCell, setWorkBook, setXFRecord, setXFRecord, shouldEncrypt, toHexDump, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Pane

public Pane()

Method Detail

init

public void init()

Description copied from class: XLSRecord

perform record initialization

Specified by:

init in interface BiffRec

Overrides:

init in class XLSRecord

getPrototype

public static XLSRecord getPrototype()

setSplitColumn

public void setSplitColumn(int col,
                           int nCols)

sets the 1st visible column height in twips + sets frozen panes off

Parameters:

col -

nCols -

setFrozenColumn

public void setFrozenColumn(int col)

sets split columm + freezes panes

Parameters:

col -

setSplitRow

public void setSplitRow(int row,
                        int rsz)

sets the first visible row + width in twips + sets frozen panes off

Parameters:

row - to start split

rsz - row height in twips

getVisibleRow

public int getVisibleRow()

Gets the first visible row of the split pane this is 0 based

Returns:

getVisibleCol

public int getVisibleCol()

gets the first visible col of the split pane this is 0 based

Returns:

int 0-based first visible column of the split

getRowSplitLoc

public int getRowSplitLoc()

Returns the position of the row split in twips

setFrozenRow

public void setFrozenRow(int row)

sets the split row + freezes pane

Parameters:

row -

getTopLeftCell

public String getTopLeftCell()

return the address of the TopLeft visible Cell

Returns:

updateData

protected void updateData()

setWindow2

public void setWindow2(Window2 win2)