io.starter.formats.XLS

Class Dv

java.lang.Object

io.starter.formats.XLS.XLSRecord

io.starter.formats.XLS.Dv

All Implemented Interfaces:

BlockByteConsumer, BiffRec, XLSConstants, Serializable

public class Dv
extends XLSRecord

Dv: Data Validity Settings (01BEh)
This record is part of the Data Validity Table. It stores data validity settings and a list of cell ranges which contain these settings. The prompt box appears while editing such a cell. The error box appears, if the entered value does not fit the conditions. The data validity settings of a sheet are stored in a sequential list of DV records. This list is preluded by an DVAL record. If a string is empty and the default text should appear in the prompt box or error box, the string must contain a single zero character (string length will be 1).

    Offset          Name              Size                Contents
    --------------------------------------------------------
        0               dwDvFlags      4                   Option flags (see below)
        4               dTitlePrompt   var                 Title of the prompt box (Unicode string, 16-bit string length)
        var.            dTitleError      var.                Title of the error box (Unicode string, 16-bit string length)
        var.            dTextPrompt  var.                Text of the prompt box (Unicode string, 16-bit string length)
        var.            dTextError      var.                Text of the error box (Unicode string, 16-bit string length)
        var.            sz1                 2                    Size of the formula data for first condition (sz1)
        var.            garbage          2                   Not used
        var.            firstCond       sz1                Formula data for first condition (RPN token array without size field)
        var.            sz2                 2                   Size of the formula data for second condition (sz2)
        var.            garbage           2                   Not used
        var.            secondCond sz2                  Formula data for second condition (RPN token array without size field)
        var.            cRangeList    var.                 Cell range address list with all affected ranges
        
    Option flags field:
    Bit             Mask                    Name                 Contents
    --
    3-0         0000000FH           ValType             Data type: 00H = Any value
                                                                          01H = Integer values
                                                                          02H = Decimal values
                                                                          03H = User defined list
                                                                          04H = Date
                                                                          05H = Time
                                                                           06H = Text length
                                                                          07H = Formula
    6-4     00000070H               ErrStyle               Error style: 00H = Stop
                                                                            01H = Warning
                                                                            02H = Info
    7         00000080H              fStrLookup         1 = In list type validity the string list is explicitly given in the formula
    8         00000100H            fAllowBlank         1 = Empty cells allowed
    9         00000200H             fSuppressCombo 1 = Suppress the drop down arrow in list type validity
    18      00040000H             fShowInputMsg     1 = Show prompt box if cell selected
    19      00080000H             fShowErrorMsg      1 = Show error box if invalid values entered
    23-20 00F00000H             typOperator         Condition operator: 00H = Between
                                                                            01H = Not between
                                                                            02H = Equal
                                                                            03H = Not equal
                                                                            04H = Greater than
                                                                            05H = Less than
                                                                            06H = Greater or equal
                                                                            07H = Less or equal
                                                                            
 

In list type validity it is possible to enter an explicit string list. This string list is stored as tStr token . The string items are separated by zero characters. There is no zero character at the end of the string list. Example for a string list with the 3 strings A, B, and C: A<00H>B<00H>C (contained in a tStr token, string length is 5).

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

Method Summary

