io.starter.formats.XLS

Class Sxview

java.lang.Object

io.starter.formats.XLS.XLSRecord

io.starter.formats.XLS.Sxview

All Implemented Interfaces:

BlockByteConsumer, BiffRec, XLSConstants, Serializable

public class Sxview
extends XLSRecord
implements XLSConstants

SXVIEW B0h: This record contains top-level pivot table information.

    ref (8 bytes): A Ref8U structure that specifies the PivotTable report body. For more information, see Location and Body.
    rwFirstHead (2 bytes): An RwU structure that specifies the first row of the row area. 
                        MUST be 1 if none of the axes are assigned in this PivotTable view. 
                        Otherwise, the value MUST be greater than or equal to ref.rwFirst.

    rwFirstData (2 bytes): An RwU structure that specifies the first row of the data area. 
                        MUST be 1 if none of the axes are assigned in this PivotTable view. 
                        Otherwise, it MUST be equal to the value as specified by the following formula:

    rwFirstData = rwFirstHead + cDimCol

    colFirstData (2 bytes): A ColU structure that specifies the first column of the data area. 
                        It MUST be 1 if none of the axes are assigned in this PivotTable view. 
                        Otherwise, the value MUST be greater than or equal to ref.colFirst, and if the value of cDimCol or cDimData is not zero, 
                        it MUST be less than or equal to ref.colLast.

    iCache (2 bytes): A signed integer that specifies the zero-based index of an SXStreamID record in the Globals substream. 
                MUST be greater than or equal to zero and less than the number of SXStreamID records in the Globals substream.

    reserved (2 bytes): MUST be zero, and MUST be ignored.

    sxaxis4Data (2 bytes): An SXAxis structure that specifies the default axis for the data field. 
                Either the sxaxis4Data.sxaxisRw field MUST be 1 or the sxaxis4Data.sxaxisCol field MUST be 1. 
                The sxaxis4Data.sxaxisPage field MUST be 0 and the sxaxis4Data.sxaxisData field MUST be 0.

    ipos4Data (2 bytes): A signed integer that specifies the row or column position for the data field in the PivotTable view. 
                The sxaxis4Data field specifies whether this is a row or column position. 
                MUST be greater than or equal to -1 and less than or equal to 0x7FFF. A value of -1 specifies the default position.

    cDim (2 bytes): A signed integer that specifies the number of pivot fields in the PivotTable view. 
                MUST equal the number of Sxvd records following this record. 
                MUST equal the number of fields in the associated PivotCache specified by iCache.

    cDimRw (2 bytes): An unsigned integer that specifies the number of fields on the row axis of the PivotTable view. 
                MUST be less than or equal to 0x7FFF. MUST equal the number of array elements in the SxIvd record in this PivotTable view that contain row items.

    cDimCol (2 bytes): An unsigned integer that specifies the number of fields on the column axis of the PivotTable view. 
                MUST be less than or equal to 0x7FFF. 
                MUST equal the number of array elements in the SxIvd record in this PivotTable view that contain column items.

    cDimPg (2 bytes): An unsigned integer that specifies the number of page fields in the PivotTable view. 
                MUST be less than or equal to 0x7FFF. 
                MUST equal the number of array elements in the SXPI record in this PivotTable view.

    cDimData (2 bytes): A signed integer that specifies the number of data fields in the PivotTable view. 
                MUST be greater than or equal to zero and less than or equal to 0x7FFF. 
                MUST equal the number of SXDI records in this PivotTable view.

    cRw (2 bytes): An unsigned integer that specifies the number of pivot lines in the row area of the PivotTable view. 
                MUST be less than or equal to 0x7FFF. 
                MUST equal the number of array elements in the first SXLI record in this PivotTable view.

    cCol (2 bytes): An unsigned integer that specifies the number of pivot lines in the column area of the PivotTable view. 
                MUST equal the number of array elements in the second SXLI record in this PivotTable view.

    A - fRwGrand (1 bit): A bit that specifies whether the PivotTable contains grand totals for rows. 
                MUST be 0 if none of the axes have been assigned in this PivotTable view.

    B - fColGrand (1 bit): A bit that specifies whether the PivotTable contains grand totals for columns. 
                MUST be 1 if none of the axes are assigned in this PivotTable view.

    C - unused1 (1 bit): Undefined and MUST be ignored.

    D - fAutoFormat (1 bit): A bit that specifies whether the PivotTable has AutoFormat applied.

    E - fAtrNum (1 bit): A bit that specifies whether the PivotTable has number AutoFormat applied.

    F - fAtrFnt (1 bit): A bit that specifies whether the PivotTable has font AutoFormat applied.

    G - fAtrAlc (1 bit): A bit that specifies whether the PivotTable has alignment AutoFormat applied.

    H - fAtrBdr (1 bit): A bit that specifies whether the PivotTable has border AutoFormat applied.

    I - fAtrPat (1 bit): A bit that specifies whether the PivotTable has pattern AutoFormat applied.

    J - fAtrProc (1 bit): A bit that specifies whether the PivotTable has width/height AutoFormat applied.

    unused2 (6 bits): Undefined and MUST be ignored.

    itblAutoFmt (2 bytes): An AutoFmt8 structure that specifies the PivotTable AutoFormat. 
                If the value of itblAutoFmt in the associated SXViewEx9 record is not 1, this field is overridden by the value of itblAutoFmt in the associated SXViewEx9.

    cchTableName (2 bytes): An unsigned integer that specifies the length, in characters, of stTable. 
                MUST be greater than or equal to zero and less than or equal to 0x00FF.

    cchDataName (2 bytes): An unsigned integer that specifies the length, in characters of stData. 
                MUST be greater than zero and less than or equal to 0x00FE.

    stTable (variable): An XLUnicodeStringNoCch structure that specifies the name of the PivotTable. 
                The length of this field is specified by cchTableName.

    stData (variable): An XLUnicodeStringNoCch structure that specifies the name of the data field. 
                The length of this field is specified by cchDataName.
   
   

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
Sxview()

