io.starter.formats.XLS

Class Obj

java.lang.Object

io.starter.formats.XLS.XLSRecord

io.starter.formats.XLS.Obj

All Implemented Interfaces:

BlockByteConsumer, BiffRec, XLSConstants, Serializable

public final class Obj
extends XLSRecord

OBJ Describes a graphic object 0x5D
MsoDrawing, MsoDrawngGroup + MsoDrawingSelection contain remaining drawing object data Each subrecord begins with a 2byte id number, ft. Next, a two-byte length field, b, specifies the length of the subrecord data. The subrecord data field follws the length field. In BIFF8, the OBJ record contains a partial description of a drawing object, and the MSODRAWING, MSODRAWINGGROUP, and MSODRAWINGSELECTION records contain the remaining drawing object data. To store an OBJ record in BIFF8, Microsoft Excel writes a collection of subrecords. The structure of a subrecord is identical to the structure of a BIFF record. Each subrecord begins with a 2-byte id number, ft (see the following table). Next a 2-byte length field, cb, specifies the length of the subrecord data field. The subrecord data field follows the length field. First subrecord is always ftCmo (common object data) and the last is always ftEnd. For all records other than ftEnd and ftCmo, the subrecord contents are as follows: NOTE: THIS IS NOT NECESSARILY TRUE IF THE SUBRECORD CONTAINS CONTINUES ******** see ftClbsData Offset Name Size Contents 0 ft 2 = subrecord id (0x4 to 0x14, depending on which record) 2 cb 2 Length of data 4 Reserved var POSSIBLE SUBRECORDS: ftEnd 00h End of OBJ record (4 bytes of 0) (Reserved) 01h (Reserved) 02h (Reserved) 03h ftMacro 04h Fmla-style macro ftButton 05h Command button ftGmo 06h Group marker ftCf 07h Clipboard format ftPioGrbit 08h Picture option flags ftPictFmla 09h Picture fmla-style macro ftCbls 0Ah Check box link ftRbo 0Bh Radio button ftSbs 0Ch Scroll bar ftNts 0Dh Note structure ftSbsFmla 0Eh Scroll bar fmla-style macro ftGboData 0Fh Group box data ftEdoData 10h Edit control data ftRboData 11h Radio button data ftCblsData 12h Check box data ftLbsData 13h List box data ftCblsFmla 14h Check box link fmla-style macro

See Also:

Obj.init, Obj.getBasicObjRecord, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static byte	otArc
static byte	otButton
static byte	otChart
static byte	otCheckbox
static byte	otDialogbox
static byte	otDropdownlist
static byte	otEditbox
static byte	otGroup
static byte	otGroupbox
static byte	otLabel
static byte	otLine
static byte	otList
static byte	otNote
static byte	otOfficeArtobject
static byte	otOval
static byte	otPicture
static byte	otPolygon
static byte	otRadiobutton
static byte	otRectangle
static byte	otScrollbar
static byte	otSpincontrol
static byte	otText
byte[]	PROTOTYPE_BYTES

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
Obj()
Obj(int obType, int obId, int grbit) create a new object of the desired type NOTE: most object types require one or more sub-records to be complete

Method Summary

Modifier and Type	Method and Description
String	debugOutput() returns debug output for this Obj record FOR INTERNAL USE ONLY
protected static Obj	getBasicObjRecord(int obType, int obId) creates the basic subrecord structure for the desired object type After the basic Object record is complete, there NOTE: much of this is not complete
Chart	getChart() Return the chart for this obj, if exists.
int	getObjId() ------------------------------------------------------------
int	getObjType() ------------------------------------------------------------
protected static XLSRecord	getPrototype()
void	init() Initialize a new OBJ Record
void	setChart(Chart c)
void	setObjId(int objId) ------------------------------------------------------------
void	setSheet(Sheet b) Associate this record with a worksheet.
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, setStreamer, setStringVal, setValueForCell, setWorkBook, setXFRecord, setXFRecord, shouldEncrypt, toHexDump

Methods inherited from class java.lang.Object

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

Field Detail

PROTOTYPE_BYTES

public byte[] PROTOTYPE_BYTES

otGroup

public static final byte otGroup

See Also:

Constant Field Values

otLine

public static final byte otLine

See Also:

Constant Field Values

otRectangle

public static final byte otRectangle

See Also:

Constant Field Values

otOval

public static final byte otOval

See Also:

Constant Field Values

otArc

public static final byte otArc

See Also:

Constant Field Values

otChart

public static final byte otChart

See Also:

Constant Field Values

otText

public static final byte otText

See Also:

Constant Field Values

otButton

public static final byte otButton

See Also:

Constant Field Values

otPicture

public static final byte otPicture

See Also:

Constant Field Values

otPolygon

public static final byte otPolygon

See Also:

Constant Field Values

otCheckbox

public static final byte otCheckbox

See Also:

Constant Field Values

otRadiobutton

public static final byte otRadiobutton

See Also:

Constant Field Values

otEditbox

public static final byte otEditbox

See Also:

Constant Field Values

otLabel

public static final byte otLabel

See Also:

Constant Field Values

otDialogbox

public static final byte otDialogbox

See Also:

Constant Field Values

otSpincontrol

public static final byte otSpincontrol

See Also:

Constant Field Values

otScrollbar

public static final byte otScrollbar

See Also:

Constant Field Values

otList

public static final byte otList

See Also:

Constant Field Values

otGroupbox

public static final byte otGroupbox

See Also:

Constant Field Values

otDropdownlist

public static final byte otDropdownlist

See Also:

Constant Field Values

otNote

public static final byte otNote

See Also:

Constant Field Values

otOfficeArtobject

public static final byte otOfficeArtobject

See Also:

Constant Field Values

Constructor Detail

Obj

public Obj()

Obj

public Obj(int obType,
           int obId,
           int grbit)

create a new object of the desired type
NOTE: most object types require one or more sub-records to be complete

Parameters:

obType - object type - one of the object type constants

obId - object id - must be unique in worksheet or chart substream

grbit - object properties

Method Detail

getPrototype

protected static XLSRecord getPrototype()

getBasicObjRecord

protected static Obj getBasicObjRecord(int obType,
                                       int obId)

creates the basic subrecord structure for the desired object type
After the basic Object record is complete, there
NOTE: much of this is not complete

Parameters:

int - obType - one of the object type (ot) constants

int - obId - object id - must be unique per worksheet/chart substream

Returns:

new object record

toString

public String toString()

Overrides:

toString in class XLSRecord

setSheet

public void setSheet(Sheet b)

Associate this record with a worksheet. \

Specified by:

setSheet in interface BiffRec

Overrides:

setSheet in class XLSRecord

init

public void init()

Initialize a new OBJ Record

Specified by:

init in interface BiffRec

Overrides:

init in class XLSRecord

getChart

public Chart getChart()

Return the chart for this obj, if exists. Null if not ------------------------------------------------------------

Returns:

setChart

public void setChart(Chart c)

getObjType

public int getObjType()

------------------------------------------------------------

Returns:

Returns the objType.

getObjId

public int getObjId()

------------------------------------------------------------

Returns:

Returns the objId.

setObjId

public void setObjId(int objId)

------------------------------------------------------------

Parameters:

objId - The objId to set.

debugOutput

public String debugOutput()

returns debug output for this Obj record
FOR INTERNAL USE ONLY

Returns: