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

BookBoolRecord

public class BookBoolRecord extends Record
Title: Save External Links record (BookBool)

Description: Contains a flag specifying whether the Gui should save externally linked values from other workbooks.

REFERENCE: PG 289 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

author
Andrew C. Oliver (acoliver at apache dot org)
version
2.0-pre

Fields Summary
public static final short
sid
private short
field_1_save_link_values
Constructors Summary
public BookBoolRecord()


     
    
    
public BookBoolRecord(RecordInputStream in)
Constructs a BookBoolRecord and sets its fields appropriately

param
id id must be 0xDA 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
protected voidfillFields(org.apache.poi.hssf.record.RecordInputStream in)

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

        return 6;
    
public shortgetSaveLinkValues()
get the save ext links flag

return
short 0/1 (off/on)

        return field_1_save_link_values;
    
public shortgetSid()

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

        LittleEndian.putShort(data, 0 + offset, sid);
        LittleEndian.putShort(data, 2 + offset,
                              (( short ) 0x02));   // 2 bytes (6 total)
        LittleEndian.putShort(data, 4 + offset, field_1_save_link_values);
        return getRecordSize();
    
public voidsetSaveLinkValues(short flag)
set the save ext links flag

param
flag flag (0/1 -off/on)

        field_1_save_link_values = flag;
    
public java.lang.StringtoString()

        StringBuffer buffer = new StringBuffer();

        buffer.append("[BOOKBOOL]\n");
        buffer.append("    .savelinkvalues  = ")
            .append(Integer.toHexString(getSaveLinkValues())).append("\n");
        buffer.append("[/BOOKBOOL]\n");
        return buffer.toString();
    
protected voidvalidateSid(short id)

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