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

public final Class DefaultDataLabelTextPropertiesRecord

extends StandardRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.hssf.record.HSSFRecordTypes, .RecordInputStream, .StandardRecord, org.apache.poi.util.GenericRecordUtil, .LittleEndianOutput
The default data label text properties record identifies the text characteristics of the preceding text record.

Field Summary

Modifier and TypeField and Description
public static final short
CATEGORY_DATA_TYPE_ALL_TEXT_CHARACTERISTIC

public static final short
CATEGORY_DATA_TYPE_SHOW_LABELS_CHARACTERISTIC

public static final short
CATEGORY_DATA_TYPE_VALUE_AND_PERCENTAGE_CHARACTERISTIC

private short
field_1_categoryDataType

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
DefaultDataLabelTextPropertiesRecord()

public
DefaultDataLabelTextPropertiesRecord(DefaultDataLabelTextPropertiesRecord other)

public
DefaultDataLabelTextPropertiesRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public DefaultDataLabelTextPropertiesRecord
copy()

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

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

public short

Returns:

One of CATEGORY_DATA_TYPE_SHOW_LABELS_CHARACTERISTIC CATEGORY_DATA_TYPE_VALUE_AND_PERCENTAGE_CHARACTERISTIC CATEGORY_DATA_TYPE_ALL_TEXT_CHARACTERISTIC
getCategoryDataType()

Get the category data type field for the DefaultDataLabelTextProperties record.

protected int
getDataSize()

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

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

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

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

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
setCategoryDataType(short
One of CATEGORY_DATA_TYPE_SHOW_LABELS_CHARACTERISTIC CATEGORY_DATA_TYPE_VALUE_AND_PERCENTAGE_CHARACTERISTIC CATEGORY_DATA_TYPE_ALL_TEXT_CHARACTERISTIC
field_1_categoryDataType)

Set the category data type field for the DefaultDataLabelTextProperties record.

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

Field Detail

CATEGORY_DATA_TYPE_ALL_TEXT_CHARACTERISTICback to summary
public static final short CATEGORY_DATA_TYPE_ALL_TEXT_CHARACTERISTIC
CATEGORY_DATA_TYPE_SHOW_LABELS_CHARACTERISTICback to summary
public static final short CATEGORY_DATA_TYPE_SHOW_LABELS_CHARACTERISTIC
CATEGORY_DATA_TYPE_VALUE_AND_PERCENTAGE_CHARACTERISTICback to summary
public static final short CATEGORY_DATA_TYPE_VALUE_AND_PERCENTAGE_CHARACTERISTIC
field_1_categoryDataTypeback to summary
private short field_1_categoryDataType
sidback to summary
public static final short sid

Constructor Detail

DefaultDataLabelTextPropertiesRecordback to summary
public DefaultDataLabelTextPropertiesRecord()
DefaultDataLabelTextPropertiesRecordback to summary
public DefaultDataLabelTextPropertiesRecord(DefaultDataLabelTextPropertiesRecord other)
DefaultDataLabelTextPropertiesRecordback to summary
public DefaultDataLabelTextPropertiesRecord(RecordInputStream in)

Method Detail

copyback to summary
public DefaultDataLabelTextPropertiesRecord copy()

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

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

Returns:DefaultDataLabelTextPropertiesRecord

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

a deep copy of the implementing class / instance

Annotations
@Override
getCategoryDataTypeback to summary
public short getCategoryDataType()

Get the category data type field for the DefaultDataLabelTextProperties record.

Returns:short

One of CATEGORY_DATA_TYPE_SHOW_LABELS_CHARACTERISTIC CATEGORY_DATA_TYPE_VALUE_AND_PERCENTAGE_CHARACTERISTIC CATEGORY_DATA_TYPE_ALL_TEXT_CHARACTERISTIC

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

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

setCategoryDataTypeback to summary
public void setCategoryDataType(short field_1_categoryDataType)

Set the category data type field for the DefaultDataLabelTextProperties record.

Parameters
field_1_categoryDataType:short

One of CATEGORY_DATA_TYPE_SHOW_LABELS_CHARACTERISTIC CATEGORY_DATA_TYPE_VALUE_AND_PERCENTAGE_CHARACTERISTIC CATEGORY_DATA_TYPE_ALL_TEXT_CHARACTERISTIC