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.DVRecord

public final class DVRecord
extends Record

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)

Author:

Dragos Buleandra (dragos.buleandra@trade2b.ro), Josh Micich

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

sid

public static final short sid

See Also:

Constant Field Values

Constructor Detail

DVRecord

public DVRecord(RecordInputStream in)

Constructs a DV record and sets its fields appropriately.

Parameters:

in - the RecordInputstream to read the record from

DVRecord

public 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

validateSid

protected void validateSid(short id)

Description copied from class: Record

called by constructor, should throw runtime exception in the event of a record passed with a differing ID.

Specified by:

validateSid in class Record

Parameters:

id - alleged id for this record

fillFields

protected void fillFields(RecordInputStream in)

Description copied from class: Record

called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.

Specified by:

fillFields in class Record

Parameters:

in - the RecordInputstream to read the record from

getDataType

public int getDataType()

Returns:

the condition data type

See Also:

DVConstraint.ValidationType

getErrorStyle

public int getErrorStyle()

Returns:

the condition error style

See Also:

HSSFDataValidation.ErrorStyle

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:

utility class

getCellRangeAddress

public CellRangeAddressList getCellRangeAddress()

toString

public java.lang.String toString()

Description copied from class: Record

get a string representation of the record (for biffview/debugging)

Overrides:

toString in class Record

serialize

public int serialize(int offset,
                     byte[] data)

Description copied from class: RecordBase

called by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array.

Specified by:

serialize in class RecordBase

Parameters:

offset - to begin writing at

data - byte array containing instance data

Returns:

number of bytes written

getRecordSize

public int getRecordSize()

Description copied from class: Record

gives the current serialized size of the record. Should include the sid and reclength (4 bytes).

Overrides:

getRecordSize in class Record

getSid

public short getSid()

Description copied from class: Record

return the non static version of the id for this record.

Specified by:

getSid in class Record

clone

public java.lang.Object clone()

Clones the object. Uses serialisation, as the contents are somewhat complex

Overrides:

clone in class Record