|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.DVRecord
public class DVRecord
Title: DV Record
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
|
static java.lang.Integer |
STRING_ERROR_TEXT
|
static java.lang.Integer |
STRING_ERROR_TITLE
|
static java.lang.Integer |
STRING_PROMPT_TEXT
|
static java.lang.Integer |
STRING_PROMPT_TITLE
|
| Constructor Summary | |
|---|---|
DVRecord()
|
|
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. |
HSSFCellRangeAddress |
getCellRangeAddress()
|
int |
getConditionOperator()
get the condition operator |
int |
getDataType()
get the condition data type |
boolean |
getEmptyCellAllowed()
return true if empty values are allowed in cells, false otherwise |
int |
getErrorStyle()
get the condition error style |
boolean |
getListExplicitFormula()
return true if in list validations the string list is explicitly given in the formula, false otherwise |
int |
getOptionFlags()
gets the option flags field. |
int |
getRecordSize()
gives the current serialized size of the record. |
boolean |
getShowErrorOnInvalidValue()
return true if an error window should appear when an invalid value is entered in the cell, false otherwise |
boolean |
getShowPromptOnCellSelected()
return true if a prompt window should appear when cell is selected, false otherwise |
short |
getSid()
return the non static version of the id for this record. |
java.lang.String |
getStringField(java.lang.Integer type)
|
boolean |
getSurppresDropdownArrow()
return true if drop down arrow should be surppressed when list validation is used, false otherwise |
int |
serialize(int offset,
byte[] data)
called by the class that is responsible for writing this sucker. |
void |
setCellRangeAddress(HSSFCellRangeAddress range)
|
void |
setConditionOperator(int operator)
set the condition operator |
void |
setDataType(int type)
set the condition data type |
void |
setEmptyCellAllowed(boolean allowed)
set if empty values are allowed in cells |
void |
setErrorStyle(int style)
set the condition error style |
void |
setFirstFormulaRPN(java.util.Stack rpn)
|
void |
setFirstFormulaSize(short size)
|
void |
setListExplicitFormula(boolean explicit)
set if in list validations the string list is explicitly given in the formula |
void |
setSecFormulaRPN(java.util.Stack rpn)
|
void |
setSecFormulaSize(short size)
|
void |
setShowErrorOnInvalidValue(boolean show)
set if an error window should appear when an invalid value is entered in the cell |
void |
setShowPromptOnCellSelected(boolean show)
set if a prompt window should appear when cell is selected |
void |
setStringField(java.lang.Integer type,
java.lang.String str_data)
|
void |
setSurppresDropdownArrow(boolean surppress)
set if drop down arrow should be surppressed when list validation is used |
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
public static final java.lang.Integer STRING_PROMPT_TITLE
public static final java.lang.Integer STRING_ERROR_TITLE
public static final java.lang.Integer STRING_PROMPT_TEXT
public static final java.lang.Integer STRING_ERROR_TEXT
| Constructor Detail |
|---|
public DVRecord()
public DVRecord(RecordInputStream in)
in - the RecordInputstream to read the record from| Method Detail |
|---|
protected void validateSid(short id)
Record
validateSid in class Recordid - alleged id for this recordprotected void fillFields(RecordInputStream in)
Record
fillFields in class Recordin - the RecordInputstream to read the record frompublic void setDataType(int type)
type - - condition data typeutility classpublic int getDataType()
utility classpublic void setErrorStyle(int style)
type - - condition error styleutility classpublic int getErrorStyle()
utility classpublic void setListExplicitFormula(boolean explicit)
type - - true if in list validations the string list is explicitly given in the formula; false otherwiseutility classpublic boolean getListExplicitFormula()
utility classpublic void setEmptyCellAllowed(boolean allowed)
type - - true if empty values are allowed in cells, false otherwiseutility classpublic boolean getEmptyCellAllowed()
utility classpublic void setSurppresDropdownArrow(boolean surppress)
type - - true if drop down arrow should be surppressed when list validation is used, false otherwiseutility classpublic boolean getSurppresDropdownArrow()
utility classpublic void setShowPromptOnCellSelected(boolean show)
type - - true if a prompt window should appear when cell is selected, false otherwiseutility classpublic boolean getShowPromptOnCellSelected()
utility classpublic void setShowErrorOnInvalidValue(boolean show)
type - - true if an error window should appear when an invalid value is entered in the cell, false otherwiseutility classpublic boolean getShowErrorOnInvalidValue()
utility classpublic void setConditionOperator(int operator)
type - - condition operatorutility classpublic int getConditionOperator()
utility classpublic void setFirstFormulaRPN(java.util.Stack rpn)
public void setFirstFormulaSize(short size)
public void setSecFormulaRPN(java.util.Stack rpn)
public void setSecFormulaSize(short size)
public void setStringField(java.lang.Integer type,
java.lang.String str_data)
public java.lang.String getStringField(java.lang.Integer type)
public void setCellRangeAddress(HSSFCellRangeAddress range)
public HSSFCellRangeAddress getCellRangeAddress()
public int getOptionFlags()
public java.lang.String toString()
Record
toString in class Record
public int serialize(int offset,
byte[] data)
Record
serialize in class Recordoffset - to begin writing atdata - byte array containing instance data
public int getRecordSize()
Record
getRecordSize in class Recordpublic short getSid()
Record
getSid in class Recordpublic java.lang.Object clone()
clone in class Record
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||