Apache POI - Common 5.3.0 · org.apache.poi.hssf.record.chart.TextRecord

Field Summary

Modifier and Type	Field and Description
private static final BitField	autoBackground
private static final BitField	autoColor
private static final BitField	autoGeneratedText
private static final BitField	autoLabelDeleted
public static final short	DATA_LABEL_PLACEMENT_ABOVE
public static final short	DATA_LABEL_PLACEMENT_AUTO
public static final short	DATA_LABEL_PLACEMENT_AXIS
public static final short	DATA_LABEL_PLACEMENT_BELOW
public static final short	DATA_LABEL_PLACEMENT_CENTER
public static final short	DATA_LABEL_PLACEMENT_CHART_DEPENDENT
public static final short	DATA_LABEL_PLACEMENT_INSIDE
public static final short	DATA_LABEL_PLACEMENT_LEFT
public static final short	DATA_LABEL_PLACEMENT_OUTSIDE
public static final short	DATA_LABEL_PLACEMENT_RIGHT
public static final short	DATA_LABEL_PLACEMENT_USER_MOVED
private static final BitField	dataLabelPlacement
public static final short	DISPLAY_MODE_OPAQUE
public static final short	DISPLAY_MODE_TRANSPARENT
private short	field_10_indexOfColorValue
private short	field_11_options2
private short	field_12_textRotation
private byte	field_1_horizontalAlignment
private byte	field_2_verticalAlignment
private short	field_3_displayMode
private int	field_4_rgbColor
private int	field_5_x
private int	field_6_y
private int	field_7_width
private int	field_8_height
private short	field_9_options1
private static final BitField	generated
public static final byte	HORIZONTAL_ALIGNMENT_BOTTOM
public static final byte	HORIZONTAL_ALIGNMENT_CENTER
public static final byte	HORIZONTAL_ALIGNMENT_JUSTIFY
public static final byte	HORIZONTAL_ALIGNMENT_LEFT
private static final BitField	rotation
public static final short	ROTATION_NONE
public static final short	ROTATION_ROTATED_90_DEGREES
public static final short	ROTATION_ROTATED_90_DEGREES_CLOCKWISE
public static final short	ROTATION_TOP_TO_BOTTOM
private static final BitField	showBubbleSizes
private static final BitField	showCategoryLabelAsPercentage
private static final BitField	showKey
private static final BitField	showLabel
private static final BitField	showValue
private static final BitField	showValueAsPercentage
public static final short	sid
private static final BitField	vertical
public static final byte	VERTICAL_ALIGNMENT_BOTTOM
public static final byte	VERTICAL_ALIGNMENT_CENTER
public static final byte	VERTICAL_ALIGNMENT_JUSTIFY
public static final byte	VERTICAL_ALIGNMENT_TOP

Constructor Summary

Access	Constructor and Description
public	TextRecord()
public	TextRecord(TextRecord other)
public	TextRecord(RecordInputStream in)

Method Summary

