Package loci.poi.hssf.record
Class TextRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.TextRecord
The text record is used to define text stored on a chart.
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 shortstatic final bytestatic final bytestatic final bytestatic final bytestatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final bytestatic final bytestatic final bytestatic final byte -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a Text record and sets its fields appropriately. -
Method Summary
Modifier and TypeMethodDescriptionclone()protected voidcalled by the constructor, should set class level fields.shortshortGet the display mode field for the Text record.intGet the height field for the Text record.byteGet the horizontal alignment field for the Text record.shortGet the index of color value field for the Text record.shortGet the options1 field for the Text record.shortGet the options2 field for the Text record.intSize of record (exluding 4 byte header)intGet the rgbColor field for the Text record.shortshortgetSid()return the non static version of the id for this record.shortGet the text rotation field for the Text record.byteGet the vertical alignment field for the Text record.intgetWidth()Get the width field for the Text record.intgetX()Get the x field for the Text record.intgetY()Get the y field for the Text record.booleanbooleantrue = automaticly selected colour, false = user-selectedbooleanbooleanbooleanbooleanbooleanbooleantrue = draw legendbooleanbooleanfalse = text is category labelbooleanbooleantrue = text is verticalintserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.voidsetAutoBackground(boolean value) Sets the auto background field value.voidsetAutoColor(boolean value) Sets the auto color field value.voidsetAutoGeneratedText(boolean value) Sets the auto generated text field value.voidsetAutoLabelDeleted(boolean value) Sets the auto label deleted field value.voidsetDataLabelPlacement(short value) Sets the data label placement field value.voidsetDisplayMode(short field_3_displayMode) Set the display mode field for the Text record.voidsetGenerated(boolean value) Sets the generated field value.voidsetHeight(int field_8_height) Set the height field for the Text record.voidsetHorizontalAlignment(byte field_1_horizontalAlignment) Set the horizontal alignment field for the Text record.voidsetIndexOfColorValue(short field_10_indexOfColorValue) Set the index of color value field for the Text record.voidsetOptions1(short field_9_options1) Set the options1 field for the Text record.voidsetOptions2(short field_11_options2) Set the options2 field for the Text record.voidsetRgbColor(int field_4_rgbColor) Set the rgbColor field for the Text record.voidsetRotation(short value) Sets the rotation field value.voidsetShowBubbleSizes(boolean value) Sets the show bubble sizes field value.voidsetShowCategoryLabelAsPercentage(boolean value) Sets the show category label as percentage field value.voidsetShowKey(boolean value) Sets the show key field value.voidsetShowLabel(boolean value) Sets the show label field value.voidsetShowValue(boolean value) Sets the show value field value.voidsetShowValueAsPercentage(boolean value) Sets the show value as percentage field value.voidsetTextRotation(short field_12_textRotation) Set the text rotation field for the Text record.voidsetVertical(boolean value) Sets the vertical field value.voidsetVerticalAlignment(byte field_2_verticalAlignment) Set the vertical alignment field for the Text record.voidsetWidth(int field_7_width) Set the width field for the Text record.voidsetX(int field_5_x) Set the x field for the Text record.voidsetY(int field_6_y) Set the y field for the Text record.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_ALIGNMENT_LEFT
public static final byte HORIZONTAL_ALIGNMENT_LEFT- See Also:
-
HORIZONTAL_ALIGNMENT_CENTER
public static final byte HORIZONTAL_ALIGNMENT_CENTER- See Also:
-
HORIZONTAL_ALIGNMENT_BOTTOM
public static final byte HORIZONTAL_ALIGNMENT_BOTTOM- See Also:
-
HORIZONTAL_ALIGNMENT_JUSTIFY
public static final byte HORIZONTAL_ALIGNMENT_JUSTIFY- See Also:
-
VERTICAL_ALIGNMENT_TOP
public static final byte VERTICAL_ALIGNMENT_TOP- See Also:
-
VERTICAL_ALIGNMENT_CENTER
public static final byte VERTICAL_ALIGNMENT_CENTER- See Also:
-
VERTICAL_ALIGNMENT_BOTTOM
public static final byte VERTICAL_ALIGNMENT_BOTTOM- See Also:
-
VERTICAL_ALIGNMENT_JUSTIFY
public static final byte VERTICAL_ALIGNMENT_JUSTIFY- See Also:
-
DISPLAY_MODE_TRANSPARENT
public static final short DISPLAY_MODE_TRANSPARENT- See Also:
-
DISPLAY_MODE_OPAQUE
public static final short DISPLAY_MODE_OPAQUE- See Also:
-
ROTATION_NONE
public static final short ROTATION_NONE- See Also:
-
ROTATION_TOP_TO_BOTTOM
public static final short ROTATION_TOP_TO_BOTTOM- See Also:
-
ROTATION_ROTATED_90_DEGREES
public static final short ROTATION_ROTATED_90_DEGREES- See Also:
-
ROTATION_ROTATED_90_DEGREES_CLOCKWISE
public static final short ROTATION_ROTATED_90_DEGREES_CLOCKWISE- See Also:
-
DATA_LABEL_PLACEMENT_CHART_DEPENDENT
public static final short DATA_LABEL_PLACEMENT_CHART_DEPENDENT- See Also:
-
DATA_LABEL_PLACEMENT_OUTSIDE
public static final short DATA_LABEL_PLACEMENT_OUTSIDE- See Also:
-
DATA_LABEL_PLACEMENT_INSIDE
public static final short DATA_LABEL_PLACEMENT_INSIDE- See Also:
-
DATA_LABEL_PLACEMENT_CENTER
public static final short DATA_LABEL_PLACEMENT_CENTER- See Also:
-
DATA_LABEL_PLACEMENT_AXIS
public static final short DATA_LABEL_PLACEMENT_AXIS- See Also:
-
DATA_LABEL_PLACEMENT_ABOVE
public static final short DATA_LABEL_PLACEMENT_ABOVE- See Also:
-
DATA_LABEL_PLACEMENT_BELOW
public static final short DATA_LABEL_PLACEMENT_BELOW- See Also:
-
DATA_LABEL_PLACEMENT_LEFT
public static final short DATA_LABEL_PLACEMENT_LEFT- See Also:
-
DATA_LABEL_PLACEMENT_RIGHT
public static final short DATA_LABEL_PLACEMENT_RIGHT- See Also:
-
DATA_LABEL_PLACEMENT_AUTO
public static final short DATA_LABEL_PLACEMENT_AUTO- See Also:
-
DATA_LABEL_PLACEMENT_USER_MOVED
public static final short DATA_LABEL_PLACEMENT_USER_MOVED- See Also:
-
-
Constructor Details
-
TextRecord
public TextRecord() -
TextRecord
Constructs a Text 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
-
getHorizontalAlignment
public byte getHorizontalAlignment()Get the horizontal alignment field for the Text record.- Returns:
- One of HORIZONTAL_ALIGNMENT_LEFT HORIZONTAL_ALIGNMENT_CENTER HORIZONTAL_ALIGNMENT_BOTTOM HORIZONTAL_ALIGNMENT_JUSTIFY
-
setHorizontalAlignment
public void setHorizontalAlignment(byte field_1_horizontalAlignment) Set the horizontal alignment field for the Text record.- Parameters:
field_1_horizontalAlignment- One of HORIZONTAL_ALIGNMENT_LEFT HORIZONTAL_ALIGNMENT_CENTER HORIZONTAL_ALIGNMENT_BOTTOM HORIZONTAL_ALIGNMENT_JUSTIFY
-
getVerticalAlignment
public byte getVerticalAlignment()Get the vertical alignment field for the Text record.- Returns:
- One of VERTICAL_ALIGNMENT_TOP VERTICAL_ALIGNMENT_CENTER VERTICAL_ALIGNMENT_BOTTOM VERTICAL_ALIGNMENT_JUSTIFY
-
setVerticalAlignment
public void setVerticalAlignment(byte field_2_verticalAlignment) Set the vertical alignment field for the Text record.- Parameters:
field_2_verticalAlignment- One of VERTICAL_ALIGNMENT_TOP VERTICAL_ALIGNMENT_CENTER VERTICAL_ALIGNMENT_BOTTOM VERTICAL_ALIGNMENT_JUSTIFY
-
getDisplayMode
public short getDisplayMode()Get the display mode field for the Text record.- Returns:
- One of DISPLAY_MODE_TRANSPARENT DISPLAY_MODE_OPAQUE
-
setDisplayMode
public void setDisplayMode(short field_3_displayMode) Set the display mode field for the Text record.- Parameters:
field_3_displayMode- One of DISPLAY_MODE_TRANSPARENT DISPLAY_MODE_OPAQUE
-
getRgbColor
public int getRgbColor()Get the rgbColor field for the Text record. -
setRgbColor
public void setRgbColor(int field_4_rgbColor) Set the rgbColor field for the Text record. -
getX
public int getX()Get the x field for the Text record. -
setX
public void setX(int field_5_x) Set the x field for the Text record. -
getY
public int getY()Get the y field for the Text record. -
setY
public void setY(int field_6_y) Set the y field for the Text record. -
getWidth
public int getWidth()Get the width field for the Text record. -
setWidth
public void setWidth(int field_7_width) Set the width field for the Text record. -
getHeight
public int getHeight()Get the height field for the Text record. -
setHeight
public void setHeight(int field_8_height) Set the height field for the Text record. -
getOptions1
public short getOptions1()Get the options1 field for the Text record. -
setOptions1
public void setOptions1(short field_9_options1) Set the options1 field for the Text record. -
getIndexOfColorValue
public short getIndexOfColorValue()Get the index of color value field for the Text record. -
setIndexOfColorValue
public void setIndexOfColorValue(short field_10_indexOfColorValue) Set the index of color value field for the Text record. -
getOptions2
public short getOptions2()Get the options2 field for the Text record. -
setOptions2
public void setOptions2(short field_11_options2) Set the options2 field for the Text record. -
getTextRotation
public short getTextRotation()Get the text rotation field for the Text record. -
setTextRotation
public void setTextRotation(short field_12_textRotation) Set the text rotation field for the Text record. -
setAutoColor
public void setAutoColor(boolean value) Sets the auto color field value. true = automaticly selected colour, false = user-selected -
isAutoColor
public boolean isAutoColor()true = automaticly selected colour, false = user-selected- Returns:
- the auto color field value.
-
setShowKey
public void setShowKey(boolean value) Sets the show key field value. true = draw legend -
isShowKey
public boolean isShowKey()true = draw legend- Returns:
- the show key field value.
-
setShowValue
public void setShowValue(boolean value) Sets the show value field value. false = text is category label -
isShowValue
public boolean isShowValue()false = text is category label- Returns:
- the show value field value.
-
setVertical
public void setVertical(boolean value) Sets the vertical field value. true = text is vertical -
isVertical
public boolean isVertical()true = text is vertical- Returns:
- the vertical field value.
-
setAutoGeneratedText
public void setAutoGeneratedText(boolean value) Sets the auto generated text field value. -
isAutoGeneratedText
public boolean isAutoGeneratedText()- Returns:
- the auto generated text field value.
-
setGenerated
public void setGenerated(boolean value) Sets the generated field value. -
isGenerated
public boolean isGenerated()- Returns:
- the generated field value.
-
setAutoLabelDeleted
public void setAutoLabelDeleted(boolean value) Sets the auto label deleted field value. -
isAutoLabelDeleted
public boolean isAutoLabelDeleted()- Returns:
- the auto label deleted field value.
-
setAutoBackground
public void setAutoBackground(boolean value) Sets the auto background field value. -
isAutoBackground
public boolean isAutoBackground()- Returns:
- the auto background field value.
-
setRotation
public void setRotation(short value) Sets the rotation field value. -
getRotation
public short getRotation()- Returns:
- the rotation field value.
-
setShowCategoryLabelAsPercentage
public void setShowCategoryLabelAsPercentage(boolean value) Sets the show category label as percentage field value. -
isShowCategoryLabelAsPercentage
public boolean isShowCategoryLabelAsPercentage()- Returns:
- the show category label as percentage field value.
-
setShowValueAsPercentage
public void setShowValueAsPercentage(boolean value) Sets the show value as percentage field value. -
isShowValueAsPercentage
public boolean isShowValueAsPercentage()- Returns:
- the show value as percentage field value.
-
setShowBubbleSizes
public void setShowBubbleSizes(boolean value) Sets the show bubble sizes field value. -
isShowBubbleSizes
public boolean isShowBubbleSizes()- Returns:
- the show bubble sizes field value.
-
setShowLabel
public void setShowLabel(boolean value) Sets the show label field value. -
isShowLabel
public boolean isShowLabel()- Returns:
- the show label field value.
-
setDataLabelPlacement
public void setDataLabelPlacement(short value) Sets the data label placement field value. -
getDataLabelPlacement
public short getDataLabelPlacement()- Returns:
- the data label placement field value.
-