Modifier and Type	Method and Description
void	addOoxmlRange(String range) Add a range this Dv refers to.
void	addRange(String range) Add a range this Dv refers to.
String	getErrorBoxText() Return the text in the error box
String	getErrorBoxTitle() Return the title from the error box
byte	getErrorStyle() Return a byte representing the error style for this DV These map to the static final ints ERROR_* from ValidationHandle
String	getFirstCond() Get the first condition of the validation as a string representation
short	getIMEMode() Get the IME mode for this validation
String	getOOXML() generate the proper OOXML to define this Dv
String	getPromptBoxText() Return the text in the prompt box
String	getPromptBoxTitle() Return the title in the prompt box
protected static XLSRecord	getPrototype(WorkBook bk) Create a dv record & populate with prototype bytes
String[]	getRanges() Return the range of data this Dv refers to as a string array Values are stored as absolute ($) references, but should be displayed as relative
String	getSecondCond() Get the second condition of the validation as a string representation
boolean	getShowInputMsg() Show prompt box if cell selected?
byte	getTypeOperator() Get the type operator of this validation as a byte.
byte	getValType() Get the validation type of this Dv as a byte These bytes map to the VALUE_* static values in ValidationHandle
void	init() Standard init method
boolean	isAllowBlank() Allow blank cells in the validation area?
boolean	isCorrectDataType(Object value) Determines if the value passed in is of the correct data type
boolean	isInRange(String celladdy) Determines if the Dv contains the cell address passed in
boolean	isShowErrorMsg() Show error box if invalid values entered?
boolean	isStrLookup() In list type validity the string list is explicitly given in the formula
boolean	isSuppressCombo() Suppress the drop down arrow in list type validity
boolean	isValid(Object value) Determine if the value passed in is valid for this validation
static Dv	parseOOXML(org.xmlpull.v1.XmlPullParser xpp, Boundsheet bs) create a new Dv record based on OOXML input
void	preStream() update record.
void	setAllowBlank(boolean allowBlank) Allow blank cells in the validation area?
void	setErrorBoxText(String textError) Set the text for the error box
void	setErrorBoxTitle(String textError) Set the title for the error box
void	setErrorStyle(byte errstyle) Set the error style for this Dv record These map to the static final ints ERROR_* from ValidationHandle
void	setFirstCond(String firstCond) Set the first condition of the validation utilizing a string.
void	setIMEMode(short mode) set the IME mode for this validation
void	setPromptBoxText(String text) Set the text for the prompt box
void	setPromptBoxTitle(String text) Set the title for the prompt box
void	setRange(String range) Set the range this Dv refers to.
void	setSecondCond(String secondCond) Set the first condition of the validation utilizing a string.
void	setShowErrMsg(boolean showErrMsg) set show error box if invalid values entered?
void	setShowInputMsg(boolean showInputMsg) Set show prompt box if cell selected? *
void	setStrLookup(boolean strLookup) In list type validity the string list is explicitly given in the formula
void	setSuppressCombo(boolean suppressCombo) Suppress the drop down arrow in list type validity
void	setTypeOperator(byte typOperator) set the type operator of this validation as a byte.
void	setValType(byte valtype) Set the validation type of this Dv as a byte These bytes map to the VALUE_* static values in ValidationHandle
void	updateGrbit() Apply all the grbit fields into the current grbit int

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

Dv

public Dv()

Method Detail

isValid

public boolean isValid(Object value)
                throws ValidationException

Determine if the value passed in is valid for this validation

Parameters:

value -

Returns:

Throws:

ValidationException

isCorrectDataType

public boolean isCorrectDataType(Object value)

Determines if the value passed in is of the correct data type

Returns:

getPrototype

protected static XLSRecord getPrototype(WorkBook bk)

Create a dv record & populate with prototype bytes

Returns:

init

public void init()

Standard init method

Specified by:

init in interface BiffRec

Overrides:

init in class XLSRecord

See Also:

XLSRecord.init()

preStream

public void preStream()

update record.

Specified by:

preStream in interface BiffRec

Overrides:

preStream in class XLSRecord

See Also:

XLSRecord.preStream()

updateGrbit

public void updateGrbit()

Apply all the grbit fields into the current grbit int

getRanges

public String[] getRanges()

Return the range of data this Dv refers to as a string array Values are stored as absolute ($) references, but should be displayed as relative

Returns:

ptgRef.toString()

setRange

public void setRange(String range)

Set the range this Dv refers to. Pass in a range string, sans worksheet Note that absolute ranges/ptrgrefs are always used, however returning values should not include the dollar sign

Parameters:

range -

addRange

public void addRange(String range)

Add a range this Dv refers to. Pass in a range string, sans worksheet

Parameters:

range -

addOoxmlRange

public void addOoxmlRange(String range)

Add a range this Dv refers to. Pass in a range string, sans worksheet May need additional handling for records outside bounds?

Parameters:

range -

getErrorBoxText

public String getErrorBoxText()

Return the text in the error box

Returns:

setErrorBoxText

