org.apache.poi.hssf.record
Class MulBlankRecord

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

public class MulBlankRecord
extends Record

Title: Mulitple Blank cell record

Description: Represents a set of columns in a row with no value but with styling. In this release we have read-only support for this record type. The RecordFactory converts this to a set of BlankRecord objects.

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

Version:
2.0-pre
Author:
Andrew C. Oliver (acoliver at apache dot org)
See Also:
RecordFactory, BlankRecord

Field Summary
static short sid
           
 
Constructor Summary
MulBlankRecord()
          Creates new MulBlankRecord
MulBlankRecord(short id, short size, byte[] data)
          Constructs a MulBlank record and sets its fields appropriately.
MulBlankRecord(short id, short size, byte[] data, int offset)
          Constructs a MulBlank 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 getFirstColumn()
          starting column (first cell this holds in the row)
 short getLastColumn()
          ending column (last cell this holds in the row)
 int getNumColumns()
          get the number of columns this contains (last-first +1)
 short getRow()
          get the row number of the cells this represents
 short getSid()
          return the non static version of the id for this record.
 short getXFAt(int coffset)
          returns the xf index for column (coffset = column - field_2_first_col)
 int serialize(int offset, byte[] data)
          called by the class that is responsible for writing this sucker.
 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, getRecordSize, 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

MulBlankRecord

public MulBlankRecord()
Creates new MulBlankRecord

MulBlankRecord

public MulBlankRecord(short id,
                      short size,
                      byte[] data)
Constructs a MulBlank record and sets its fields appropriately.
Parameters:
id - id must be 0xbe 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)

MulBlankRecord

public MulBlankRecord(short id,
                      short size,
                      byte[] data,
                      int offset)
Constructs a MulBlank record and sets its fields appropriately.
Parameters:
id - id must be 0xbe 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

getRow

public short getRow()
get the row number of the cells this represents
Returns:
row number

getFirstColumn

public short getFirstColumn()
starting column (first cell this holds in the row)
Returns:
first column number

getLastColumn

public short getLastColumn()
ending column (last cell this holds in the row)
Returns:
first column number

getNumColumns

public int getNumColumns()
get the number of columns this contains (last-first +1)
Returns:
number of columns (last - first +1)

getXFAt

public short getXFAt(int coffset)
returns the xf index for column (coffset = column - field_2_first_col)
Parameters:
the - column (coffset = column - field_2_first_col)
Returns:
the XF index for the column

fillFields

protected void fillFields(byte[] data,
                          short size,
                          int offset)
called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.
Overrides:
fillFields in class Record
Parameters:
data - raw data
size - size of data

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

validateSid

protected void validateSid(short id)
called by constructor, should throw runtime exception in the event of a record passed with a differing ID.
Overrides:
validateSid in class Record
Parameters:
id - alleged id for this 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

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


Copyright © 2002 Apache jakarta-poi project. All Rights Reserved.