Modifier and Type	Method and Description
public TextRecord	copy() Implements abstract org.apache.poi.hssf.record.StandardRecord.copy. Implements org.apache.poi.common.Duplicatable.copy.
public short	Returns: the data label placement field value. getDataLabelPlacement()
protected int	getDataSize() Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.
public short	Returns: One of DISPLAY_MODE_TRANSPARENT DISPLAY_MODE_OPAQUE getDisplayMode() Get the display mode field for the Text record.
public Map<String, Supplier<?>>	getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.
public HSSFRecordTypes	getGenericRecordType() Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType. Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.
public int	getHeight() Get the height field for the Text record.
public byte	Returns: One of HORIZONTAL_ALIGNMENT_LEFT HORIZONTAL_ALIGNMENT_CENTER HORIZONTAL_ALIGNMENT_BOTTOM HORIZONTAL_ALIGNMENT_JUSTIFY getHorizontalAlignment() Get the horizontal alignment field for the Text record.
public short	getIndexOfColorValue() Get the index of color value field for the Text record.
public short	getOptions1() Get the options1 field for the Text record.
public short	getOptions2() Get the options2 field for the Text record.
public int	getRgbColor() Get the rgbColor field for the Text record.
public short	Returns: the rotation field value. getRotation()
public short	getSid() Implements abstract org.apache.poi.hssf.record.Record.getSid. return the non static version of the id for this record.
public short	getTextRotation() Get the text rotation field for the Text record.
public byte	Returns: One of VERTICAL_ALIGNMENT_TOP VERTICAL_ALIGNMENT_CENTER VERTICAL_ALIGNMENT_BOTTOM VERTICAL_ALIGNMENT_JUSTIFY getVerticalAlignment() Get the vertical alignment field for the Text record.
public int	getWidth() Get the width field for the Text record.
public int	getX() Get the x field for the Text record.
public int	getY() Get the y field for the Text record.
public boolean	Returns: the auto background field value. isAutoBackground()
public boolean	Returns: the auto color field value. isAutoColor() true = automaticly selected colour, false = user-selected
public boolean	Returns: the auto generated text field value. isAutoGeneratedText()
public boolean	Returns: the auto label deleted field value. isAutoLabelDeleted()
public boolean	Returns: the generated field value. isGenerated()
public boolean	Returns: the show bubble sizes field value. isShowBubbleSizes()
public boolean	Returns: the show category label as percentage field value. isShowCategoryLabelAsPercentage()
public boolean	Returns: the show key field value. isShowKey() true = draw legend
public boolean	Returns: the show label field value. isShowLabel()
public boolean	Returns: the show value field value. isShowValue() false = text is category label
public boolean	Returns: the show value as percentage field value. isShowValueAsPercentage()
public boolean	Returns: the vertical field value. isVertical() true = text is vertical
public void	serialize(LittleEndianOutput the output object out) Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize. Write the data content of this BIFF record.
public void	setAutoBackground(boolean value) Sets the auto background field value.
public void	setAutoColor(boolean value) Sets the auto color field value.
public void	setAutoGeneratedText(boolean value) Sets the auto generated text field value.
public void	setAutoLabelDeleted(boolean value) Sets the auto label deleted field value.
public void	setDataLabelPlacement(short value) Sets the data label placement field value.
public void	setDisplayMode(short One of DISPLAY_MODE_TRANSPARENT DISPLAY_MODE_OPAQUE field_3_displayMode) Set the display mode field for the Text record.
public void	setGenerated(boolean value) Sets the generated field value.
public void	setHeight(int field_8_height) Set the height field for the Text record.
public void	setHorizontalAlignment(byte One of HORIZONTAL_ALIGNMENT_LEFT HORIZONTAL_ALIGNMENT_CENTER HORIZONTAL_ALIGNMENT_BOTTOM HORIZONTAL_ALIGNMENT_JUSTIFY field_1_horizontalAlignment) Set the horizontal alignment field for the Text record.
public void	setIndexOfColorValue(short field_10_indexOfColorValue) Set the index of color value field for the Text record.
public void	setOptions1(short field_9_options1) Set the options1 field for the Text record.
public void	setOptions2(short field_11_options2) Set the options2 field for the Text record.
public void	setRgbColor(int field_4_rgbColor) Set the rgbColor field for the Text record.
public void	setRotation(short value) Sets the rotation field value.
public void	setShowBubbleSizes(boolean value) Sets the show bubble sizes field value.
public void	setShowCategoryLabelAsPercentage(boolean value) Sets the show category label as percentage field value.
public void	setShowKey(boolean value) Sets the show key field value.
public void	setShowLabel(boolean value) Sets the show label field value.
public void	setShowValue(boolean value) Sets the show value field value.
public void	setShowValueAsPercentage(boolean value) Sets the show value as percentage field value.
public void	setTextRotation(short field_12_textRotation) Set the text rotation field for the Text record.
public void	setVertical(boolean value) Sets the vertical field value.
public void	setVerticalAlignment(byte One of VERTICAL_ALIGNMENT_TOP VERTICAL_ALIGNMENT_CENTER VERTICAL_ALIGNMENT_BOTTOM VERTICAL_ALIGNMENT_JUSTIFY field_2_verticalAlignment) Set the vertical alignment field for the Text record.
public void	setWidth(int field_7_width) Set the width field for the Text record.
public void	setX(int field_5_x) Set the x field for the Text record.
public void	setY(int field_6_y) Set the y field for the Text record.

Inherited from org.apache.poi.hssf.record.StandardRecord:: getRecordSize serialize

Field Detail