public void setErrorBoxText(String textError)

Set the text for the error box

Parameters:

textError -

getPromptBoxText

public String getPromptBoxText()

Return the text in the prompt box

Returns:

setPromptBoxText

public void setPromptBoxText(String text)

Set the text for the prompt box

Parameters:

text -

setErrorBoxTitle

public void setErrorBoxTitle(String textError)

Set the title for the error box

Parameters:

textError -

getErrorBoxTitle

public String getErrorBoxTitle()

Return the title from the error box

Returns:

getPromptBoxTitle

public String getPromptBoxTitle()

Return the title in the prompt box

Returns:

setPromptBoxTitle

public void setPromptBoxTitle(String text)

Set the title for the prompt box

Parameters:

text -

getErrorStyle

public byte getErrorStyle()

Return a byte representing the error style for this DV These map to the static final ints ERROR_* from ValidationHandle

Returns:

setErrorStyle

public void setErrorStyle(byte errstyle)

Set the error style for this Dv record These map to the static final ints ERROR_* from ValidationHandle

isAllowBlank

public boolean isAllowBlank()

Allow blank cells in the validation area?

Returns:

setAllowBlank

public void setAllowBlank(boolean allowBlank)

Allow blank cells in the validation area?

getFirstCond

public String getFirstCond()

Get the first condition of the validation as a string representation

Returns:

setFirstCond

public void setFirstCond(String firstCond)

Set the first condition of the validation utilizing a string. This value must conform to the Value Type of this validation or unexpected results may occur. For example, entering a string representation of a date here will not work if your validation is an integer... String passed in should be a vaild XLS formula. Does not need to include the "=" Types of conditions Integer values Decimal values User defined list Date Time Text length Formula

getSecondCond

public String getSecondCond()

Get the second condition of the validation as a string representation

Returns:

setSecondCond

public void setSecondCond(String secondCond)

Set the first condition of the validation utilizing a string. This value must conform to the Value Type of this validation or unexpected results may occur. For example, entering a string representation of a date here will not work if your validation is an integer... String passed in should be a vaild XLS formula. Does not need to include the "=" Types of conditions Integer values Decimal values User defined list Date Time Text length Formula

isShowErrorMsg

public boolean isShowErrorMsg()

Show error box if invalid values entered?

Returns:

setShowErrMsg

public void setShowErrMsg(boolean showErrMsg)

set show error box if invalid values entered?

getShowInputMsg

public boolean getShowInputMsg()

Show prompt box if cell selected?

Returns:

setShowInputMsg

public void setShowInputMsg(boolean showInputMsg)

Set show prompt box if cell selected? *

isStrLookup

public boolean isStrLookup()

In list type validity the string list is explicitly given in the formula

Returns:

setStrLookup

public void setStrLookup(boolean strLookup)

In list type validity the string list is explicitly given in the formula

isSuppressCombo

public boolean isSuppressCombo()

Suppress the drop down arrow in list type validity

Returns:

getIMEMode

public short getIMEMode()

Get the IME mode for this validation

Returns:

setIMEMode

public void setIMEMode(short mode)

set the IME mode for this validation

setSuppressCombo

public void setSuppressCombo(boolean suppressCombo)

Suppress the drop down arrow in list type validity

getTypeOperator

public byte getTypeOperator()

Get the type operator of this validation as a byte. These bytes map to the CONDITION_* static values in ValidationHandle

Returns:

setTypeOperator

public void setTypeOperator(byte typOperator)

set the type operator of this validation as a byte. These bytes map to the CONDITION_* static values in ValidationHandle

getValType

public byte getValType()

Get the validation type of this Dv as a byte These bytes map to the VALUE_* static values in ValidationHandle

Returns:

setValType

public void setValType(byte valtype)

Set the validation type of this Dv as a byte These bytes map to the VALUE_* static values in ValidationHandle

isInRange

public boolean isInRange(String celladdy)

Determines if the Dv contains the cell address passed in

Parameters:

range -

Returns:

parseOOXML

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

create a new Dv record based on OOXML input

getOOXML

public String getOOXML()

generate the proper OOXML to define this Dv

Returns: