|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.poi.hssf.record.RecordBase
org.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.cont.ContinuableRecord
org.apache.poi.hssf.record.TextObjectRecord
public final class TextObjectRecord
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.
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()
|
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()
|
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.cont.ContinuableRecord |
---|
getRecordSize, serialize |
Methods inherited from class org.apache.poi.hssf.record.Record |
---|
cloneViaReserialise, serialize |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final short sid
public static final short HORIZONTAL_TEXT_ALIGNMENT_LEFT_ALIGNED
public static final short HORIZONTAL_TEXT_ALIGNMENT_CENTERED
public static final short HORIZONTAL_TEXT_ALIGNMENT_RIGHT_ALIGNED
public static final short HORIZONTAL_TEXT_ALIGNMENT_JUSTIFIED
public static final short VERTICAL_TEXT_ALIGNMENT_TOP
public static final short VERTICAL_TEXT_ALIGNMENT_CENTER
public static final short VERTICAL_TEXT_ALIGNMENT_BOTTOM
public static final short VERTICAL_TEXT_ALIGNMENT_JUSTIFY
public static final short TEXT_ORIENTATION_NONE
public static final short TEXT_ORIENTATION_TOP_TO_BOTTOM
public static final short TEXT_ORIENTATION_ROT_RIGHT
public static final short TEXT_ORIENTATION_ROT_LEFT
Constructor Detail |
---|
public TextObjectRecord()
public TextObjectRecord(RecordInputStream in)
Method Detail |
---|
public short getSid()
Record
getSid
in class Record
public void setHorizontalTextAlignment(int value)
public int getHorizontalTextAlignment()
public void setVerticalTextAlignment(int value)
public int getVerticalTextAlignment()
public void setTextLocked(boolean value)
public boolean isTextLocked()
public int getTextOrientation()
public void setTextOrientation(int textOrientation)
textOrientation
- One of TEXT_ORIENTATION_NONE TEXT_ORIENTATION_TOP_TO_BOTTOM
TEXT_ORIENTATION_ROT_RIGHT TEXT_ORIENTATION_ROT_LEFTpublic HSSFRichTextString getStr()
public void setStr(HSSFRichTextString str)
public Ptg getLinkRefPtg()
public java.lang.String toString()
Record
toString
in class Record
public java.lang.Object clone()
clone
in class Record
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |