Top Description Fields Constructors Methods
org.apache.poi.hssf.record

public final Class DVALRecord

extends StandardRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.util.GenericRecordUtil, .LittleEndianOutput
This record is the list header of all data validation records (0x01BE) in the current sheet.

Field Summary

Modifier and TypeField and Description
private short
field_1_options

Options of the DVAL

private int
field_2_horiz_pos

Horizontal position of the dialog

private int
field_3_vert_pos

Vertical position of the dialog

private int
field_5_dv_no

Number of following DV Records

private int
field_cbo_id

Object ID of the drop down arrow object for list boxes ; in our case this will be always FFFF , until MSODrawingGroup and MSODrawing records are implemented

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
DVALRecord()

public
DVALRecord(DVALRecord other)

public
DVALRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public DVALRecord
copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

protected int
getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

public int

Returns:

the number of following DV records
getDVRecNo()

public Map<String, Supplier<?>>
getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public HSSFRecordTypes
getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

public int

Returns:

the Horizontal position of the dialog
getHorizontalPos()

public int

Returns:

the Object ID of the drop down arrow object for list boxes
getObjectID()

public short

Returns:

the field_1_options
getOptions()

public short
getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

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

public int

Returns:

the Vertical position of the dialog
getVerticalPos()

public void
serialize(LittleEndianOutput
the output object
out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Write the data content of this BIFF record.

public void
setDVRecNo(int
- the DV records number
dvNo)

Set the number of following DV records

public void
setHorizontalPos(int
the Horizontal position of the dialog
horiz_pos)

public void
setObjectID(int
- Object ID
cboID)

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

public void
setOptions(short
the options of the dialog
options)

public void
setVerticalPos(int
the Vertical position of the dialog
vert_pos)

Inherited from org.apache.poi.hssf.record.StandardRecord:
getRecordSizeserialize

Field Detail

field_1_optionsback to summary
private short field_1_options

Options of the DVAL

field_2_horiz_posback to summary
private int field_2_horiz_pos

Horizontal position of the dialog

field_3_vert_posback to summary
private int field_3_vert_pos

Vertical position of the dialog

field_5_dv_noback to summary
private int field_5_dv_no

Number of following DV Records

field_cbo_idback to summary
private int field_cbo_id

Object ID of the drop down arrow object for list boxes ; in our case this will be always FFFF , until MSODrawingGroup and MSODrawing records are implemented

sidback to summary
public static final short sid

Constructor Detail

DVALRecordback to summary
public DVALRecord()
DVALRecordback to summary
public DVALRecord(DVALRecord other)
DVALRecordback to summary
public DVALRecord(RecordInputStream in)

Method Detail

copyback to summary
public DVALRecord copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:DVALRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations
@Override
getDataSizeback to summary
protected int getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

getDVRecNoback to summary
public int getDVRecNo()
Returns:int

the number of following DV records

getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getGenericRecordTypeback to summary
public HSSFRecordTypes getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

Annotations
@Override
getHorizontalPosback to summary
public int getHorizontalPos()
Returns:int

the Horizontal position of the dialog

getObjectIDback to summary
public int getObjectID()
Returns:int

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

getOptionsback to summary
public short getOptions()
Returns:short

the field_1_options

getSidback to summary
public short getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

Doc from org.apache.poi.hssf.record.Record.getSid.

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

Returns:short

he id for this record

getVerticalPosback to summary
public int getVerticalPos()
Returns:int

the Vertical position of the dialog

serializeback to summary
public void serialize(LittleEndianOutput out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Doc from org.apache.poi.hssf.record.StandardRecord.serialize.

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 org.apache.poi.hssf.record.Record#getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Parameters
out:LittleEndianOutput

the output object

setDVRecNoback to summary
public void setDVRecNo(int dvNo)

Set the number of following DV records

Parameters
dvNo:int

- the DV records number

setHorizontalPosback to summary
public void setHorizontalPos(int horiz_pos)
Parameters
horiz_pos:int

the Horizontal position of the dialog

setObjectIDback to summary
public void setObjectID(int cboID)

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

Parameters
cboID:int

- Object ID

setOptionsback to summary
public void setOptions(short options)
Parameters
options:short

the options of the dialog

setVerticalPosback to summary
public void setVerticalPos(int vert_pos)
Parameters
vert_pos:int

the Vertical position of the dialog