io.starter.formats.XLS

Class Setup

java.lang.Object

io.starter.formats.XLS.XLSRecord

io.starter.formats.XLS.Setup

All Implemented Interfaces:

BlockByteConsumer, BiffRec, XLSConstants, Serializable

public class Setup
extends XLSRecord

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

Method Summary

Modifier and Type	Method and Description
short	getCopies()
boolean	getDraft()
short	getFitHeight()
short	getFitWidth()
double	getFooterMargin()
double	getHeaderMargin()
boolean	getLandscape()
boolean	getLeftToRight()
boolean	getNoColor()
boolean	getNoOrient()
boolean	getNoPrintData()
short	getPageStart()
short	getPaperSize()
boolean	getPrintNotes()
short	getResolution()
short	getScale()
boolean	getUsePage()
short	getVerticalResolution()
void	init() perform record initialization
void	setCopies(short c)
void	setDraft(boolean draft)
void	setFitHeight(short f)
void	setFitWidth(short f)
void	setFooterMargin(double f)
void	setGrbit() Apply all the borderLineStyle fields into the current border line styles flag
void	setGrbitOLD()
void	setHeaderMargin(double h)
void	setInitialized(boolean isInitialized)
void	setLandscape(boolean landscape)
void	setLeftToRight(boolean leftToRight)
void	setNoColor(boolean noColor)
void	setNoOrient(boolean noOrient)
void	setPageStart(short p)
void	setPaperSize(short p)
void	setPrintNotes(boolean printNotes)
void	setResolution(short r)
void	setScale(short s)
void	setSheet(Sheet sheet) Associate this record with a worksheet.
void	setUsePage(boolean usePage)
void	setVerticalResolution(short v)

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, getPrototype, 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, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Setup

public Setup()

Method Detail

setSheet

public void setSheet(Sheet sheet)

Description copied from class: XLSRecord

Associate this record with a worksheet. First checks to see if there is already a cell with this address.

Specified by:

setSheet in interface BiffRec

Overrides:

setSheet in class XLSRecord

getDraft

public boolean getDraft()

Returns:

Returns the draft.

setDraft

public void setDraft(boolean draft)

Parameters:

draft - The draft to set.

getLandscape

public boolean getLandscape()

Returns:

Returns the landscape.

setLandscape

public void setLandscape(boolean landscape)

Parameters:

landscape - The landscape to set.

getLeftToRight

public boolean getLeftToRight()

Returns:

Returns the leftToRight.

setLeftToRight

public void setLeftToRight(boolean leftToRight)

Parameters:

leftToRight - The leftToRight to set.

getNoColor

public boolean getNoColor()

Returns:

Returns the noColor.

setNoColor

public void setNoColor(boolean noColor)

Parameters:

noColor - The noColor to set.

getNoOrient

public boolean getNoOrient()

Returns:

Returns the noOrient.

setNoOrient

public void setNoOrient(boolean noOrient)

Parameters:

noOrient - The noOrient to set.

getNoPrintData

public boolean getNoPrintData()

Returns:

Returns the noPrintData.

setInitialized

public void setInitialized(boolean isInitialized)

Parameters:

isInitialized - Set false if settings have changed

getPrintNotes

public boolean getPrintNotes()

Returns:

Returns whether to print Notes.

setPrintNotes

public void setPrintNotes(boolean printNotes)

Parameters:

whether - to print Notes

getUsePage

public boolean getUsePage()

Returns:

Returns whether to use a custom start page

setUsePage

public void setUsePage(boolean usePage)

Parameters:

usePage - The usePage to set.

init

public void init()

Description copied from class: XLSRecord

perform record initialization

Specified by:

init in interface BiffRec

Overrides:

init in class XLSRecord

getCopies

public short getCopies()

Returns:

Returns the copies.

setCopies

public void setCopies(short c)

Parameters:

copies - The copies to set.

getFitHeight

public short getFitHeight()

Returns:

Returns the fitHeight.

setFitHeight

public void setFitHeight(short f)

Parameters:

fitHeight - The fitHeight to set.

getFitWidth

public short getFitWidth()

Returns:

Returns the fitWidth.

setFitWidth

public void setFitWidth(short f)

Parameters:

fitWidth - The fitWidth to set.

getFooterMargin

public double getFooterMargin()

Returns:

Returns the footerMargin.

setFooterMargin

public void setFooterMargin(double f)

Parameters:

footerMargin - The footerMargin to set.

getHeaderMargin

public double getHeaderMargin()

Returns:

Returns the headerMargin.

setHeaderMargin

public void setHeaderMargin(double h)

Parameters:

headerMargin - The headerMargin to set.

getPageStart

public short getPageStart()

Returns:

Returns the pageStart.

setPageStart

public void setPageStart(short p)

Parameters:

pageStart - The pageStart to set.

getPaperSize

public short getPaperSize()

Returns:

Returns the paperSize.

setPaperSize

public void setPaperSize(short p)

Parameters:

paperSize - The paperSize to set.

getResolution

public short getResolution()

Returns:

Returns the resolution.

setResolution

public void setResolution(short r)

Parameters:

resolution - The resolution to set.

getScale

public short getScale()

Returns:

Returns the scale.

setScale

public void setScale(short s)

Parameters:

scale - The scale to set.

getVerticalResolution

public short getVerticalResolution()

Returns:

Returns the verticalResolution.

setVerticalResolution

public void setVerticalResolution(short v)

Parameters:

verticalResolution - The verticalResolution to set.

setGrbit

public void setGrbit()

Apply all the borderLineStyle fields into the current border line styles flag

setGrbitOLD

public void setGrbitOLD()