org.apache.poi.hssf.record
Class DVALRecord

java.lang.Object
  org.apache.poi.hssf.record.Record
      org.apache.poi.hssf.record.DVALRecord

public class DVALRecord
extends Record

Title: DATAVALIDATIONS Record

Description: used in data validation ; This record is the list header of all data validation records (0x01BE) in the current sheet.

Author:

Dragos Buleandra (dragos.buleandra@trade2b.ro)

Field Summary

static short

sid

Constructor Summary

DVALRecord()

DVALRecord(RecordInputStream in)
Constructs a DVAL record and sets its fields appropriately.

Method Summary

java.lang.Object	clone()
protected void	fillFields(RecordInputStream in) called by the constructor, should set class level fields.
int	getDVRecNo() Get number of following DV records
int	getHorizontalPos()
int	getObjectID() get Object ID of the drop down arrow object for list boxes
short	getOptions()
int	getRecordSize() gives the current serialized size of the record.
short	getSid() return the non static version of the id for this record.
int	getVerticalPos()
int	serialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.
void	setDVRecNo(int dvNo) Set the number of following DV records
void	setHorizontalPos(int field_2_horiz_pos)
void	setObjectID(int cboID) set the object ID of the drop down arrow object for list boxes
void	setOptions(short field_1_options)
void	setVerticalPos(int field_3_vert_pos)
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

DVALRecord

public DVALRecord()

DVALRecord

public DVALRecord(RecordInputStream in)

Constructs a DVAL record and sets its fields appropriately.

Parameters:

in - the RecordInputstream to read the record from

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

setOptions

public void setOptions(short field_1_options)

Parameters:

field_1_options - the options of the dialog

setHorizontalPos

public void setHorizontalPos(int field_2_horiz_pos)

Parameters:

field_2_horiz_pos - the Horizontal position of the dialog

setVerticalPos

public void setVerticalPos(int field_3_vert_pos)

Parameters:

field_3_vert_pos - the Vertical position of the dialog

setObjectID

public void setObjectID(int cboID)

set the object ID of the drop down arrow object for list boxes

Parameters:

cboID - - Object ID

setDVRecNo

public void setDVRecNo(int dvNo)

Set the number of following DV records

Parameters:

dvNo - - the DV records number

getOptions

public short getOptions()

Returns:

the field_1_options

getHorizontalPos

public int getHorizontalPos()

Returns:

the Horizontal position of the dialog

getVerticalPos

public int getVerticalPos()

Returns:

the the Vertical position of the dialog

getObjectID

public int getObjectID()

get Object ID of the drop down arrow object for list boxes

getDVRecNo

public int getDVRecNo()

Get number of following DV records

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: Record

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 Record

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

Overrides:

clone in class Record