autoBackground	back to summary
private static final BitField autoBackground

autoColor	back to summary
private static final BitField autoColor

autoGeneratedText	back to summary
private static final BitField autoGeneratedText

autoLabelDeleted	back to summary
private static final BitField autoLabelDeleted

DATA_LABEL_PLACEMENT_ABOVE	back to summary
public static final short DATA_LABEL_PLACEMENT_ABOVE

DATA_LABEL_PLACEMENT_AUTO	back to summary
public static final short DATA_LABEL_PLACEMENT_AUTO

DATA_LABEL_PLACEMENT_AXIS	back to summary
public static final short DATA_LABEL_PLACEMENT_AXIS

DATA_LABEL_PLACEMENT_BELOW	back to summary
public static final short DATA_LABEL_PLACEMENT_BELOW

DATA_LABEL_PLACEMENT_CENTER	back to summary
public static final short DATA_LABEL_PLACEMENT_CENTER

DATA_LABEL_PLACEMENT_CHART_DEPENDENT	back to summary
public static final short DATA_LABEL_PLACEMENT_CHART_DEPENDENT

DATA_LABEL_PLACEMENT_INSIDE	back to summary
public static final short DATA_LABEL_PLACEMENT_INSIDE

DATA_LABEL_PLACEMENT_LEFT	back to summary
public static final short DATA_LABEL_PLACEMENT_LEFT

DATA_LABEL_PLACEMENT_OUTSIDE	back to summary
public static final short DATA_LABEL_PLACEMENT_OUTSIDE

DATA_LABEL_PLACEMENT_RIGHT	back to summary
public static final short DATA_LABEL_PLACEMENT_RIGHT

DATA_LABEL_PLACEMENT_USER_MOVED	back to summary
public static final short DATA_LABEL_PLACEMENT_USER_MOVED

dataLabelPlacement	back to summary
private static final BitField dataLabelPlacement

DISPLAY_MODE_OPAQUE	back to summary
public static final short DISPLAY_MODE_OPAQUE

DISPLAY_MODE_TRANSPARENT	back to summary
public static final short DISPLAY_MODE_TRANSPARENT

field_10_indexOfColorValue	back to summary
private short field_10_indexOfColorValue

field_11_options2	back to summary
private short field_11_options2

field_12_textRotation	back to summary
private short field_12_textRotation

field_1_horizontalAlignment	back to summary
private byte field_1_horizontalAlignment

field_2_verticalAlignment	back to summary
private byte field_2_verticalAlignment

field_3_displayMode	back to summary
private short field_3_displayMode

field_4_rgbColor	back to summary
private int field_4_rgbColor

field_5_x	back to summary
private int field_5_x

field_6_y	back to summary
private int field_6_y

field_7_width	back to summary
private int field_7_width

field_8_height	back to summary
private int field_8_height

field_9_options1	back to summary
private short field_9_options1

generated	back to summary
private static final BitField generated

HORIZONTAL_ALIGNMENT_BOTTOM	back to summary
public static final byte HORIZONTAL_ALIGNMENT_BOTTOM

HORIZONTAL_ALIGNMENT_CENTER	back to summary
public static final byte HORIZONTAL_ALIGNMENT_CENTER

HORIZONTAL_ALIGNMENT_JUSTIFY	back to summary
public static final byte HORIZONTAL_ALIGNMENT_JUSTIFY

HORIZONTAL_ALIGNMENT_LEFT	back to summary
public static final byte HORIZONTAL_ALIGNMENT_LEFT

rotation	back to summary
private static final BitField rotation

ROTATION_NONE	back to summary
public static final short ROTATION_NONE

ROTATION_ROTATED_90_DEGREES	back to summary
public static final short ROTATION_ROTATED_90_DEGREES

ROTATION_ROTATED_90_DEGREES_CLOCKWISE	back to summary
public static final short ROTATION_ROTATED_90_DEGREES_CLOCKWISE

ROTATION_TOP_TO_BOTTOM	back to summary
public static final short ROTATION_TOP_TO_BOTTOM

showBubbleSizes	back to summary
private static final BitField showBubbleSizes

showCategoryLabelAsPercentage	back to summary
private static final BitField showCategoryLabelAsPercentage

showKey	back to summary
private static final BitField showKey

showLabel	back to summary
private static final BitField showLabel

