org.apache.poi.hssf.record
Class SeriesTextRecord

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

public final class SeriesTextRecord
extends Record

Defines a series name

Author:
Andrew C. Oliver (acoliver at apache.org)

Field Summary
static short sid
           
 
Constructor Summary
SeriesTextRecord()
           
SeriesTextRecord(RecordInputStream in)
           
 
Method Summary
 java.lang.Object clone()
           
 short getId()
          Get the id field for the SeriesText record.
 int getRecordSize()
          gives the current serialized size of the record.
 short getSid()
          return the non static version of the id for this record.
 java.lang.String getText()
          Get the text field for the SeriesText record.
 int getTextLength()
          Get the text length field for the SeriesText record.
 byte getUndocumented()
          Get the undocumented field for the SeriesText record.
 int serialize(int offset, byte[] data)
          called by the class that is responsible for writing this sucker.
 void setId(short field_1_id)
          Set the id field for the SeriesText record.
 void setText(java.lang.String field_4_text)
          Set the text field for the SeriesText record.
 void setTextLength(byte field_2_textLength)
          Set the text length field for the SeriesText record.
 void setTextLength(int field_2_textLength)
          Set the text length field for the SeriesText record.
 void setUndocumented(byte field_3_undocumented)
          Set the undocumented field for the SeriesText 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
Constructor Detail

SeriesTextRecord

public SeriesTextRecord()

SeriesTextRecord

public SeriesTextRecord(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

getId

public short getId()
Get the id field for the SeriesText record.


setId

public void setId(short field_1_id)
Set the id field for the SeriesText record.


getTextLength

public int getTextLength()
Get the text length field for the SeriesText record.


setTextLength

public void setTextLength(byte field_2_textLength)
Set the text length field for the SeriesText record. Needs to be wrapped.


setTextLength

public void setTextLength(int field_2_textLength)
Set the text length field for the SeriesText record.


getUndocumented

public byte getUndocumented()
Get the undocumented field for the SeriesText record.


setUndocumented

public void setUndocumented(byte field_3_undocumented)
Set the undocumented field for the SeriesText record.


getText

public java.lang.String getText()
Get the text field for the SeriesText record.


setText

public void setText(java.lang.String field_4_text)
Set the text field for the SeriesText record.



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