FileDocCategorySizeDatePackage
DefaultDataLabelTextPropertiesRecord.javaAPI DocApache Poi 3.0.14935Mon Jan 01 12:39:40 GMT 2007org.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)

Fields Summary
public static final short
sid
private short
field_1_categoryDataType
public static final short
CATEGORY_DATA_TYPE_SHOW_LABELS_CHARACTERISTIC
public static final short
CATEGORY_DATA_TYPE_VALUE_AND_PERCENTAGE_CHARACTERISTIC
public static final short
CATEGORY_DATA_TYPE_ALL_TEXT_CHARACTERISTIC
Constructors Summary
public DefaultDataLabelTextPropertiesRecord()
public DefaultDataLabelTextPropertiesRecord(RecordInputStream in)
Constructs a DefaultDataLabelTextProperties record and sets its fields appropriately.

param
id id must be 0x1024 or an exception will be throw upon validation
param
size size the size of the data area of the record
param
data data of the record (should not contain sid/len)

        super(in);
Methods Summary
public java.lang.Objectclone()

        DefaultDataLabelTextPropertiesRecord rec = new DefaultDataLabelTextPropertiesRecord();
    
        rec.field_1_categoryDataType = field_1_categoryDataType;
        return rec;
protected voidfillFields(org.apache.poi.hssf.record.RecordInputStream in)

        field_1_categoryDataType       = in.readShort();
public shortgetCategoryDataType()
Get the category data type field for the DefaultDataLabelTextProperties record.

return
One of CATEGORY_DATA_TYPE_SHOW_LABELS_CHARACTERISTIC CATEGORY_DATA_TYPE_VALUE_AND_PERCENTAGE_CHARACTERISTIC CATEGORY_DATA_TYPE_ALL_TEXT_CHARACTERISTIC

        return field_1_categoryDataType;
public intgetRecordSize()
Size of record (exluding 4 byte header)

        return 4  + 2;
public shortgetSid()

        return sid;
public intserialize(int offset, byte[] data)

        int pos = 0;

        LittleEndian.putShort(data, 0 + offset, sid);
        LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4));

        LittleEndian.putShort(data, 4 + offset + pos, field_1_categoryDataType);

        return getRecordSize();
public voidsetCategoryDataType(short field_1_categoryDataType)
Set the category data type field for the DefaultDataLabelTextProperties record.

param
field_1_categoryDataType One of CATEGORY_DATA_TYPE_SHOW_LABELS_CHARACTERISTIC CATEGORY_DATA_TYPE_VALUE_AND_PERCENTAGE_CHARACTERISTIC CATEGORY_DATA_TYPE_ALL_TEXT_CHARACTERISTIC

        this.field_1_categoryDataType = field_1_categoryDataType;
public java.lang.StringtoString()

        StringBuffer buffer = new StringBuffer();

        buffer.append("[DEFAULTTEXT]\n");
        buffer.append("    .categoryDataType     = ")
            .append("0x").append(HexDump.toHex(  getCategoryDataType ()))
            .append(" (").append( getCategoryDataType() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 

        buffer.append("[/DEFAULTTEXT]\n");
        return buffer.toString();
protected voidvalidateSid(short id)
Checks the sid matches the expected side for this record

param
id the expected sid.

        if (id != sid)
        {
            throw new RecordFormatException("Not a DefaultDataLabelTextProperties record");
        }