Package loci.poi.hssf.record
Class TextObjectBaseRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.TextObjectBaseRecord
- Direct Known Subclasses:
TextObjectRecord
The TXO record is used to define the properties of a text box. It is followed
by two continue records unless there is no actual text. The first continue record contains
the text data and the next continue record contains the formatting runs.
NOTE: This source is automatically generated please do not modify this file. Either subclass or
remove the record in src/records/definitions.
- Author:
- Glen Stampoultzis (glens at apache.org)
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final short -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a TextObjectBase record and sets its fields appropriately. -
Method Summary
Modifier and TypeMethodDescriptionclone()protected voidcalled by the constructor, should set class level fields.shortGet the formatting run length field for the TextObjectBase record.shortshortGet the options field for the TextObjectBase record.intSize of record (exluding 4 byte header)shortshortshortGet the reserved4 field for the TextObjectBase record.shortGet the reserved5 field for the TextObjectBase record.shortGet the reserved6 field for the TextObjectBase record.intGet the reserved7 field for the TextObjectBase record.shortgetSid()return the non static version of the id for this record.shortGet the text length field for the TextObjectBase record.shortGet the text orientation field for the TextObjectBase record.shortbooleanreserved fieldbooleanText has been lockedintserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.voidsetFormattingRunLength(short field_7_formattingRunLength) Set the formatting run length field for the TextObjectBase record.voidsetHorizontalTextAlignment(short value) Sets the Horizontal text alignment field value.voidsetOptions(short field_1_options) Set the options field for the TextObjectBase record.voidsetReserved1(boolean value) Sets the reserved1 field value.voidsetReserved2(short value) Sets the reserved2 field value.voidsetReserved3(short value) Sets the reserved3 field value.voidsetReserved4(short field_3_reserved4) Set the reserved4 field for the TextObjectBase record.voidsetReserved5(short field_4_reserved5) Set the reserved5 field for the TextObjectBase record.voidsetReserved6(short field_5_reserved6) Set the reserved6 field for the TextObjectBase record.voidsetReserved7(int field_8_reserved7) Set the reserved7 field for the TextObjectBase record.voidsetTextLength(short field_6_textLength) Set the text length field for the TextObjectBase record.voidsetTextLocked(boolean value) Sets the text locked field value.voidsetTextOrientation(short field_2_textOrientation) Set the text orientation field for the TextObjectBase record.voidsetVerticalTextAlignment(short value) Sets the Vertical text alignment field value.toString()get a string representation of the record (for biffview/debugging)protected voidvalidateSid(short id) Checks the sid matches the expected side for this recordMethods inherited from class loci.poi.hssf.record.Record
isInValueSection, isValue, 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
-
TextObjectBaseRecord
public TextObjectBaseRecord() -
TextObjectBaseRecord
Constructs a TextObjectBase record and sets its fields appropriately.- Parameters:
in- the RecordInputstream to read the record from
-
-
Method Details
-
validateSid
protected void validateSid(short id) Checks the sid matches the expected side for this record- Specified by:
validateSidin classRecord- Parameters:
id- the expected sid.
-
fillFields
Description copied from class:Recordcalled by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.- Specified by:
fillFieldsin classRecord- Parameters:
in- the RecordInputstream to read the record from
-
toString
Description copied from class:Recordget a string representation of the record (for biffview/debugging) -
serialize
public int serialize(int offset, byte[] data) Description copied from class:Recordcalled 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. -
getRecordSize
public int getRecordSize()Size of record (exluding 4 byte header)- Overrides:
getRecordSizein classRecord
-
getSid
public short getSid()Description copied from class:Recordreturn the non static version of the id for this record. -
clone
-
getOptions
public short getOptions()Get the options field for the TextObjectBase record. -
setOptions
public void setOptions(short field_1_options) Set the options field for the TextObjectBase record. -
getTextOrientation
public short 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(short field_2_textOrientation) Set the text orientation field for the TextObjectBase record.- Parameters:
field_2_textOrientation- One of TEXT_ORIENTATION_NONE TEXT_ORIENTATION_TOP_TO_BOTTOM TEXT_ORIENTATION_ROT_RIGHT TEXT_ORIENTATION_ROT_LEFT
-
getReserved4
public short getReserved4()Get the reserved4 field for the TextObjectBase record. -
setReserved4
public void setReserved4(short field_3_reserved4) Set the reserved4 field for the TextObjectBase record. -
getReserved5
public short getReserved5()Get the reserved5 field for the TextObjectBase record. -
setReserved5
public void setReserved5(short field_4_reserved5) Set the reserved5 field for the TextObjectBase record. -
getReserved6
public short getReserved6()Get the reserved6 field for the TextObjectBase record. -
setReserved6
public void setReserved6(short field_5_reserved6) Set the reserved6 field for the TextObjectBase record. -
getTextLength
public short getTextLength()Get the text length field for the TextObjectBase record. -
setTextLength
public void setTextLength(short field_6_textLength) Set the text length field for the TextObjectBase record. -
getFormattingRunLength
public short getFormattingRunLength()Get the formatting run length field for the TextObjectBase record. -
setFormattingRunLength
public void setFormattingRunLength(short field_7_formattingRunLength) Set the formatting run length field for the TextObjectBase record. -
getReserved7
public int getReserved7()Get the reserved7 field for the TextObjectBase record. -
setReserved7
public void setReserved7(int field_8_reserved7) Set the reserved7 field for the TextObjectBase record. -
setReserved1
public void setReserved1(boolean value) Sets the reserved1 field value. reserved field -
isReserved1
public boolean isReserved1()reserved field- Returns:
- the reserved1 field value.
-
setHorizontalTextAlignment
public void setHorizontalTextAlignment(short value) Sets the Horizontal text alignment field value. -
getHorizontalTextAlignment
public short getHorizontalTextAlignment()- Returns:
- the Horizontal text alignment field value.
-
setVerticalTextAlignment
public void setVerticalTextAlignment(short value) Sets the Vertical text alignment field value. -
getVerticalTextAlignment
public short getVerticalTextAlignment()- Returns:
- the Vertical text alignment field value.
-
setReserved2
public void setReserved2(short value) Sets the reserved2 field value. -
getReserved2
public short getReserved2()- Returns:
- the reserved2 field value.
-
setTextLocked
public void setTextLocked(boolean value) Sets the text locked field value. Text has been locked -
isTextLocked
public boolean isTextLocked()Text has been locked- Returns:
- the text locked field value.
-
setReserved3
public void setReserved3(short value) Sets the reserved3 field value. -
getReserved3
public short getReserved3()- Returns:
- the reserved3 field value.
-