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

DefaultColWidthRecord

public class DefaultColWidthRecord extends Record
Title: Default Column Width Record

Description: Specifies the default width for columns that have no specific width set.

REFERENCE: PG 302 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_col_width
Constructors Summary
public DefaultColWidthRecord()


     
    
    
public DefaultColWidthRecord(RecordInputStream in)
Constructs a DefaultColumnWidth record and sets its fields appropriately.

param
id id must be 0x55 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()

      DefaultColWidthRecord rec = new DefaultColWidthRecord();
      rec.field_1_col_width = field_1_col_width;
      return rec;
    
protected voidfillFields(org.apache.poi.hssf.record.RecordInputStream in)

        field_1_col_width = in.readShort();
    
public shortgetColWidth()
get the default column width

return
defaultwidth for columns

        return field_1_col_width;
    
public intgetRecordSize()

        return 6;
    
public shortgetSid()

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

        LittleEndian.putShort(data, 0 + offset, sid);
        LittleEndian.putShort(data, 2 + offset, ( short ) 0x2);
        LittleEndian.putShort(data, 4 + offset, getColWidth());
        return getRecordSize();
    
public voidsetColWidth(short height)
set the default column width

param
height defaultwidth for columns

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

        StringBuffer buffer = new StringBuffer();

        buffer.append("[DEFAULTCOLWIDTH]\n");
        buffer.append("    .colwidth      = ")
            .append(Integer.toHexString(getColWidth())).append("\n");
        buffer.append("[/DEFAULTCOLWIDTH]\n");
        return buffer.toString();
    
protected voidvalidateSid(short id)

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