org.apache.poi.hssf.record
Class DefaultDataLabelTextPropertiesRecord

java.lang.Object
  extended by org.apache.poi.hssf.record.RecordBase
      extended by org.apache.poi.hssf.record.Record
          extended by org.apache.poi.hssf.record.DefaultDataLabelTextPropertiesRecord

public final class DefaultDataLabelTextPropertiesRecord
extends Record

The default data label text properties record identifies the text characteristics of the preceding text record.

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)
           
 
Method Summary
 java.lang.Object clone()
           
 short getCategoryDataType()
          Get the category data type field for the DefaultDataLabelTextProperties record.
 int getRecordSize()
          gives the current serialized size of the record.
 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)
 
Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, 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)
Method Detail

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: RecordBase
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 RecordBase
Parameters:
offset - to begin writing at
data - byte array containing instance data
Returns:
number of bytes written

getRecordSize

public int getRecordSize()
Description copied from class: Record
gives the current serialized size of the record. Should include the sid and reclength (4 bytes).

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


Copyright 2008 The Apache Software Foundation or its licensors, as applicable.