Package org.apache.poi.hssf.record
Class TextObjectRecord
java.lang.Object
org.apache.poi.hssf.record.RecordBase
org.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.cont.ContinuableRecord
org.apache.poi.hssf.record.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
FieldsModifier and TypeFieldDescriptionstatic final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
int
short
getSid()
return the non static version of the id for this record.getStr()
int
Get the text orientation field for the TextObjectBase record.int
boolean
protected void
Serializes this record's content to the supplied data output.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.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
-
Field Details
-
sid
public static final short sid- See Also:
-
HORIZONTAL_TEXT_ALIGNMENT_LEFT_ALIGNED
public static final short HORIZONTAL_TEXT_ALIGNMENT_LEFT_ALIGNED- See Also:
-
HORIZONTAL_TEXT_ALIGNMENT_CENTERED
public static final short HORIZONTAL_TEXT_ALIGNMENT_CENTERED- See Also:
-
HORIZONTAL_TEXT_ALIGNMENT_RIGHT_ALIGNED
public static final short HORIZONTAL_TEXT_ALIGNMENT_RIGHT_ALIGNED- See Also:
-
HORIZONTAL_TEXT_ALIGNMENT_JUSTIFIED
public static final short HORIZONTAL_TEXT_ALIGNMENT_JUSTIFIED- See Also:
-
VERTICAL_TEXT_ALIGNMENT_TOP
public static final short VERTICAL_TEXT_ALIGNMENT_TOP- See Also:
-
VERTICAL_TEXT_ALIGNMENT_CENTER
public static final short VERTICAL_TEXT_ALIGNMENT_CENTER- See Also:
-
VERTICAL_TEXT_ALIGNMENT_BOTTOM
public static final short VERTICAL_TEXT_ALIGNMENT_BOTTOM- See Also:
-
VERTICAL_TEXT_ALIGNMENT_JUSTIFY
public static final short VERTICAL_TEXT_ALIGNMENT_JUSTIFY- See Also:
-
TEXT_ORIENTATION_NONE
public static final short TEXT_ORIENTATION_NONE- See Also:
-
TEXT_ORIENTATION_TOP_TO_BOTTOM
public static final short TEXT_ORIENTATION_TOP_TO_BOTTOM- See Also:
-
TEXT_ORIENTATION_ROT_RIGHT
public static final short TEXT_ORIENTATION_ROT_RIGHT- See Also:
-
TEXT_ORIENTATION_ROT_LEFT
public static final short TEXT_ORIENTATION_ROT_LEFT- See Also:
-
-
Constructor Details
-
TextObjectRecord
public TextObjectRecord() -
TextObjectRecord
-
-
Method Details
-
getSid
public short getSid()Description copied from class:Record
return the non static version of the id for this record. -
serialize
Description copied from class:ContinuableRecord
Serializes this record's content to the supplied data output.The standard BIFF header (ushort sid, ushort size) has been handled by the superclass, so only BIFF data should be written by this method. Simple data types can be written with the standard
LittleEndianOutput
methods. Methods fromContinuableRecordOutput
can be used to serialize strings (withContinueRecord
s being written as required). If necessary, implementors can explicitly startContinueRecord
s (regardless of the amount of remaining space).- Specified by:
serialize
in classContinuableRecord
- Parameters:
out
- a data output stream
-
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
-
setStr
-
getLinkRefPtg
-
toString
Description copied from class:Record
get a string representation of the record (for biffview/debugging) -
clone
-