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

HCenterRecord

public class HCenterRecord extends Record
Title: HCenter record

Description: whether to center between horizontal margins

REFERENCE: PG 320 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_hcenter
Constructors Summary
public HCenterRecord()


     
    
    
public HCenterRecord(RecordInputStream in)
Constructs an HCenter record and sets its fields appropriately.

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

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

        field_1_hcenter = in.readShort();
    
public booleangetHCenter()
get whether or not to horizonatally center this sheet.

return
center - t/f

        return (field_1_hcenter == 1);
    
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, ( short ) field_1_hcenter);
        return getRecordSize();
    
public voidsetHCenter(boolean hc)
set whether or not to horizonatally center this sheet.

param
hc center - t/f

        if (hc == true)
        {
            field_1_hcenter = 1;
        }
        else
        {
            field_1_hcenter = 0;
        }
    
public java.lang.StringtoString()

        StringBuffer buffer = new StringBuffer();

        buffer.append("[HCENTER]\n");
        buffer.append("    .hcenter        = ").append(getHCenter())
            .append("\n");
        buffer.append("[/HCENTER]\n");
        return buffer.toString();
    
protected voidvalidateSid(short id)

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