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

ProtectionRev4Record

public class ProtectionRev4Record extends Record
Title: Protection Revision 4 Record

Description: describes whether this is a protected shared/tracked workbook

( HSSF does not support encryption because we don't feel like going to jail )

REFERENCE: PG 373 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 ProtectionRev4Record()


     
    
    
public ProtectionRev4Record(RecordInputStream in)
Constructs a ProtectionRev4 record and sets its fields appropriately.

param
id id must be 0x1af 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()
get whether the this is protected shared/tracked workbook or not

return
whether to protect the workbook 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 the this is protected shared/tracked workbook or not

param
protect whether to protect the workbook or not

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

        StringBuffer buffer = new StringBuffer();

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

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