showValue	back to summary
private static final BitField showValue

showValueAsPercentage	back to summary
private static final BitField showValueAsPercentage

sid	back to summary
public static final short sid

vertical	back to summary
private static final BitField vertical

VERTICAL_ALIGNMENT_BOTTOM	back to summary
public static final byte VERTICAL_ALIGNMENT_BOTTOM

VERTICAL_ALIGNMENT_CENTER	back to summary
public static final byte VERTICAL_ALIGNMENT_CENTER

VERTICAL_ALIGNMENT_JUSTIFY	back to summary
public static final byte VERTICAL_ALIGNMENT_JUSTIFY

VERTICAL_ALIGNMENT_TOP	back to summary
public static final byte VERTICAL_ALIGNMENT_TOP

Constructor Detail

TextRecord	back to summary
public TextRecord()

TextRecord	back to summary
public TextRecord(TextRecord other)

TextRecord	back to summary
public TextRecord(RecordInputStream in)

Method Detail

copy

back to summary

public TextRecord copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:TextRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations

@Override

getDataLabelPlacement	back to summary
public short getDataLabelPlacement() Returns:short the data label placement field value.

getDataSize	back to summary
protected int getDataSize() Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

getDisplayMode

back to summary

public short getDisplayMode()

Get the display mode field for the Text record.

Returns:short: One of DISPLAY_MODE_TRANSPARENT DISPLAY_MODE_OPAQUE

getGenericProperties

back to summary

public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations

@Override

getGenericRecordType

back to summary

public HSSFRecordTypes getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

Annotations

@Override

getHeight	back to summary
public int getHeight() Get the height field for the Text record.

getHorizontalAlignment

back to summary

public byte getHorizontalAlignment()

Get the horizontal alignment field for the Text record.

Returns:byte: One of HORIZONTAL_ALIGNMENT_LEFT HORIZONTAL_ALIGNMENT_CENTER HORIZONTAL_ALIGNMENT_BOTTOM HORIZONTAL_ALIGNMENT_JUSTIFY

getIndexOfColorValue	back to summary
public short getIndexOfColorValue() Get the index of color value field for the Text record.

getOptions1	back to summary
public short getOptions1() Get the options1 field for the Text record.

getOptions2	back to summary
public short getOptions2() Get the options2 field for the Text record.

getRgbColor	back to summary
public int getRgbColor() Get the rgbColor field for the Text record.

getRotation	back to summary
public short getRotation() Returns:short the rotation field value.

getSid

back to summary

public short getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

Doc from org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

Returns:short: he id for this record

getTextRotation	back to summary
public short getTextRotation() Get the text rotation field for the Text record.

getVerticalAlignment

back to summary

public byte getVerticalAlignment()

Get the vertical alignment field for the Text record.

Returns:byte: One of VERTICAL_ALIGNMENT_TOP VERTICAL_ALIGNMENT_CENTER VERTICAL_ALIGNMENT_BOTTOM VERTICAL_ALIGNMENT_JUSTIFY

getWidth	back to summary
public int getWidth() Get the width field for the Text record.

getX	back to summary
public int getX() Get the x field for the Text record.

getY	back to summary
public int getY() Get the y field for the Text record.

isAutoBackground	back to summary
public boolean isAutoBackground() Returns:boolean the auto background field value.

isAutoColor

back to summary

public boolean isAutoColor()

true = automaticly selected colour, false = user-selected

Returns:boolean: the auto color field value.

isAutoGeneratedText	back to summary
public boolean isAutoGeneratedText() Returns:boolean the auto generated text field value.

isAutoLabelDeleted	back to summary
public boolean isAutoLabelDeleted() Returns:boolean the auto label deleted field value.

isGenerated	back to summary
public boolean isGenerated() Returns:boolean the generated field value.

isShowBubbleSizes	back to summary
public boolean isShowBubbleSizes() Returns:boolean the show bubble sizes field value.

isShowCategoryLabelAsPercentage	back to summary
public boolean isShowCategoryLabelAsPercentage() Returns:boolean the show category label as percentage field value.

isShowKey

back to summary

public boolean isShowKey()

true = draw legend

Returns:boolean: the show key field value.

isShowLabel	back to summary
public boolean isShowLabel() Returns:boolean the show label field value.

