loci.poi.hssf.record

Class TextObjectRecord

java.lang.Object

loci.poi.hssf.record.Record

loci.poi.hssf.record.TextObjectBaseRecord

loci.poi.hssf.record.TextObjectRecord

public class TextObjectRecord
extends TextObjectBaseRecord

Field Summary

Fields inherited from class loci.poi.hssf.record.TextObjectBaseRecord

HORIZONTAL_TEXT_ALIGNMENT_CENTERED, HORIZONTAL_TEXT_ALIGNMENT_JUSTIFIED, HORIZONTAL_TEXT_ALIGNMENT_LEFT_ALIGNED, HORIZONTAL_TEXT_ALIGNMENT_RIGHT_ALIGNED, sid, TEXT_ORIENTATION_NONE, TEXT_ORIENTATION_ROT_LEFT, TEXT_ORIENTATION_ROT_RIGHT, TEXT_ORIENTATION_TOP_TO_BOTTOM, VERTICAL_TEXT_ALIGNMENT_BOTTOM, VERTICAL_TEXT_ALIGNMENT_CENTER, VERTICAL_TEXT_ALIGNMENT_JUSTIFY, VERTICAL_TEXT_ALIGNMENT_TOP

Constructor Summary

Constructors

Constructor and Description
TextObjectRecord()
TextObjectRecord(RecordInputStream in)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	fillFields(RecordInputStream in) called by the constructor, should set class level fields.
int	getRecordSize() Size of record (exluding 4 byte header)
HSSFRichTextString	getStr()
int	serialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.
void	setStr(HSSFRichTextString str)
String	toString() get a string representation of the record (for biffview/debugging)

Methods inherited from class loci.poi.hssf.record.TextObjectBaseRecord

clone, getFormattingRunLength, getHorizontalTextAlignment, getOptions, getReserved2, getReserved3, getReserved4, getReserved5, getReserved6, getReserved7, getSid, getTextLength, getTextOrientation, getVerticalTextAlignment, isReserved1, isTextLocked, setFormattingRunLength, setHorizontalTextAlignment, setOptions, setReserved1, setReserved2, setReserved3, setReserved4, setReserved5, setReserved6, setReserved7, setTextLength, setTextLocked, setTextOrientation, setVerticalTextAlignment, validateSid

Methods inherited from class loci.poi.hssf.record.Record

isInValueSection, isValue, serialize

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TextObjectRecord

public TextObjectRecord()

TextObjectRecord

public TextObjectRecord(RecordInputStream in)

Method Detail

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.

Overrides:

fillFields in class TextObjectBaseRecord

Parameters:

in - the RecordInputstream to read the record from

getRecordSize

public int getRecordSize()

Description copied from class: TextObjectBaseRecord

Size of record (exluding 4 byte header)

Overrides:

getRecordSize in class TextObjectBaseRecord

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.

Overrides:

serialize in class TextObjectBaseRecord

Parameters:

offset - to begin writing at

data - byte array containing instance data

Returns:

number of bytes written

getStr

public HSSFRichTextString getStr()

setStr

public void setStr(HSSFRichTextString str)

toString

public String toString()

Description copied from class: Record

get a string representation of the record (for biffview/debugging)

Overrides:

toString in class TextObjectBaseRecord