org.apache.poi.hssf.record
Class ChartRecord

java.lang.Object
  |
  +--org.apache.poi.hssf.record.Record
        |
        +--org.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)

Field Summary

static short

sid

Constructor Summary

ChartRecord()

ChartRecord(short id, short size, byte[] data)
Constructs a Chart record and sets its fields appropriately.

ChartRecord(short id, short size, byte[] data, int offset)
Constructs a Chart record and sets its fields appropriately.

Method Summary

protected void	fillFields(byte[] data, short size, int offset) called by the constructor, should set class level fields.
int	getHeight() Get the height field for the Chart record.
int	getRecordSize() Size of record (exluding 4 byte header)
short	getSid() return the non static version of the id for this record.
int	getWidth() Get the width field for the Chart record.
int	getX() Get the x field for the Chart record.
int	getY() Get the y field for the Chart record.
int	serialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.
void	setHeight(int field_4_height) Set the height field for the Chart record.
void	setWidth(int field_3_width) Set the width field for the Chart record.
void	setX(int field_1_x) Set the x field for the Chart record.
void	setY(int field_2_y) Set the y field for the Chart record.
java.lang.String	toString() get a string representation of the record (for biffview/debugging)
protected void	validateSid(short id) Checks the sid matches the expected side for this record

Methods inherited from class org.apache.poi.hssf.record.Record

fillFields, isInValueSection, isValue, processContinueRecord, serialize

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

sid

public static final short sid

Constructor Detail

ChartRecord

public ChartRecord()

ChartRecord

public ChartRecord(short id,
                   short size,
                   byte[] data)

Constructs a Chart record and sets its fields appropriately.

Parameters:

id - id must be 0x1002 or an exception will be throw upon validation

size - size the size of the data area of the record

data - data of the record (should not contain sid/len)

ChartRecord

public ChartRecord(short id,
                   short size,
                   byte[] data,
                   int offset)

Constructs a Chart record and sets its fields appropriately.

Parameters:

id - id must be 0x1002 or an exception will be throw upon validation

size - size the size of the data area of the record

data - data of the record (should not contain sid/len)

offset - of the record's data

Method Detail

validateSid

protected void validateSid(short id)

Checks the sid matches the expected side for this record

Overrides:

validateSid in class Record

Parameters:

id - the expected sid.

fillFields

protected void fillFields(byte[] data,
                          short size,
                          int offset)

Description copied from class: Record

called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.

Overrides:

fillFields in class Record

Following copied from class: org.apache.poi.hssf.record.Record

Parameters:

data - raw data

size - size of data

offset - of the record's data (provided a big array of the file)

toString

public java.lang.String toString()

Description copied from class: Record

get a string representation of the record (for biffview/debugging)

Overrides:

toString in class Record

serialize

public int serialize(int offset,
                     byte[] data)

Description copied from class: Record

called 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.

Overrides:

serialize in class Record

Following copied from class: org.apache.poi.hssf.record.Record

Parameters:

offset - to begin writing at

data - byte array containing instance data

Returns:

number of bytes written

getRecordSize

public int getRecordSize()

Size of record (exluding 4 byte header)

Overrides:

getRecordSize in class Record

getSid

public short getSid()

Description copied from class: Record

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

Overrides:

getSid in class Record

getX

public int getX()

Get the x field for the Chart record.

setX

public void setX(int field_1_x)

Set the x field for the Chart record.

getY

public int getY()

Get the y field for the Chart record.

setY

public void setY(int field_2_y)

Set the y field for the Chart record.

getWidth

public int getWidth()

Get the width field for the Chart record.

setWidth

public void setWidth(int field_3_width)

Set the width field for the Chart record.

getHeight

public int getHeight()

Get the height field for the Chart record.

setHeight

public void setHeight(int field_4_height)

Set the height field for the Chart record.