FileDocCategorySizeDatePackage
TextRecord.javaAPI DocApache Poi 3.0.124282Mon Jan 01 12:39:40 GMT 2007org.apache.poi.hssf.record

TextRecord

public class TextRecord extends Record
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)

Fields Summary
public static final short
sid
private byte
field_1_horizontalAlignment
public static final byte
HORIZONTAL_ALIGNMENT_LEFT
public static final byte
HORIZONTAL_ALIGNMENT_CENTER
public static final byte
HORIZONTAL_ALIGNMENT_BOTTOM
public static final byte
HORIZONTAL_ALIGNMENT_JUSTIFY
private byte
field_2_verticalAlignment
public static final byte
VERTICAL_ALIGNMENT_TOP
public static final byte
VERTICAL_ALIGNMENT_CENTER
public static final byte
VERTICAL_ALIGNMENT_BOTTOM
public static final byte
VERTICAL_ALIGNMENT_JUSTIFY
private short
field_3_displayMode
public static final short
DISPLAY_MODE_TRANSPARENT
public static final short
DISPLAY_MODE_OPAQUE
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 BitField
autoColor
private BitField
showKey
private BitField
showValue
private BitField
vertical
private BitField
autoGeneratedText
private BitField
generated
private BitField
autoLabelDeleted
private BitField
autoBackground
private BitField
rotation
public static final short
ROTATION_NONE
public static final short
ROTATION_TOP_TO_BOTTOM
public static final short
ROTATION_ROTATED_90_DEGREES
public static final short
ROTATION_ROTATED_90_DEGREES_CLOCKWISE
private BitField
showCategoryLabelAsPercentage
private BitField
showValueAsPercentage
private BitField
showBubbleSizes
private BitField
showLabel
private short
field_10_indexOfColorValue
private short
field_11_options2
private BitField
dataLabelPlacement
public static final short
DATA_LABEL_PLACEMENT_CHART_DEPENDENT
public static final short
DATA_LABEL_PLACEMENT_OUTSIDE
public static final short
DATA_LABEL_PLACEMENT_INSIDE
public static final short
DATA_LABEL_PLACEMENT_CENTER
public static final short
DATA_LABEL_PLACEMENT_AXIS
public static final short
DATA_LABEL_PLACEMENT_ABOVE
public static final short
DATA_LABEL_PLACEMENT_BELOW
public static final short
DATA_LABEL_PLACEMENT_LEFT
public static final short
DATA_LABEL_PLACEMENT_RIGHT
public static final short
DATA_LABEL_PLACEMENT_AUTO
public static final short
DATA_LABEL_PLACEMENT_USER_MOVED
private short
field_12_textRotation
Constructors Summary
public TextRecord()
public TextRecord(RecordInputStream in)
Constructs a Text record and sets its fields appropriately.

param
id id must be 0x1025 or an exception will be throw upon validation
param
size size the size of the data area of the record
param
data data of the record (should not contain sid/len)

        super(in);
Methods Summary
public java.lang.Objectclone()

        TextRecord rec = new TextRecord();
    
        rec.field_1_horizontalAlignment = field_1_horizontalAlignment;
        rec.field_2_verticalAlignment = field_2_verticalAlignment;
        rec.field_3_displayMode = field_3_displayMode;
        rec.field_4_rgbColor = field_4_rgbColor;
        rec.field_5_x = field_5_x;
        rec.field_6_y = field_6_y;
        rec.field_7_width = field_7_width;
        rec.field_8_height = field_8_height;
        rec.field_9_options1 = field_9_options1;
        rec.field_10_indexOfColorValue = field_10_indexOfColorValue;
        rec.field_11_options2 = field_11_options2;
        rec.field_12_textRotation = field_12_textRotation;
        return rec;
protected voidfillFields(org.apache.poi.hssf.record.RecordInputStream in)

        field_1_horizontalAlignment    = in.readByte();
        field_2_verticalAlignment      = in.readByte();
        field_3_displayMode            = in.readShort();
        field_4_rgbColor               = in.readInt();
        field_5_x                      = in.readInt();
        field_6_y                      = in.readInt();
        field_7_width                  = in.readInt();
        field_8_height                 = in.readInt();
        field_9_options1               = in.readShort();
        field_10_indexOfColorValue     = in.readShort();
        field_11_options2              = in.readShort();
        field_12_textRotation          = in.readShort();
public shortgetDataLabelPlacement()

return
the data label placement field value.

        return dataLabelPlacement.getShortValue(field_11_options2);
public shortgetDisplayMode()
Get the display mode field for the Text record.

return
One of DISPLAY_MODE_TRANSPARENT DISPLAY_MODE_OPAQUE

        return field_3_displayMode;
public intgetHeight()
Get the height field for the Text record.

        return field_8_height;
public bytegetHorizontalAlignment()
Get the horizontal alignment field for the Text record.

return
One of HORIZONTAL_ALIGNMENT_LEFT HORIZONTAL_ALIGNMENT_CENTER HORIZONTAL_ALIGNMENT_BOTTOM HORIZONTAL_ALIGNMENT_JUSTIFY

        return field_1_horizontalAlignment;
public shortgetIndexOfColorValue()
Get the index of color value field for the Text record.

        return field_10_indexOfColorValue;
public shortgetOptions1()
Get the options1 field for the Text record.

        return field_9_options1;
public shortgetOptions2()
Get the options2 field for the Text record.

        return field_11_options2;
public intgetRecordSize()
Size of record (exluding 4 byte header)

        return 4  + 1 + 1 + 2 + 4 + 4 + 4 + 4 + 4 + 2 + 2 + 2 + 2;
public intgetRgbColor()
Get the rgbColor field for the Text record.

        return field_4_rgbColor;
public shortgetRotation()

return
the rotation field value.

        return rotation.getShortValue(field_9_options1);
public shortgetSid()

        return sid;
public shortgetTextRotation()
Get the text rotation field for the Text record.

        return field_12_textRotation;
public bytegetVerticalAlignment()
Get the vertical alignment field for the Text record.

return
One of VERTICAL_ALIGNMENT_TOP VERTICAL_ALIGNMENT_CENTER VERTICAL_ALIGNMENT_BOTTOM VERTICAL_ALIGNMENT_JUSTIFY

        return field_2_verticalAlignment;
public intgetWidth()
Get the width field for the Text record.

        return field_7_width;
public intgetX()
Get the x field for the Text record.

        return field_5_x;
public intgetY()
Get the y field for the Text record.

        return field_6_y;
public booleanisAutoBackground()

return
the auto background field value.

        return autoBackground.isSet(field_9_options1);
public booleanisAutoColor()
true = automaticly selected colour, false = user-selected

return
the auto color field value.

        return autoColor.isSet(field_9_options1);
public booleanisAutoGeneratedText()

return
the auto generated text field value.

        return autoGeneratedText.isSet(field_9_options1);
public booleanisAutoLabelDeleted()

return
the auto label deleted field value.

        return autoLabelDeleted.isSet(field_9_options1);
public booleanisGenerated()

return
the generated field value.

        return generated.isSet(field_9_options1);
public booleanisShowBubbleSizes()

return
the show bubble sizes field value.

        return showBubbleSizes.isSet(field_9_options1);
public booleanisShowCategoryLabelAsPercentage()

return
the show category label as percentage field value.

        return showCategoryLabelAsPercentage.isSet(field_9_options1);
public booleanisShowKey()
true = draw legend

return
the show key field value.

        return showKey.isSet(field_9_options1);
public booleanisShowLabel()

return
the show label field value.

        return showLabel.isSet(field_9_options1);
public booleanisShowValue()
false = text is category label

return
the show value field value.

        return showValue.isSet(field_9_options1);
public booleanisShowValueAsPercentage()

return
the show value as percentage field value.

        return showValueAsPercentage.isSet(field_9_options1);
public booleanisVertical()
true = text is vertical

return
the vertical field value.

        return vertical.isSet(field_9_options1);
public intserialize(int offset, byte[] data)

        int pos = 0;

        LittleEndian.putShort(data, 0 + offset, sid);
        LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4));

        data[ 4 + offset + pos ] = field_1_horizontalAlignment;
        data[ 5 + offset + pos ] = field_2_verticalAlignment;
        LittleEndian.putShort(data, 6 + offset + pos, field_3_displayMode);
        LittleEndian.putInt(data, 8 + offset + pos, field_4_rgbColor);
        LittleEndian.putInt(data, 12 + offset + pos, field_5_x);
        LittleEndian.putInt(data, 16 + offset + pos, field_6_y);
        LittleEndian.putInt(data, 20 + offset + pos, field_7_width);
        LittleEndian.putInt(data, 24 + offset + pos, field_8_height);
        LittleEndian.putShort(data, 28 + offset + pos, field_9_options1);
        LittleEndian.putShort(data, 30 + offset + pos, field_10_indexOfColorValue);
        LittleEndian.putShort(data, 32 + offset + pos, field_11_options2);
        LittleEndian.putShort(data, 34 + offset + pos, field_12_textRotation);

        return getRecordSize();
public voidsetAutoBackground(boolean value)
Sets the auto background field value.

        field_9_options1 = autoBackground.setShortBoolean(field_9_options1, value);
public voidsetAutoColor(boolean value)
Sets the auto color field value. true = automaticly selected colour, false = user-selected

        field_9_options1 = autoColor.setShortBoolean(field_9_options1, value);
public voidsetAutoGeneratedText(boolean value)
Sets the auto generated text field value.

        field_9_options1 = autoGeneratedText.setShortBoolean(field_9_options1, value);
public voidsetAutoLabelDeleted(boolean value)
Sets the auto label deleted field value.

        field_9_options1 = autoLabelDeleted.setShortBoolean(field_9_options1, value);
public voidsetDataLabelPlacement(short value)
Sets the data label placement field value.

        field_11_options2 = dataLabelPlacement.setShortValue(field_11_options2, value);
public voidsetDisplayMode(short field_3_displayMode)
Set the display mode field for the Text record.

param
field_3_displayMode One of DISPLAY_MODE_TRANSPARENT DISPLAY_MODE_OPAQUE

        this.field_3_displayMode = field_3_displayMode;
public voidsetGenerated(boolean value)
Sets the generated field value.

        field_9_options1 = generated.setShortBoolean(field_9_options1, value);
public voidsetHeight(int field_8_height)
Set the height field for the Text record.

        this.field_8_height = field_8_height;
public voidsetHorizontalAlignment(byte field_1_horizontalAlignment)
Set the horizontal alignment field for the Text record.

param
field_1_horizontalAlignment One of HORIZONTAL_ALIGNMENT_LEFT HORIZONTAL_ALIGNMENT_CENTER HORIZONTAL_ALIGNMENT_BOTTOM HORIZONTAL_ALIGNMENT_JUSTIFY

        this.field_1_horizontalAlignment = field_1_horizontalAlignment;
public voidsetIndexOfColorValue(short field_10_indexOfColorValue)
Set the index of color value field for the Text record.

        this.field_10_indexOfColorValue = field_10_indexOfColorValue;
public voidsetOptions1(short field_9_options1)
Set the options1 field for the Text record.

        this.field_9_options1 = field_9_options1;
public voidsetOptions2(short field_11_options2)
Set the options2 field for the Text record.

        this.field_11_options2 = field_11_options2;
public voidsetRgbColor(int field_4_rgbColor)
Set the rgbColor field for the Text record.

        this.field_4_rgbColor = field_4_rgbColor;
public voidsetRotation(short value)
Sets the rotation field value.

        field_9_options1 = rotation.setShortValue(field_9_options1, value);
public voidsetShowBubbleSizes(boolean value)
Sets the show bubble sizes field value.

        field_9_options1 = showBubbleSizes.setShortBoolean(field_9_options1, value);
public voidsetShowCategoryLabelAsPercentage(boolean value)
Sets the show category label as percentage field value.

        field_9_options1 = showCategoryLabelAsPercentage.setShortBoolean(field_9_options1, value);
public voidsetShowKey(boolean value)
Sets the show key field value. true = draw legend

        field_9_options1 = showKey.setShortBoolean(field_9_options1, value);
public voidsetShowLabel(boolean value)
Sets the show label field value.

        field_9_options1 = showLabel.setShortBoolean(field_9_options1, value);
public voidsetShowValue(boolean value)
Sets the show value field value. false = text is category label

        field_9_options1 = showValue.setShortBoolean(field_9_options1, value);
public voidsetShowValueAsPercentage(boolean value)
Sets the show value as percentage field value.

        field_9_options1 = showValueAsPercentage.setShortBoolean(field_9_options1, value);
public voidsetTextRotation(short field_12_textRotation)
Set the text rotation field for the Text record.

        this.field_12_textRotation = field_12_textRotation;
public voidsetVertical(boolean value)
Sets the vertical field value. true = text is vertical

        field_9_options1 = vertical.setShortBoolean(field_9_options1, value);
