org.apache.poi.hssf.record
Class DefaultDataLabelTextPropertiesRecord

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

public class DefaultDataLabelTextPropertiesRecord
extends Record

The default data label text properties record identifies the text characteristics of the preceeding text record. NOTE: This source is automatically generated please do not modify this file. Either subclass or remove the record in src/records/definitions.

Author:

Glen Stampoultzis (glens at apache.org)

Field Summary

static short	CATEGORY_DATA_TYPE_ALL_TEXT_CHARACTERISTIC
static short	CATEGORY_DATA_TYPE_SHOW_LABELS_CHARACTERISTIC
static short	CATEGORY_DATA_TYPE_VALUE_AND_PERCENTAGE_CHARACTERISTIC
static short	sid

Constructor Summary

DefaultDataLabelTextPropertiesRecord()

DefaultDataLabelTextPropertiesRecord(RecordInputStream in)
Constructs a DefaultDataLabelTextProperties 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.
short	getCategoryDataType() Get the category data type field for the DefaultDataLabelTextProperties record.
int	getRecordSize() Size of record (exluding 4 byte header)
short	getSid() return the non static version of the id for this record.
int	serialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.
void	setCategoryDataType(short field_1_categoryDataType) Set the category data type field for the DefaultDataLabelTextProperties record.
java.lang.String	toString() get a string representation of the record (for biffview/debugging)
protected void	validateSid(short id) Checks the sid matches the expected side for this record

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

CATEGORY_DATA_TYPE_SHOW_LABELS_CHARACTERISTIC

public static final short CATEGORY_DATA_TYPE_SHOW_LABELS_CHARACTERISTIC

See Also:

Constant Field Values

CATEGORY_DATA_TYPE_VALUE_AND_PERCENTAGE_CHARACTERISTIC

public static final short CATEGORY_DATA_TYPE_VALUE_AND_PERCENTAGE_CHARACTERISTIC

See Also:

Constant Field Values

CATEGORY_DATA_TYPE_ALL_TEXT_CHARACTERISTIC

public static final short CATEGORY_DATA_TYPE_ALL_TEXT_CHARACTERISTIC

See Also:

Constant Field Values

Constructor Detail

DefaultDataLabelTextPropertiesRecord

public DefaultDataLabelTextPropertiesRecord()

DefaultDataLabelTextPropertiesRecord

public DefaultDataLabelTextPropertiesRecord(RecordInputStream in)

Constructs a DefaultDataLabelTextProperties record and sets its fields appropriately.

Parameters:

in - the RecordInputstream to read the record from

Method Detail

validateSid

protected void validateSid(short id)

Checks the sid matches the expected side for this record

Specified by:

validateSid in class Record

Parameters:

id - the expected sid.

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

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

Size of record (exluding 4 byte header)

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

getCategoryDataType

public short getCategoryDataType()

Get the category data type field for the DefaultDataLabelTextProperties record.

Returns:

One of CATEGORY_DATA_TYPE_SHOW_LABELS_CHARACTERISTIC CATEGORY_DATA_TYPE_VALUE_AND_PERCENTAGE_CHARACTERISTIC CATEGORY_DATA_TYPE_ALL_TEXT_CHARACTERISTIC

setCategoryDataType

public void setCategoryDataType(short field_1_categoryDataType)

Set the category data type field for the DefaultDataLabelTextProperties record.

Parameters:

field_1_categoryDataType - One of CATEGORY_DATA_TYPE_SHOW_LABELS_CHARACTERISTIC CATEGORY_DATA_TYPE_VALUE_AND_PERCENTAGE_CHARACTERISTIC CATEGORY_DATA_TYPE_ALL_TEXT_CHARACTERISTIC