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

public final Class DatRecord

extends StandardRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.hssf.record.HSSFRecordTypes, .RecordInputStream, .StandardRecord, org.apache.poi.util.BitField, .BitFieldFactory, .GenericRecordUtil, .LittleEndianOutput

The dat record is used to store options for the chart.

Field Summary

Modifier and TypeField and Description
private static final BitField
private short
private static final BitField
private static final BitField
public static final short
private static final BitField

Constructor Summary

AccessConstructor and Description
public
public
public

Method Summary

Modifier and TypeMethod and Description
public DatRecord
protected int
public Map<String, Supplier<?>>
public HSSFRecordTypes
public short
getOptions()

Get the options field for the Dat record.

public short
getSid()

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

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

public boolean

Returns:

the border field value.
isBorder
()

data table has a border

public boolean

Returns:

the horizontal border field value.
isHorizontalBorder
()

has a horizontal border

public boolean

Returns:

the show series key field value.
isShowSeriesKey
()

shows the series key

public boolean

Returns:

the vertical border field value.
isVerticalBorder
()

has vertical border

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
setBorder(boolean value)

Sets the border field value.

public void
setHorizontalBorder(boolean value)

Sets the horizontal border field value.

public void
setOptions(short field_1_options)

Set the options field for the Dat record.

public void
setShowSeriesKey(boolean value)

Sets the show series key field value.

public void
setVerticalBorder(boolean value)

Sets the vertical border field value.

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

Field Detail

borderback to summary
private static final BitField border
field_1_optionsback to summary
private short field_1_options
horizontalBorderback to summary
private static final BitField horizontalBorder
showSeriesKeyback to summary
private static final BitField showSeriesKey
sidback to summary
public static final short sid
verticalBorderback to summary
private static final BitField verticalBorder

Constructor Detail

DatRecordback to summary
public DatRecord()
DatRecordback to summary
public DatRecord(DatRecord other)
DatRecordback to summary
public DatRecord(RecordInputStream in)

Method Detail

copyback to summary
public DatRecord copy()

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

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

Returns:DatRecord

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.

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
getOptionsback to summary
public short getOptions()

Get the options field for the Dat record.

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

isBorderback to summary
public boolean isBorder()

data table has a border

Returns:boolean

the border field value.

isHorizontalBorderback to summary
public boolean isHorizontalBorder()

has a horizontal border

Returns:boolean

the horizontal border field value.

isShowSeriesKeyback to summary
public boolean isShowSeriesKey()

shows the series key

Returns:boolean

the show series key field value.

isVerticalBorderback to summary
public boolean isVerticalBorder()

has vertical border

Returns:boolean

the vertical border field value.

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

setBorderback to summary
public void setBorder(boolean value)

Sets the border field value. data table has a border

setHorizontalBorderback to summary
public void setHorizontalBorder(boolean value)

Sets the horizontal border field value. has a horizontal border

setOptionsback to summary
public void setOptions(short field_1_options)

Set the options field for the Dat record.

setShowSeriesKeyback to summary
public void setShowSeriesKey(boolean value)

Sets the show series key field value. shows the series key

setVerticalBorderback to summary
public void setVerticalBorder(boolean value)

Sets the vertical border field value. has vertical border