org.apache.poi.hssf.record
Class DimensionsRecord

java.lang.Object
  |
  +--org.apache.poi.hssf.record.Record
        |
        +--org.apache.poi.hssf.record.DimensionsRecord

public class DimensionsRecord

extends Record

Title: Dimensions Record

Description: provides the minumum and maximum bounds of a sheet.

REFERENCE: PG 303 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

Version:

2.0-pre

Author:

Andrew C. Oliver (acoliver at apache dot org)

Field Summary

static short

sid

Constructor Summary

DimensionsRecord()

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

DimensionsRecord(short id, short size, byte[] data, int offset)
Constructs a Dimensions 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.
short	getFirstCol() get the first column number for the sheet
int	getFirstRow() get the first row number for the sheet
short	getLastCol() get the last col number for the sheet
int	getLastRow() get the last row number for the sheet
int	getRecordSize() gives the current serialized size of the record.
short	getSid() return the non static version of the id for this record.
int	serialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.
void	setFirstCol(short col) set the first column number for the sheet
void	setFirstRow(int row) set the first row number for the sheet
void	setLastCol(short col) set the last col number for the sheet
void	setLastRow(int row) set the last row number for the sheet
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

DimensionsRecord

public DimensionsRecord()

DimensionsRecord

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

Constructs a Dimensions record and sets its fields appropriately.

Parameters:

id - id must be 0x200 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)

DimensionsRecord

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

Constructs a Dimensions record and sets its fields appropriately.

Parameters:

id - id must be 0x200 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)

setFirstRow

public void setFirstRow(int row)

set the first row number for the sheet

Parameters:

row - - first row on the sheet

setLastRow

public void setLastRow(int row)

set the last row number for the sheet

Parameters:

row - - last row on the sheet

setFirstCol

public void setFirstCol(short col)

set the first column number for the sheet

Parameters:

col - first column on the sheet

setLastCol

public void setLastCol(short col)

set the last col number for the sheet

Parameters:

col - last column on the sheet

getFirstRow

public int getFirstRow()

get the first row number for the sheet

Returns:

row - first row on the sheet

getLastRow

public int getLastRow()

get the last row number for the sheet

Returns:

row - last row on the sheet

getFirstCol

public short getFirstCol()

get the first column number for the sheet

Returns:

column - first column on the sheet

getLastCol

public short getLastCol()

get the last col number for the sheet

Returns:

column - last column on the sheet

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