Package org.apache.poi.hssf.record
Class DVRecord
java.lang.Object
org.apache.poi.hssf.record.RecordBase
org.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.StandardRecord
org.apache.poi.hssf.record.DVRecord
- All Implemented Interfaces:
Cloneable
Title: DATAVALIDATION Record (0x01BE)
Description: This record stores data validation settings and a list of cell ranges which contain these settings. The data validation settings of a sheet are stored in a sequential list of DV records. This list is followed by DVAL record(s)
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionDVRecord
(int validationType, int operator, int errorStyle, boolean emptyCellAllowed, boolean suppressDropDownArrow, boolean isExplicitList, boolean showPromptBox, String promptTitle, String promptText, boolean showErrorBox, String errorTitle, String errorText, Ptg[] formula1, Ptg[] formula2, CellRangeAddressList regions) -
Method Summary
Modifier and TypeMethodDescriptionclone()
Clones the object.int
get the condition operatorprotected int
int
boolean
int
Ptg[]
Ptg[]
boolean
boolean
boolean
short
getSid()
return the non static version of the id for this record.boolean
void
Write the data content of this BIFF record.toString()
get a string representation of the record (for biffview/debugging)Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serialize
Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
-
Constructor Details
-
DVRecord
public DVRecord(int validationType, int operator, int errorStyle, boolean emptyCellAllowed, boolean suppressDropDownArrow, boolean isExplicitList, boolean showPromptBox, String promptTitle, String promptText, boolean showErrorBox, String errorTitle, String errorText, Ptg[] formula1, Ptg[] formula2, CellRangeAddressList regions) -
DVRecord
-
-
Method Details
-
getDataType
public int getDataType()- Returns:
- the condition data type
- See Also:
-
getErrorStyle
public int getErrorStyle()- Returns:
- the condition error style
- See Also:
-
getListExplicitFormula
public boolean getListExplicitFormula()- Returns:
true
if in list validations the string list is explicitly given in the formula,false
otherwise
-
getEmptyCellAllowed
public boolean getEmptyCellAllowed()- Returns:
true
if empty values are allowed in cells,false
otherwise
-
getSuppressDropdownArrow
public boolean getSuppressDropdownArrow()- Returns:
true
if drop down arrow should be suppressed when list validation is used,false
otherwise
-
getShowPromptOnCellSelected
public boolean getShowPromptOnCellSelected()- Returns:
true
if a prompt window should appear when cell is selected,false
otherwise
-
getShowErrorOnInvalidValue
public boolean getShowErrorOnInvalidValue()- Returns:
true
if an error window should appear when an invalid value is entered in the cell,false
otherwise
-
getConditionOperator
public int getConditionOperator()get the condition operator- Returns:
- the condition operator
- See Also:
-
getPromptTitle
-
getErrorTitle
-
getPromptText
-
getErrorText
-
getFormula1
-
getFormula2
-
getCellRangeAddress
-
toString
Description copied from class:Record
get a string representation of the record (for biffview/debugging) -
serialize
Description copied from class:StandardRecord
Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.The number of bytes written must equal the record size reported by
RecordBase.getRecordSize()
} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).- Specified by:
serialize
in classStandardRecord
- Parameters:
out
- the output object
-
getDataSize
protected int getDataSize()- Specified by:
getDataSize
in classStandardRecord
-
getSid
public short getSid()Description copied from class:Record
return the non static version of the id for this record. -
clone
Clones the object. Uses serialisation, as the contents are somewhat complex
-