org.apache.poi.hssf.record
Class TextObjectRecord

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

public final class TextObjectRecord
extends Record

The TXO record (0x01B6) is used to define the properties of a text box. It is followed by two or more continue records unless there is no actual text. The first continue records contain the text data and the last continue record contains the formatting runs.

Author:
Glen Stampoultzis (glens at apache.org)

Field Summary
static short HORIZONTAL_TEXT_ALIGNMENT_CENTERED
           
static short HORIZONTAL_TEXT_ALIGNMENT_JUSTIFIED
           
static short HORIZONTAL_TEXT_ALIGNMENT_LEFT_ALIGNED
           
static short HORIZONTAL_TEXT_ALIGNMENT_RIGHT_ALIGNED
           
static short sid
           
static short TEXT_ORIENTATION_NONE
           
static short TEXT_ORIENTATION_ROT_LEFT
           
static short TEXT_ORIENTATION_ROT_RIGHT
           
static short TEXT_ORIENTATION_TOP_TO_BOTTOM
           
static short VERTICAL_TEXT_ALIGNMENT_BOTTOM
           
static short VERTICAL_TEXT_ALIGNMENT_CENTER
           
static short VERTICAL_TEXT_ALIGNMENT_JUSTIFY
           
static short VERTICAL_TEXT_ALIGNMENT_TOP
           
 
Constructor Summary
TextObjectRecord()
           
TextObjectRecord(RecordInputStream in)
           
 
Method Summary
 java.lang.Object clone()
           
 int getHorizontalTextAlignment()
           
 Ptg getLinkRefPtg()
           
 int getRecordSize()
          Note - this total size includes all potential ContinueRecords written
 short getSid()
          return the non static version of the id for this record.
 HSSFRichTextString getStr()
           
 int getTextOrientation()
          Get the text orientation field for the TextObjectBase record.
 int getVerticalTextAlignment()
           
 boolean isTextLocked()
           
 int serialize(int offset, byte[] data)
          called by the class that is responsible for writing this sucker.
 void setHorizontalTextAlignment(int value)
          Sets the Horizontal text alignment field value.
 void setStr(HSSFRichTextString str)
           
 void setTextLocked(boolean value)
          Sets the text locked field value.
 void setTextOrientation(int textOrientation)
          Set the text orientation field for the TextObjectBase record.
 void setVerticalTextAlignment(int value)
          Sets the Vertical text alignment field value.
 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

HORIZONTAL_TEXT_ALIGNMENT_LEFT_ALIGNED

public static final short HORIZONTAL_TEXT_ALIGNMENT_LEFT_ALIGNED
See Also:
Constant Field Values

HORIZONTAL_TEXT_ALIGNMENT_CENTERED

public static final short HORIZONTAL_TEXT_ALIGNMENT_CENTERED
See Also:
Constant Field Values

HORIZONTAL_TEXT_ALIGNMENT_RIGHT_ALIGNED

public static final short HORIZONTAL_TEXT_ALIGNMENT_RIGHT_ALIGNED
See Also:
Constant Field Values

HORIZONTAL_TEXT_ALIGNMENT_JUSTIFIED

public static final short HORIZONTAL_TEXT_ALIGNMENT_JUSTIFIED
See Also:
Constant Field Values

VERTICAL_TEXT_ALIGNMENT_TOP

public static final short VERTICAL_TEXT_ALIGNMENT_TOP
See Also:
Constant Field Values

VERTICAL_TEXT_ALIGNMENT_CENTER

public static final short VERTICAL_TEXT_ALIGNMENT_CENTER
See Also:
Constant Field Values

VERTICAL_TEXT_ALIGNMENT_BOTTOM

public static final short VERTICAL_TEXT_ALIGNMENT_BOTTOM
See Also:
Constant Field Values

VERTICAL_TEXT_ALIGNMENT_JUSTIFY

public static final short VERTICAL_TEXT_ALIGNMENT_JUSTIFY
See Also:
Constant Field Values

TEXT_ORIENTATION_NONE

public static final short TEXT_ORIENTATION_NONE
See Also:
Constant Field Values

TEXT_ORIENTATION_TOP_TO_BOTTOM

public static final short TEXT_ORIENTATION_TOP_TO_BOTTOM
See Also:
Constant Field Values

TEXT_ORIENTATION_ROT_RIGHT

public static final short TEXT_ORIENTATION_ROT_RIGHT
See Also:
Constant Field Values

TEXT_ORIENTATION_ROT_LEFT

public static final short TEXT_ORIENTATION_ROT_LEFT
See Also:
Constant Field Values
Constructor Detail

TextObjectRecord

public TextObjectRecord()

TextObjectRecord

public TextObjectRecord(RecordInputStream in)
Method Detail

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

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()
Note - this total size includes all potential ContinueRecords written

Overrides:
getRecordSize in class Record

setHorizontalTextAlignment

public void setHorizontalTextAlignment(int value)
Sets the Horizontal text alignment field value.


getHorizontalTextAlignment

public int getHorizontalTextAlignment()
Returns:
the Horizontal text alignment field value.

setVerticalTextAlignment

public void setVerticalTextAlignment(int value)
Sets the Vertical text alignment field value.


getVerticalTextAlignment

public int getVerticalTextAlignment()
Returns:
the Vertical text alignment field value.

setTextLocked

public void setTextLocked(boolean value)
Sets the text locked field value.


isTextLocked

public boolean isTextLocked()
Returns:
the text locked field value.

getTextOrientation

public int getTextOrientation()
Get the text orientation field for the TextObjectBase record.

Returns:
One of TEXT_ORIENTATION_NONE TEXT_ORIENTATION_TOP_TO_BOTTOM TEXT_ORIENTATION_ROT_RIGHT TEXT_ORIENTATION_ROT_LEFT

setTextOrientation

public void setTextOrientation(int textOrientation)
Set the text orientation field for the TextObjectBase record.

Parameters:
textOrientation - One of TEXT_ORIENTATION_NONE TEXT_ORIENTATION_TOP_TO_BOTTOM TEXT_ORIENTATION_ROT_RIGHT TEXT_ORIENTATION_ROT_LEFT

getStr

public HSSFRichTextString getStr()

setStr

public void setStr(HSSFRichTextString str)

getLinkRefPtg

public Ptg getLinkRefPtg()

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

clone

public java.lang.Object clone()
Overrides:
clone in class Record


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