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

PrintGridlinesRecord

public class PrintGridlinesRecord extends Record
Title: Print Gridlines Record

Description: whether to print the gridlines when you enjoy you spreadsheet on paper.

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_gridlines
Constructors Summary
public PrintGridlinesRecord()


     
    
    
public PrintGridlinesRecord(RecordInputStream in)
Constructs a PrintGridlines record and sets its fields appropriately.

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

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

        field_1_print_gridlines = in.readShort();
    
public booleangetPrintGridlines()
get whether or not to print the gridlines (and make your spreadsheet ugly)

return
make spreadsheet ugly - Y/N

        return (field_1_print_gridlines == 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_gridlines);
        return getRecordSize();
    
public voidsetPrintGridlines(boolean pg)
set whether or not to print the gridlines (and make your spreadsheet ugly)

param
pg make spreadsheet ugly - Y/N

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

        StringBuffer buffer = new StringBuffer();

        buffer.append("[PRINTGRIDLINES]\n");
        buffer.append("    .printgridlines = ").append(getPrintGridlines())
            .append("\n");
        buffer.append("[/PRINTGRIDLINES]\n");
        return buffer.toString();
    
protected voidvalidateSid(short id)

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