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

PrintHeadersRecord

public class PrintHeadersRecord extends Record
Title: Print Headers Record

Description: Whether or not to print the row/column headers when you enjoy your spreadsheet in the physical form.

REFERENCE: PG 373 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_print_headers
Constructors Summary
public PrintHeadersRecord()


     
    
    
public PrintHeadersRecord(RecordInputStream in)
Constructs a PrintHeaders record and sets its fields appropriately.

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

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

        field_1_print_headers = in.readShort();
    
public booleangetPrintHeaders()
get whether to print the headers - y/n

return
printheaders or not

        return (field_1_print_headers == 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, field_1_print_headers);
        return getRecordSize();
    
public voidsetPrintHeaders(boolean p)
set to print the headers - y/n

param
p printheaders or not

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

        StringBuffer buffer = new StringBuffer();

        buffer.append("[PRINTHEADERS]\n");
        buffer.append("    .printheaders   = ").append(getPrintHeaders())
            .append("\n");
        buffer.append("[/PRINTHEADERS]\n");
        return buffer.toString();
    
protected voidvalidateSid(short id)

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