isShowValue

back to summary

public boolean isShowValue()

false = text is category label

Returns:boolean: the show value field value.

isShowValueAsPercentage	back to summary
public boolean isShowValueAsPercentage() Returns:boolean the show value as percentage field value.

isVertical

back to summary

public boolean isVertical()

true = text is vertical

Returns:boolean: the vertical field value.

serialize back to summary

public void serialize(LittleEndianOutput out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Doc from org.apache.poi.hssf.record.StandardRecord.serialize.

Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.

The number of bytes written must equal the record size reported by org.apache.poi.hssf.record.Record#getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Parameters

out:LittleEndianOutput: the output object

setAutoBackground	back to summary
public void setAutoBackground(boolean value) Sets the auto background field value.

setAutoColor	back to summary
public void setAutoColor(boolean value) Sets the auto color field value. true = automaticly selected colour, false = user-selected

setAutoGeneratedText	back to summary
public void setAutoGeneratedText(boolean value) Sets the auto generated text field value.

setAutoLabelDeleted	back to summary
public void setAutoLabelDeleted(boolean value) Sets the auto label deleted field value.

setDataLabelPlacement	back to summary
public void setDataLabelPlacement(short value) Sets the data label placement field value.

setDisplayMode

back to summary

public void setDisplayMode(short field_3_displayMode)

Set the display mode field for the Text record.

Parameters

field_3_displayMode:short: One of DISPLAY_MODE_TRANSPARENT DISPLAY_MODE_OPAQUE

setGenerated	back to summary
public void setGenerated(boolean value) Sets the generated field value.

setHeight	back to summary
public void setHeight(int field_8_height) Set the height field for the Text record.

setHorizontalAlignment

back to summary

public void setHorizontalAlignment(byte field_1_horizontalAlignment)

Set the horizontal alignment field for the Text record.

Parameters

field_1_horizontalAlignment:byte: One of HORIZONTAL_ALIGNMENT_LEFT HORIZONTAL_ALIGNMENT_CENTER HORIZONTAL_ALIGNMENT_BOTTOM HORIZONTAL_ALIGNMENT_JUSTIFY

setIndexOfColorValue	back to summary
public void setIndexOfColorValue(short field_10_indexOfColorValue) Set the index of color value field for the Text record.

setOptions1	back to summary
public void setOptions1(short field_9_options1) Set the options1 field for the Text record.

setOptions2	back to summary
public void setOptions2(short field_11_options2) Set the options2 field for the Text record.

setRgbColor	back to summary
public void setRgbColor(int field_4_rgbColor) Set the rgbColor field for the Text record.

setRotation	back to summary
public void setRotation(short value) Sets the rotation field value.

setShowBubbleSizes	back to summary
public void setShowBubbleSizes(boolean value) Sets the show bubble sizes field value.

setShowCategoryLabelAsPercentage	back to summary
public void setShowCategoryLabelAsPercentage(boolean value) Sets the show category label as percentage field value.

setShowKey	back to summary
public void setShowKey(boolean value) Sets the show key field value. true = draw legend

setShowLabel	back to summary
public void setShowLabel(boolean value) Sets the show label field value.

setShowValue	back to summary
public void setShowValue(boolean value) Sets the show value field value. false = text is category label

setShowValueAsPercentage	back to summary
public void setShowValueAsPercentage(boolean value) Sets the show value as percentage field value.

setTextRotation	back to summary
public void setTextRotation(short field_12_textRotation) Set the text rotation field for the Text record.

setVertical	back to summary
public void setVertical(boolean value) Sets the vertical field value. true = text is vertical

setVerticalAlignment

back to summary

public void setVerticalAlignment(byte field_2_verticalAlignment)

Set the vertical alignment field for the Text record.

Parameters

field_2_verticalAlignment:byte: One of VERTICAL_ALIGNMENT_TOP VERTICAL_ALIGNMENT_CENTER VERTICAL_ALIGNMENT_BOTTOM VERTICAL_ALIGNMENT_JUSTIFY

setWidth	back to summary
public void setWidth(int field_7_width) Set the width field for the Text record.

setX	back to summary
public void setX(int field_5_x) Set the x field for the Text record.

setY	back to summary
public void setY(int field_6_y) Set the y field for the Text record.

public final Class TextRecord

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail