io.starter.formats.XLS

Class ContinueHandler

java.lang.Object

io.starter.formats.XLS.ContinueHandler

All Implemented Interfaces:

XLSConstants, Serializable

public class ContinueHandler
extends Object
implements Serializable, XLSConstants

this class takes care of the tasks related to working with Continue records. when a Continue record is created, it needs to be associated with its related XLSRecord -- the record whose data it contains.

See Also:

Serialized Form

Field Summary

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
ContinueHandler(WorkBook b)

Method Summary

Modifier and Type	Method and Description
static Continue	addContinue(BiffRec rec, byte[] data, int streampos, Book book) Create and initialize a new Continue record
void	addRec(BiffRec rec, int datalen) add an XLSRecord to this handler check if it needs a Continue, if so, put in our continued_recs.
void	close() clear out object references in prep for closing workbook
static int	createBigContinues(BiffRec rec, int insertLoc) generate Continue records for records with lots of data
static void	createBigRecContinues(BiffRec rec, OutputStream out, ByteStreamer streamer) generate Continue records for records with lots of data
static Continue	createContinue(byte[] data, Book book) Create and initialize a new Continue record
static boolean	createContinues(BiffRec rec, OutputStream out, ByteStreamer streamer) check if the record needs to have its data spanned across Continue records.
static void	createMSODGContinues(BiffRec rec, OutputStream out, ByteStreamer streamer) generate the mandatory Continue records for the Obj rec type
static int	createObjContinues(BiffRec rec) trims the current rec to MAXRECLEN size
static int	createSstContinues(Sst rec, int insertLoc) generate Continue records for Sst records
static void	createSstContinues(Sst rec, OutputStream out, ByteStreamer streamer) generate Continue records for Sst records
static int	createTxoContinues(Txo rec) generate the mandatory Continue records for the Txo rec type Txo must have at least 2 Continue recs first one contains text data second (last) one contains formatting runs
static void	createTxoContinues(Txo rec, OutputStream out, ByteStreamer streamer) generate the mandatory Continue records for the Txo rec type Txo must have at least 2 Continue recs first one contains text data second (last) one contains formatting runs
static void	removeContinues(BiffRec rec) remove Continues from a record TODO: Can this be removed now? We shouldn't really have continues in memory, just on stream, NO?
static void	trimRecSize(BiffRec rec, int CONTINUESIZE) trim original rec to max rec size (for records with size-related Continues, not Txos)

Methods inherited from class java.lang.Object

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

Constructor Detail

ContinueHandler

public ContinueHandler(WorkBook b)

Method Detail

addRec

public void addRec(BiffRec rec,
                   int datalen)

add an XLSRecord to this handler check if it needs a Continue, if so, put in our continued_recs.

createContinues

public static boolean createContinues(BiffRec rec,
                                      OutputStream out,
                                      ByteStreamer streamer)

check if the record needs to have its data spanned across Continue records.

createSstContinues

public static int createSstContinues(Sst rec,
                                     int insertLoc)

generate Continue records for Sst records

createSstContinues

public static void createSstContinues(Sst rec,
                                      OutputStream out,
                                      ByteStreamer streamer)

generate Continue records for Sst records

removeContinues

public static void removeContinues(BiffRec rec)

remove Continues from a record TODO: Can this be removed now? We shouldn't really have continues in memory, just on stream, NO?

createBigRecContinues

public static void createBigRecContinues(BiffRec rec,
                                         OutputStream out,
                                         ByteStreamer streamer)

generate Continue records for records with lots of data

createBigContinues

public static int createBigContinues(BiffRec rec,
                                     int insertLoc)

generate Continue records for records with lots of data

createContinue

public static Continue createContinue(byte[] data,
                                      Book book)

Create and initialize a new Continue record

Parameters:

rec - the XLSRecord owner of the Continue

data - the pre-sized Continue body data

streampos - the position to insert the new Continue into the data stream

addContinue

public static Continue addContinue(BiffRec rec,
                                   byte[] data,
                                   int streampos,
                                   Book book)

Create and initialize a new Continue record

Parameters:

rec - the XLSRecord owner of the Continue

data - the pre-sized Continue body data

streampos - the position to insert the new Continue into the data stream

createTxoContinues

public static int createTxoContinues(Txo rec)

generate the mandatory Continue records for the Txo rec type Txo must have at least 2 Continue recs first one contains text data second (last) one contains formatting runs

createTxoContinues

public static void createTxoContinues(Txo rec,
                                      OutputStream out,
                                      ByteStreamer streamer)

generate the mandatory Continue records for the Txo rec type Txo must have at least 2 Continue recs first one contains text data second (last) one contains formatting runs

createMSODGContinues

public static void createMSODGContinues(BiffRec rec,
                                        OutputStream out,
                                        ByteStreamer streamer)

generate the mandatory Continue records for the Obj rec type

createObjContinues

public static int createObjContinues(BiffRec rec)

trims the current rec to MAXRECLEN size

trimRecSize

public static void trimRecSize(BiffRec rec,
                               int CONTINUESIZE)

trim original rec to max rec size (for records with size-related Continues, not Txos)

close

public void close()

clear out object references in prep for closing workbook