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

VCenterRecord

public class VCenterRecord extends Record
Title: VCenter record

Description: tells whether to center the sheet between vertical margins

REFERENCE: PG 420 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_vcenter
Constructors Summary
public VCenterRecord()


     
    
    
public VCenterRecord(RecordInputStream in)
Constructs a VCENTER record and sets its fields appropriately.

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

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

        field_1_vcenter = in.readShort();
    
public intgetRecordSize()

        return 6;
    
public shortgetSid()

        return sid;
    
public booleangetVCenter()
get whether to center vertically or not

return
vcenter or not

        return (field_1_vcenter == 1);
    
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_vcenter);
        return getRecordSize();
    
public voidsetVCenter(boolean hc)
set whether to center vertically or not

param
hc vcenter or not

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

        StringBuffer buffer = new StringBuffer();

        buffer.append("[VCENTER]\n");
        buffer.append("    .vcenter        = ").append(getVCenter())
            .append("\n");
        buffer.append("[/VCENTER]\n");
        return buffer.toString();
    
protected voidvalidateSid(short id)

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