io.starter.formats.XLS

Class Dval

java.lang.Object

io.starter.formats.XLS.XLSRecord

io.starter.formats.XLS.Dval

All Implemented Interfaces:

BlockByteConsumer, BiffRec, XLSConstants, Serializable

public class Dval
extends XLSRecord

Dval: Data Validity Settings (01B2h)
This record is the list header of the Data Validity Table in the current sheet. Offset Name Size Contents ------------------------------------------------------- 0 wDviFlags 2 Option flags: 2 xLeft 4 Horizontal position of the prompt box, if it has fixed position, in pixel 6 yTop 4 Vertical position of the prompt box, if it has fixed position, in pixel 10 inObj 4 Object identifier of the drop down arrow object for a list box , if a list box is visible at the current cursor position, FFFFFFFFH otherwise 14 idvMac 4 Number of following DV records wDviFlags Bit Mask Name Contents ------------------------------------------------------ 0 0001H fWnClosed 0 = Prompt box not visible 1 = Prompt box currently visible 1 0002H fWnPinned 0 = Prompt box has fixed position 1 = Prompt box appears at cell 2 0004H fCached 1 = Cell validity data cached in following DV records

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

Method Summary

Modifier and Type	Method and Description
void	addDvRec(Dv dv) Add a new Dv record to this Dval;
Dv	createDvRec(String location) Add a new (ie not on parse) dv record, updates the parent record with the count
Dv	getDv(String cellAddress)
List	getDvs() Return all dvs for this Dval
int	getFollowingDvCount() Get the count of dv records following this Dval
int	getHorizontalPosition() Horizontal position of the prompt box, if it has fixed position, in pixel
int	getObjectIdentifier() Object identifier of the drop down arrow object for a list box , if a list box is visible at the current cursor position, FFFFFFFFH otherwise
String	getOOXML() generate the proper OOXML to define this Dval
protected static XLSRecord	getPrototype() Create a dval record & populate with prototype bytes
int	getVerticalPosition() Vertical position of the prompt box, if it has fixed position, in pixel
void	init() Standard init method, nothing new
boolean	isPromptBoxAtCell() Get where the prompt box is located.
boolean	isPromptBoxVisible() Get visibility of prompt box true = Prompt box currently visible; false = Prompt box not visible
boolean	isValidityCached() Is Cell validity data cached in following DV records?
static Dval	parseOOXML(org.xmlpull.v1.XmlPullParser xpp, Boundsheet bs) create one or more Data Validation records based on OOXML input
void	removeDvRec(Dv dv) Remove a dv rec from this dval.
void	setFollowingDvCount(int cnt) Set the count of following Dv records
void	setGrbit() Apply the grbit to the record in the streamer
void	setHorizontalPosition(int cnt) Horizontal position of the prompt box, if it has fixed position, in pixel
void	setObjectIdentifier(int cnt) Object identifier of the drop down arrow object for a list box , if a list box is visible at the current cursor position, FFFFFFFFH otherwise
void	setPromptBoxAtCell(boolean location) Set where the prompt box is located.
void	setPromptBoxVisible(boolean location) Set visibility of prompt box true = Prompt box currently visible; false = Prompt box not visible
void	setValidityCached(boolean cached) Set cell validity data cached in following DV records
void	setVerticalPosition(int cnt) Vertical position of the prompt box, if it has fixed position, in pixel

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

Dval

public Dval()

Method Detail

init

public void init()

Standard init method, nothing new

Specified by:

init in interface BiffRec

Overrides:

init in class XLSRecord

See Also:

XLSRecord.init()

getPrototype

protected static XLSRecord getPrototype()

Create a dval record & populate with prototype bytes

Returns:

setGrbit

public void setGrbit()

Apply the grbit to the record in the streamer

isValidityCached

public boolean isValidityCached()

Is Cell validity data cached in following DV records?

Returns:

setValidityCached

public void setValidityCached(boolean cached)

Set cell validity data cached in following DV records

isPromptBoxAtCell

public boolean isPromptBoxAtCell()

Get where the prompt box is located. true = Prompt box is at cell; false= Prompt box in fixed position

Returns:

setPromptBoxAtCell

public void setPromptBoxAtCell(boolean location)

Set where the prompt box is located. true = Prompt box is at cell; false= Prompt box in fixed position

isPromptBoxVisible

public boolean isPromptBoxVisible()

Get visibility of prompt box true = Prompt box currently visible; false = Prompt box not visible

Returns:

setPromptBoxVisible

public void setPromptBoxVisible(boolean location)

Set visibility of prompt box true = Prompt box currently visible; false = Prompt box not visible

getFollowingDvCount

public int getFollowingDvCount()

Get the count of dv records following this Dval

Returns:

setFollowingDvCount

public void setFollowingDvCount(int cnt)

Set the count of following Dv records

Parameters:

cnt - = count

getObjectIdentifier

public int getObjectIdentifier()

Object identifier of the drop down arrow object for a list box , if a list box is visible at the current cursor position, FFFFFFFFH otherwise

Returns:

setObjectIdentifier

public void setObjectIdentifier(int cnt)

Object identifier of the drop down arrow object for a list box , if a list box is visible at the current cursor position, FFFFFFFFH otherwise

Parameters:

cnt - = identifier

getHorizontalPosition

public int getHorizontalPosition()

Horizontal position of the prompt box, if it has fixed position, in pixel

Returns:

setHorizontalPosition

public void setHorizontalPosition(int cnt)

Horizontal position of the prompt box, if it has fixed position, in pixel

Parameters:

cnt - = position

getVerticalPosition

public int getVerticalPosition()

Vertical position of the prompt box, if it has fixed position, in pixel

Returns:

setVerticalPosition

public void setVerticalPosition(int cnt)

Vertical position of the prompt box, if it has fixed position, in pixel

Parameters:

cnt - = position

addDvRec

public void addDvRec(Dv dv)

Add a new Dv record to this Dval;

Parameters:

dv -

createDvRec

public Dv createDvRec(String location)

Add a new (ie not on parse) dv record, updates the parent record with the count

Parameters:

location - = the cell/range that the dv attaches to. Sheet name not required as Dval is a sheet not book level record

getDvs

public List getDvs()

Return all dvs for this Dval

Returns:

removeDvRec

public void removeDvRec(Dv dv)

Remove a dv rec from this dval.

Parameters:

dv -

getDv

public Dv getDv(String cellAddress)

Parameters:

cellAddress -

Returns:

parseOOXML

public static Dval parseOOXML(org.xmlpull.v1.XmlPullParser xpp,
                              Boundsheet bs)

create one or more Data Validation records based on OOXML input

getOOXML

public String getOOXML()

generate the proper OOXML to define this Dval

Returns: