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

BarRecord

public class BarRecord extends Record
The bar record is used to define a bar 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 short
field_1_barSpace
private short
field_2_categorySpace
private short
field_3_formatFlags
private BitField
horizontal
private BitField
stacked
private BitField
displayAsPercentage
private BitField
shadow
Constructors Summary
public BarRecord()
public BarRecord(RecordInputStream in)
Constructs a Bar record and sets its fields appropriately.

param
id id must be 0x1017 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()

        BarRecord rec = new BarRecord();
    
        rec.field_1_barSpace = field_1_barSpace;
        rec.field_2_categorySpace = field_2_categorySpace;
        rec.field_3_formatFlags = field_3_formatFlags;
        return rec;
protected voidfillFields(org.apache.poi.hssf.record.RecordInputStream in)

        field_1_barSpace               = in.readShort();
        field_2_categorySpace          = in.readShort();
        field_3_formatFlags            = in.readShort();
public shortgetBarSpace()
Get the bar space field for the Bar record.

        return field_1_barSpace;
public shortgetCategorySpace()
Get the category space field for the Bar record.

        return field_2_categorySpace;
public shortgetFormatFlags()
Get the format flags field for the Bar record.

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

        return 4  + 2 + 2 + 2;
public shortgetSid()

        return sid;
public booleanisDisplayAsPercentage()
display chart values as a percentage

return
the display as percentage field value.

        return displayAsPercentage.isSet(field_3_formatFlags);
public booleanisHorizontal()
true to display horizontal bar charts, false for vertical

return
the horizontal field value.

        return horizontal.isSet(field_3_formatFlags);
public booleanisShadow()
display a shadow for the chart

return
the shadow field value.

        return shadow.isSet(field_3_formatFlags);
public booleanisStacked()
stack displayed values

return
the stacked field value.

        return stacked.isSet(field_3_formatFlags);
public intserialize(int offset, byte[] data)

        int pos = 0;

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

        LittleEndian.putShort(data, 4 + offset + pos, field_1_barSpace);
        LittleEndian.putShort(data, 6 + offset + pos, field_2_categorySpace);
        LittleEndian.putShort(data, 8 + offset + pos, field_3_formatFlags);

        return getRecordSize();
public voidsetBarSpace(short field_1_barSpace)
Set the bar space field for the Bar record.

        this.field_1_barSpace = field_1_barSpace;
public voidsetCategorySpace(short field_2_categorySpace)
Set the category space field for the Bar record.

        this.field_2_categorySpace = field_2_categorySpace;
public voidsetDisplayAsPercentage(boolean value)
Sets the display as percentage field value. display chart values as a percentage

        field_3_formatFlags = displayAsPercentage.setShortBoolean(field_3_formatFlags, value);
public voidsetFormatFlags(short field_3_formatFlags)
Set the format flags field for the Bar record.

        this.field_3_formatFlags = field_3_formatFlags;
public voidsetHorizontal(boolean value)
Sets the horizontal field value. true to display horizontal bar charts, false for vertical

        field_3_formatFlags = horizontal.setShortBoolean(field_3_formatFlags, value);
public voidsetShadow(boolean value)
Sets the shadow field value. display a shadow for the chart

        field_3_formatFlags = shadow.setShortBoolean(field_3_formatFlags, value);
public voidsetStacked(boolean value)
Sets the stacked field value. stack displayed values

        field_3_formatFlags = stacked.setShortBoolean(field_3_formatFlags, value);
public java.lang.StringtoString()

        StringBuffer buffer = new StringBuffer();

        buffer.append("[BAR]\n");
        buffer.append("    .barSpace             = ")
            .append("0x").append(HexDump.toHex(  getBarSpace ()))
            .append(" (").append( getBarSpace() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("    .categorySpace        = ")
            .append("0x").append(HexDump.toHex(  getCategorySpace ()))
            .append(" (").append( getCategorySpace() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("    .formatFlags          = ")
            .append("0x").append(HexDump.toHex(  getFormatFlags ()))
            .append(" (").append( getFormatFlags() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("         .horizontal               = ").append(isHorizontal()).append('\n"); 
        buffer.append("         .stacked                  = ").append(isStacked()).append('\n"); 
        buffer.append("         .displayAsPercentage      = ").append(isDisplayAsPercentage()).append('\n"); 
        buffer.append("         .shadow                   = ").append(isShadow()).append('\n"); 

        buffer.append("[/BAR]\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 Bar record");
        }