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

ChartRecord

public class ChartRecord extends Record
The chart record is used to define the location and size of 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 int
field_1_x
private int
field_2_y
private int
field_3_width
private int
field_4_height
Constructors Summary
public ChartRecord()
public ChartRecord(RecordInputStream in)
Constructs a Chart record and sets its fields appropriately.

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

        ChartRecord rec = new ChartRecord();
    
        rec.field_1_x = field_1_x;
        rec.field_2_y = field_2_y;
        rec.field_3_width = field_3_width;
        rec.field_4_height = field_4_height;
        return rec;
protected voidfillFields(org.apache.poi.hssf.record.RecordInputStream in)

        field_1_x                      = in.readInt();
        field_2_y                      = in.readInt();
        field_3_width                  = in.readInt();
        field_4_height                 = in.readInt();
public intgetHeight()
Get the height field for the Chart record.

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

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

        return sid;
public intgetWidth()
Get the width field for the Chart record.

        return field_3_width;
public intgetX()
Get the x field for the Chart record.

        return field_1_x;
public intgetY()
Get the y field for the Chart record.

        return field_2_y;
public intserialize(int offset, byte[] data)

        int pos = 0;

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

        LittleEndian.putInt(data, 4 + offset + pos, field_1_x);
        LittleEndian.putInt(data, 8 + offset + pos, field_2_y);
        LittleEndian.putInt(data, 12 + offset + pos, field_3_width);
        LittleEndian.putInt(data, 16 + offset + pos, field_4_height);

        return getRecordSize();
public voidsetHeight(int field_4_height)
Set the height field for the Chart record.

        this.field_4_height = field_4_height;
public voidsetWidth(int field_3_width)
Set the width field for the Chart record.

        this.field_3_width = field_3_width;
public voidsetX(int field_1_x)
Set the x field for the Chart record.

        this.field_1_x = field_1_x;
public voidsetY(int field_2_y)
Set the y field for the Chart record.

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

        StringBuffer buffer = new StringBuffer();

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