Method Summary

Modifier and Type	Method and Description
void	addColField(int fieldNumber) adds a pivot field (0-based index) to the COL axis
void	addDataField(int fieldIndex, String aggregateFunction, String name) adds a pivot field to the DATA axis
ArrayList	addInitialRecords(Boundsheet sheet) creates the basic, default records necessary to define a pivot table
void	addPageField(int fieldIndex, int itemIndex) adds a pivot field to the page axis
Sxvd	addPivotFieldToAxis(int axis, int fieldIndex) adds the pivot field corresponding to cache field at index fieldIndex to the desired axis A pivot field is a cache field that has been added to the pivot table Pivot fields are defined by SXVD and associated records the SXVD record stores which axis the field is on there are cDim pivot fields on the pivot table view 1= row 2= col 4= page 8= data
void	addPivotItem(Sxvd axis, int itemType, int cacheItem) adds a pivot item to the end of the list of items on this axis (ROW, COL, DATA or PAGE)
void	addPivotLineToCOLAxis(int repeat, int nLines, int type, short[] indexes) set the number of pivot items or lines on the COL axis
void	addPivotLineToROWAxis(int repeat, int nLines, int type, short[] indexes) sets the number of pivot items or lines on the ROW axis
void	addRowField(int fieldNumber) adds a pivot field (0-based index) to the ROW axis
void	addSubrecord(BiffRec r) store associated records for ease of lookup
short	getCCol() returns the number of pivot items or lines on the COL axis
short	getCDimCol() returns the number of pivot fields on the COL axis
short	getCDimData() returns the number of pivot fields on the data axis
short	getCDimPg() returns the number of fields on the page axis
short	getCDimRw() returns the number of pivot fields on the ROW axis
short	getColFirst() retrieves the first column of the pivot table
short	getColFirstData()
short	getColLast() sets the last column of the pivot table
short	getCRw() returns the number of pivot items or lines on the ROW axis
String	getDataName()
boolean	getFAlign() specifies whether the PivotTable has alignment AutoFormat applied.
boolean	getFAutoFormat() specifies whether the PivotTable has AutoFormat applied.
boolean	getFBorder() specifies whether the PivotTable has border AutoFormat applied.
boolean	getFColGrand() specifies whether the PivotTable contains grand totals for columns.
boolean	getFFont() specifies whether the PivotTable has font AutoFormat applied.
boolean	getFNumber()
boolean	getFPattern() specifies whether the PivotTable has pattern AutoFormat applied.
boolean	getFRwGrand() specifies whether the PivotTable contains grand totals for rows.
boolean	getFWH()
short	getICache() iCache links this pivot table to a pivot data cache
short	getIpos4Data() A signed integer that specifies the row or column position for the data field in the PivotTable view.
short	getItblAutoFmt()
short	getNPivotFields() returns the number of pivot fields (==columns in the pivot table data range)
static XLSRecord	getPrototype()
short	getRwFirst() retrieves the first row of the pivot table
short	getRwFirstData()
short	getRwFirstHead()
short	getRwLast() retieves the first row of the pivot table
short	getSxaxis4Data() retieves the default axis for the data field: 1- row 2= col 4= page 8= data
String	getTableName() return the name of the Pivot Table.
protected boolean	hasRowPivotItemsRecord()
void	init() perform record initialization
protected void	setAxis4Data(short s) specifies the default axis for the data field: 1- row 2= col 4= page 8= data
void	setColFirst(short s) sets the first column of the pivot table
void	setColFirstData(short s)
void	setColGrand(boolean b) specifies whether the PivotTable contains grand totals for columns.
void	setColLast(short s) sets the last column of the pivot table
void	setDataName(String s) Sets the name of the Data field
void	setFAlign(boolean b) specifies whether the PivotTable has alignment AutoFormat applied.
void	setFAutoFormat(boolean b) specifies whether the PivotTable has AutoFormat applied.
void	setFBorder(boolean b) specifies whether the PivotTable has border AutoFormat applied.
void	setFFont(boolean b) specifies whether the PivotTable has font AutoFormat applied.
void	setFNumber(boolean b)
void	setFPattern(boolean b) specifies whether the PivotTable has pattern AutoFormat applied.
void	setFRwGrand(boolean b) specifies whether the PivotTable contains grand totals for rows.
void	setFWH(boolean b)
void	setGrbit(short s)
void	setICache(short s) iCache links this pivot table to a pivot data cache
protected void	setIpos4Data(short s) A signed integer that specifies the row or column position for the data field in the PivotTable view.
void	setItblAutoFmt(short s)
void	setLocation(String range) sets the location and size of this pivot table view
void	setNPivotFields(short s) sets the number of pivot fields (i.e.
void	setRwFirst(short s) sets the first row of the pivot table
void	setRwFirstData(short s)
void	setRwFirstHead(short s)
void	setRwLast(short s) sets the last row of the pivot table
void	setTableName(String s) Sets the name of the Pivot Table.
String	toString()

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Sxview

public Sxview()

Method Detail

getPrototype

public static XLSRecord getPrototype()

init

public void init()

Description copied from class: XLSRecord

perform record initialization

Specified by:

init in interface BiffRec

Overrides:

init in class XLSRecord

setAxis4Data

protected void setAxis4Data(short s)

specifies the default axis for the data field:

1- row 2= col 4= page 8= data

Parameters:

s -

getSxaxis4Data

public short getSxaxis4Data()

retieves the default axis for the data field:

1- row 2= col 4= page 8= data