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

public final Class SeriesTextRecord

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, .StringUtil
SERIESTEXT (0x100D)

Defines a series name

Field Summary

Modifier and TypeField and Description
private int
field_1_id

private String
field_4_text

private boolean
is16bit

private static final int
MAX_LEN

the actual text cannot be longer than 255 characters

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
SeriesTextRecord()

public
SeriesTextRecord(SeriesTextRecord other)

public
SeriesTextRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public SeriesTextRecord
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 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
getId()

Get the id field for the SeriesText 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 String
getText()

Get the text field for the SeriesText 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
setId(int id)

Set the id field for the SeriesText record.

public void
setText(String text)

Set the text field for the SeriesText record.

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

Field Detail

field_1_idback to summary
private int field_1_id
field_4_textback to summary
private String field_4_text
is16bitback to summary
private boolean is16bit
MAX_LENback to summary
private static final int MAX_LEN

the actual text cannot be longer than 255 characters

sidback to summary
public static final short sid

Constructor Detail

SeriesTextRecordback to summary
public SeriesTextRecord()
SeriesTextRecordback to summary
public SeriesTextRecord(SeriesTextRecord other)
SeriesTextRecordback to summary
public SeriesTextRecord(RecordInputStream in)

Method Detail

copyback to summary
public SeriesTextRecord copy()

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

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

Returns:SeriesTextRecord

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
getIdback to summary
public int getId()

Get the id field for the SeriesText 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

getTextback to summary
public String getText()

Get the text field for the SeriesText 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

setIdback to summary
public void setId(int id)

Set the id field for the SeriesText record.

setTextback to summary
public void setText(String text)

Set the text field for the SeriesText record.