org.apache.poi.hssf.record
Class ChartRecord

java.lang.Object
  extended by org.apache.poi.hssf.record.Record
      extended by 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(RecordInputStream in)
          Constructs a Chart record and sets its fields appropriately.
 
Method Summary
 java.lang.Object clone()
           
protected  void fillFields(RecordInputStream in)
          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
cloneViaReserialise, 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
Constructor Detail

ChartRecord

public ChartRecord()

ChartRecord

public ChartRecord(RecordInputStream in)
Constructs a Chart record and sets its fields appropriately.

Parameters:
in - the RecordInputstream to read the record from
Method Detail

validateSid

protected void validateSid(short id)
Checks the sid matches the expected side for this record

Specified by:
validateSid in class Record
Parameters:
id - the expected sid.

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

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()
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.

Specified by:
getSid in class Record

clone

public java.lang.Object clone()
Overrides:
clone 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.



Copyright 2008 The Apache Software Foundation or its licensors, as applicable.