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 defines the location of a chart an it's size.

This record supports the charting capability of the program.

This is currently based on BIFF4 but will up updated to take into account changed required by BIFF8.

Author:
Glen Stampoultzis (glens at apache.org)

Field Summary
static short sid
           
 
Constructor Summary
ChartRecord()
           
ChartRecord(short id, short size, byte[] data)
          Constructs a ChartRecord record and sets its fields appropriately.
ChartRecord(short id, short size, byte[] data, int offset)
          Constructs a SeriesRecord 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 getRecordSize()
          gives the current serialized size of the record.
 short getSid()
          return the non static version of the id for this record.
 int getXPosition()
           
 int getXSize()
           
 int getYPosition()
           
 int getYSize()
           
 int serialize(int offset, byte[] data)
          called by the class that is responsible for writing this sucker.
 void setXPosition(int xPosition)
           
 void setXSize(int xSize)
           
 void setYPosition(int yPosition)
           
 void setYSize(int ySize)
           
 java.lang.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 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 ChartRecord record and sets its fields appropriately.
Parameters:
id - id must be 0x1002 or an exception will be throw upon validation
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 SeriesRecord record and sets its fields appropriately.
Parameters:
id - id must be 0x1002 or an exception will be throw upon validation
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)
Description copied from class: Record
called by constructor, should throw runtime exception in the event of a record passed with a differing ID.
Overrides:
validateSid in class Record
Following copied from class: org.apache.poi.hssf.record.Record
Parameters:
id - alleged id for this record

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()
Description copied from class: Record
gives the current serialized size of the record.
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

getXPosition

public int getXPosition()

setXPosition

public void setXPosition(int xPosition)

getYPosition

public int getYPosition()

setYPosition

public void setYPosition(int yPosition)

getXSize

public int getXSize()

setXSize

public void setXSize(int xSize)

getYSize

public int getYSize()

setYSize

public void setYSize(int ySize)


Copyright © 2001-2002 JAKARTA POI project. All Rights Reserved.