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

WindowProtectRecord

public class WindowProtectRecord extends Record
Title: Window Protect Record

Description: flags whether workbook windows are protected

REFERENCE: PG 424 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_protect
Constructors Summary
public WindowProtectRecord()


     
    
    
public WindowProtectRecord(RecordInputStream in)
Constructs a WindowProtect record and sets its fields appropriately.

param
id id must be 0x19 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_protect = in.readShort();
    
public booleangetProtect()
is this window protected or not

return
protected or not

        return (field_1_protect == 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 ) 0x02));   // 2 bytes (6 total)
        LittleEndian.putShort(data, 4 + offset, field_1_protect);
        return getRecordSize();
    
public voidsetProtect(boolean protect)
set whether this window should be protected or not

param
protect or not

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

        StringBuffer buffer = new StringBuffer();

        buffer.append("[WINDOWPROTECT]\n");
        buffer.append("    .protect         = ").append(getProtect())
            .append("\n");
        buffer.append("[/WINDOWPROTECT]\n");
        return buffer.toString();
    
protected voidvalidateSid(short id)

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