public voidsetVerticalAlignment(byte field_2_verticalAlignment)
Set the vertical alignment field for the Text record.

param
field_2_verticalAlignment One of VERTICAL_ALIGNMENT_TOP VERTICAL_ALIGNMENT_CENTER VERTICAL_ALIGNMENT_BOTTOM VERTICAL_ALIGNMENT_JUSTIFY

        this.field_2_verticalAlignment = field_2_verticalAlignment;
public voidsetWidth(int field_7_width)
Set the width field for the Text record.

        this.field_7_width = field_7_width;
public voidsetX(int field_5_x)
Set the x field for the Text record.

        this.field_5_x = field_5_x;
public voidsetY(int field_6_y)
Set the y field for the Text record.

        this.field_6_y = field_6_y;
public java.lang.StringtoString()

        StringBuffer buffer = new StringBuffer();

        buffer.append("[TEXT]\n");
        buffer.append("    .horizontalAlignment  = ")
            .append("0x").append(HexDump.toHex(  getHorizontalAlignment ()))
            .append(" (").append( getHorizontalAlignment() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("    .verticalAlignment    = ")
            .append("0x").append(HexDump.toHex(  getVerticalAlignment ()))
            .append(" (").append( getVerticalAlignment() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("    .displayMode          = ")
            .append("0x").append(HexDump.toHex(  getDisplayMode ()))
            .append(" (").append( getDisplayMode() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("    .rgbColor             = ")
            .append("0x").append(HexDump.toHex(  getRgbColor ()))
            .append(" (").append( getRgbColor() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("    .x                    = ")
            .append("0x").append(HexDump.toHex(  getX ()))
            .append(" (").append( getX() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("    .y                    = ")
            .append("0x").append(HexDump.toHex(  getY ()))
            .append(" (").append( getY() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("    .width                = ")
            .append("0x").append(HexDump.toHex(  getWidth ()))
            .append(" (").append( getWidth() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("    .height               = ")
            .append("0x").append(HexDump.toHex(  getHeight ()))
            .append(" (").append( getHeight() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("    .options1             = ")
            .append("0x").append(HexDump.toHex(  getOptions1 ()))
            .append(" (").append( getOptions1() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("         .autoColor                = ").append(isAutoColor()).append('\n"); 
        buffer.append("         .showKey                  = ").append(isShowKey()).append('\n"); 
        buffer.append("         .showValue                = ").append(isShowValue()).append('\n"); 
        buffer.append("         .vertical                 = ").append(isVertical()).append('\n"); 
        buffer.append("         .autoGeneratedText        = ").append(isAutoGeneratedText()).append('\n"); 
        buffer.append("         .generated                = ").append(isGenerated()).append('\n"); 
        buffer.append("         .autoLabelDeleted         = ").append(isAutoLabelDeleted()).append('\n"); 
        buffer.append("         .autoBackground           = ").append(isAutoBackground()).append('\n"); 
            buffer.append("         .rotation                 = ").append(getRotation()).append('\n"); 
        buffer.append("         .showCategoryLabelAsPercentage     = ").append(isShowCategoryLabelAsPercentage()).append('\n"); 
        buffer.append("         .showValueAsPercentage     = ").append(isShowValueAsPercentage()).append('\n"); 
        buffer.append("         .showBubbleSizes          = ").append(isShowBubbleSizes()).append('\n"); 
        buffer.append("         .showLabel                = ").append(isShowLabel()).append('\n"); 
        buffer.append("    .indexOfColorValue    = ")
            .append("0x").append(HexDump.toHex(  getIndexOfColorValue ()))
            .append(" (").append( getIndexOfColorValue() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("    .options2             = ")
            .append("0x").append(HexDump.toHex(  getOptions2 ()))
            .append(" (").append( getOptions2() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
            buffer.append("         .dataLabelPlacement       = ").append(getDataLabelPlacement()).append('\n"); 
        buffer.append("    .textRotation         = ")
            .append("0x").append(HexDump.toHex(  getTextRotation ()))
            .append(" (").append( getTextRotation() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 

        buffer.append("[/TEXT]\n");
        return buffer.toString();
protected voidvalidateSid(short id)
Checks the sid matches the expected side for this record

param
id the expected sid.

        if (id != sid)
        {
            throw new RecordFormatException("Not a Text record");
        }