loci.poi.hssf.record

Class ChartFormatRecord

java.lang.Object

loci.poi.hssf.record.Record

loci.poi.hssf.record.ChartFormatRecord

public class ChartFormatRecord
extends Record

Class ChartFormatRecord

Version:

%I%, %G%

Author:

Glen Stampoultzis (glens at apache.org)

Field Summary

Fields

Modifier and Type	Field and Description
private int	field1_x_position
private int	field2_y_position
private int	field3_width
private int	field4_height
private short	field5_grbit
static short	sid
private BitField	varyDisplayPattern

Constructor Summary

Constructors

Constructor and Description
ChartFormatRecord()
ChartFormatRecord(RecordInputStream in) Constructs a ChartFormatRecord record and sets its fields appropriately.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	fillFields(RecordInputStream in) called by the constructor, should set class level fields.
int	getHeight()
int	getRecordSize() gives the current serialized size of the record.
short	getSid() return the non static version of the id for this record.
boolean	getVaryDisplayPattern()
int	getWidth()
int	getXPosition()
int	getYPosition()
int	serialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.
void	setHeight(int height)
void	setVaryDisplayPattern(boolean value)
void	setWidth(int width)
void	setXPosition(int xPosition)
void	setYPosition(int yPosition)
String	toString() get a string representation of the record (for biffview/debugging)
protected void	validateSid(short id) called by constructor, should throw runtime exception in the event of a record passed with a differing ID.

Methods inherited from class loci.poi.hssf.record.Record

clone, isInValueSection, isValue, serialize

Methods inherited from class java.lang.Object

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

Field Detail

sid

public static final short sid

See Also:

Constant Field Values

field1_x_position

private int field1_x_position

field2_y_position

private int field2_y_position

field3_width

private int field3_width

field4_height

private int field4_height

field5_grbit

private short field5_grbit

varyDisplayPattern

private BitField varyDisplayPattern

Constructor Detail

ChartFormatRecord

public ChartFormatRecord()

ChartFormatRecord

public ChartFormatRecord(RecordInputStream in)

Constructs a ChartFormatRecord record and sets its fields appropriately.

Parameters:

in - the RecordInputstream to read the record from

Method Detail

validateSid

protected void validateSid(short id)

Description copied from class: Record

called by constructor, should throw runtime exception in the event of a record passed with a differing ID.

Specified by:

validateSid in class Record

Parameters:

id - alleged id for this record

fillFields

protected void fillFields(RecordInputStream in)

Description copied from class: Record

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

Specified by:

fillFields in class Record

Parameters:

in - the RecordInputstream to read the record from

toString

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

Specified by:

serialize in class Record

Parameters:

offset - to begin writing at

data - byte array containing instance data

Returns:

number of bytes written

getRecordSize

public int getRecordSize()

Description copied from class: Record

gives the current serialized size of the record. Should include the sid and reclength (4 bytes).

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.

Specified by:

getSid in class Record

getXPosition

public int getXPosition()

setXPosition

public void setXPosition(int xPosition)

getYPosition

public int getYPosition()

setYPosition

public void setYPosition(int yPosition)

getWidth

public int getWidth()

setWidth

public void setWidth(int width)

getHeight

public int getHeight()

setHeight

public void setHeight(int height)

getVaryDisplayPattern

public boolean getVaryDisplayPattern()

setVaryDisplayPattern

public void setVaryDisplayPattern(boolean value)