|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.poi.hssf.record.RecordBase
org.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.DVRecord
public final class DVRecord
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 | |
---|---|
static short |
sid
|
Constructor Summary | |
---|---|
DVRecord(int validationType,
int operator,
int errorStyle,
boolean emptyCellAllowed,
boolean suppressDropDownArrow,
boolean isExplicitList,
boolean showPromptBox,
java.lang.String promptTitle,
java.lang.String promptText,
boolean showErrorBox,
java.lang.String errorTitle,
java.lang.String errorText,
Ptg[] formula1,
Ptg[] formula2,
CellRangeAddressList regions)
|
|
DVRecord(RecordInputStream in)
Constructs a DV record and sets its fields appropriately. |
Method Summary | |
---|---|
java.lang.Object |
clone()
Clones the object. |
protected void |
fillFields(RecordInputStream in)
called by the constructor, should set class level fields. |
CellRangeAddressList |
getCellRangeAddress()
|
int |
getConditionOperator()
get the condition operator |
int |
getDataType()
|
boolean |
getEmptyCellAllowed()
|
int |
getErrorStyle()
|
boolean |
getListExplicitFormula()
|
int |
getRecordSize()
gives the current serialized size of the record. |
boolean |
getShowErrorOnInvalidValue()
|
boolean |
getShowPromptOnCellSelected()
|
short |
getSid()
return the non static version of the id for this record. |
boolean |
getSuppressDropdownArrow()
|
int |
serialize(int offset,
byte[] data)
called by the class that is responsible for writing this sucker. |
java.lang.String |
toString()
get a string representation of the record (for biffview/debugging) |
protected void |
validateSid(short id)
called by constructor, should throw runtime exception in the event of a record passed with a differing ID. |
Methods inherited from class org.apache.poi.hssf.record.Record |
---|
cloneViaReserialise, isInValueSection, isValue, serialize |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final short sid
Constructor Detail |
---|
public DVRecord(RecordInputStream in)
in
- the RecordInputstream to read the record frompublic DVRecord(int validationType, int operator, int errorStyle, boolean emptyCellAllowed, boolean suppressDropDownArrow, boolean isExplicitList, boolean showPromptBox, java.lang.String promptTitle, java.lang.String promptText, boolean showErrorBox, java.lang.String errorTitle, java.lang.String errorText, Ptg[] formula1, Ptg[] formula2, CellRangeAddressList regions)
Method Detail |
---|
protected void validateSid(short id)
Record
validateSid
in class Record
id
- alleged id for this recordprotected void fillFields(RecordInputStream in)
Record
fillFields
in class Record
in
- the RecordInputstream to read the record frompublic int getDataType()
DVConstraint.ValidationType
public int getErrorStyle()
HSSFDataValidation.ErrorStyle
public boolean getListExplicitFormula()
true
if in list validations the string list is explicitly given in the
formula, false
otherwisepublic boolean getEmptyCellAllowed()
true
if empty values are allowed in cells, false
otherwisepublic boolean getSuppressDropdownArrow()
true
if drop down arrow should be suppressed when list validation is
used, false
otherwisepublic boolean getShowPromptOnCellSelected()
true
if a prompt window should appear when cell is selected, false
otherwisepublic boolean getShowErrorOnInvalidValue()
true
if an error window should appear when an invalid value is entered
in the cell, false
otherwisepublic int getConditionOperator()
utility class
public CellRangeAddressList getCellRangeAddress()
public java.lang.String toString()
Record
toString
in class Record
public int serialize(int offset, byte[] data)
RecordBase
serialize
in class RecordBase
offset
- to begin writing atdata
- byte array containing instance data
public int getRecordSize()
Record
getRecordSize
in class Record
public short getSid()
Record
getSid
in class Record
public java.lang.Object clone()
clone
in class Record
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |