FileDocCategorySizeDatePackage
DefaultRowHeightRecord.javaAPI DocApache Poi 3.0.14368Mon Jan 01 12:39:40 GMT 2007org.apache.poi.hssf.record

DefaultRowHeightRecord

public class DefaultRowHeightRecord extends Record
Title: Default Row Height Record Description: Row height for rows with undefined or not explicitly defined heights. REFERENCE: PG 301 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

author
Andrew C. Oliver (acoliver at apache dot org)
author
Jason Height (jheight at chariot dot net dot au)
version
2.0-pre

Fields Summary
public static final short
sid
private short
field_1_option_flags
private short
field_2_row_height
Constructors Summary
public DefaultRowHeightRecord()


     
    
    
public DefaultRowHeightRecord(RecordInputStream in)
Constructs a DefaultRowHeight record and sets its fields appropriately.

param
id id must be 0x225 or an exception will be throw upon validation
param
size the size of the data area of the record
param
data data of the record (should not contain sid/len)

        super(in);
    
Methods Summary
public java.lang.Objectclone()

      DefaultRowHeightRecord rec = new DefaultRowHeightRecord();
      rec.field_1_option_flags = field_1_option_flags;
      rec.field_2_row_height = field_2_row_height;
      return rec;
    
protected voidfillFields(org.apache.poi.hssf.record.RecordInputStream in)

        field_1_option_flags = in.readShort();
        field_2_row_height   = in.readShort();
    
public shortgetOptionFlags()
get the (currently unimportant to HSSF) option flags

return
flags - the current bitmask

        return field_1_option_flags;
    
public intgetRecordSize()

        return 8;
    
public shortgetRowHeight()
get the default row height

return
rowheight for undefined rows/rows w/undefined height

        return field_2_row_height;
    
public shortgetSid()

        return sid;
    
public intserialize(int offset, byte[] data)

        LittleEndian.putShort(data, 0 + offset, sid);
        LittleEndian.putShort(data, 2 + offset, ( short ) 0x4);
        LittleEndian.putShort(data, 4 + offset, getOptionFlags());
        LittleEndian.putShort(data, 6 + offset, getRowHeight());
        return getRecordSize();
    
public voidsetOptionFlags(short flags)
set the (currently unimportant to HSSF) option flags

param
flags the bitmask to set

        field_1_option_flags = flags;
    
public voidsetRowHeight(short height)
set the default row height

param
height for undefined rows/rows w/undefined height

        field_2_row_height = height;
    
public java.lang.StringtoString()

        StringBuffer buffer = new StringBuffer();

        buffer.append("[DEFAULTROWHEIGHT]\n");
        buffer.append("    .optionflags    = ")
            .append(Integer.toHexString(getOptionFlags())).append("\n");
        buffer.append("    .rowheight      = ")
            .append(Integer.toHexString(getRowHeight())).append("\n");
        buffer.append("[/DEFAULTROWHEIGHT]\n");
        return buffer.toString();
    
protected voidvalidateSid(short id)

        if (id != sid)
        {
            throw new RecordFormatException("NOT A DefaultRowHeight RECORD");
        }